From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/cms/2015-04-20/api-docs.php | 319 - data/en_us/cms/2015-08-01/api-docs.php | 896 - data/en_us/cms/2015-10-20/api-docs.php | 578 +- data/en_us/cms/2016-03-18/api-docs.php | 577 +- data/en_us/cms/2016-09-22/api-docs.php | 1352 +- data/en_us/cms/2017-03-01/api-docs.php | 2069 +- data/en_us/cms/2017-08-24/api-docs.php | 505 - data/en_us/cms/2018-03-08/api-docs.php | 9720 ++---- data/en_us/cms/2019-01-01/api-docs.php | 57434 +++++++++++++------------------ data/en_us/cms/2024-03-30/api-docs.php | 36539 +++++++++----------- 10 files changed, 43062 insertions(+), 66927 deletions(-) delete mode 100644 data/en_us/cms/2015-04-20/api-docs.php delete mode 100644 data/en_us/cms/2015-08-01/api-docs.php delete mode 100644 data/en_us/cms/2017-08-24/api-docs.php (limited to 'data/en_us/cms') diff --git a/data/en_us/cms/2015-04-20/api-docs.php b/data/en_us/cms/2015-04-20/api-docs.php deleted file mode 100644 index 422b552..0000000 --- a/data/en_us/cms/2015-04-20/api-docs.php +++ /dev/null @@ -1,319 +0,0 @@ - '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' => null, - ], - ], - '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/en_us/cms/2015-08-01/api-docs.php b/data/en_us/cms/2015-08-01/api-docs.php deleted file mode 100644 index b877a6a..0000000 --- a/data/en_us/cms/2015-08-01/api-docs.php +++ /dev/null @@ -1,896 +0,0 @@ - '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' => null, - ], - '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' => null, - ], - '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' => null, - ], - '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' => null, - ], - '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' => null, - ], - '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' => null, - ], - ], - '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/en_us/cms/2015-10-20/api-docs.php b/data/en_us/cms/2015-10-20/api-docs.php index 4037ddb..6be1eaa 100644 --- a/data/en_us/cms/2015-10-20/api-docs.php +++ b/data/en_us/cms/2015-10-20/api-docs.php @@ -1,21 +1,12 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Cms', - 'version' => '2015-10-20', - ], + 'info' => ['style' => 'RPC', 'product' => 'Cms', 'version' => '2015-10-20'], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', - 'children' => [ - 'DescribeMetricDatum', - 'PutDimTableData', - 'QueryMetric', - 'QueryMetricList', - ], + 'children' => ['DescribeMetricDatum', 'PutDimTableData', 'QueryMetric', 'QueryMetricList'], ], ], 'components' => [ @@ -24,104 +15,65 @@ 'apis' => [ 'DescribeMetricDatum' => [ 'summary' => 'DescribeMetricDatum', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Extend', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -129,31 +81,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'NextToken' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'TraceId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + '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', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -163,67 +102,40 @@ ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'PutDimTableData' => [ 'summary' => 'PutDimTableData', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'DimTableName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Body', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -231,18 +143,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'TraceId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'TraceId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], ], ], ], @@ -251,105 +155,65 @@ ], 'QueryMetric' => [ 'summary' => 'QueryMetric', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Extend', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -357,34 +221,19 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Success' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'TraceId' => [ - 'type' => 'string', - ], - 'Period' => [ - 'type' => 'string', - ], + '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', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -396,113 +245,70 @@ ], 'QueryMetricList' => [ 'summary' => 'QueryMetricList', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -510,215 +316,73 @@ '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', - ], + '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.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], ], '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', - ], + ['regionId' => 'cn-qingdao', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'metrics.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-hongkong', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'endpoint' => 'metrics.cn-zhongwei.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' => 'metrics.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' => 'ap-southeast-8', 'endpoint' => 'metrics.ap-southeast-8.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' => 'us-southeast-1', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com'], + ['regionId' => 'na-south-1', 'endpoint' => 'metrics.na-south-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'endpoint' => 'metrics.eu-central-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' => 'metrics.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'], + ['regionId' => 'cn-wulanchabu-gic-1', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com'], ], ]; diff --git a/data/en_us/cms/2016-03-18/api-docs.php b/data/en_us/cms/2016-03-18/api-docs.php index 8a089f7..7c71ad2 100644 --- a/data/en_us/cms/2016-03-18/api-docs.php +++ b/data/en_us/cms/2016-03-18/api-docs.php @@ -1,21 +1,12 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Cms', - 'version' => '2016-03-18', - ], + 'info' => ['style' => 'RPC', 'product' => 'Cms', 'version' => '2016-03-18'], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', - 'children' => [ - 'PutDimTableData', - 'QueryEvent', - 'QueryMetricLast', - 'QueryMetricList', - ], + 'children' => ['PutDimTableData', 'QueryEvent', 'QueryMetricLast', 'QueryMetricList'], ], ], 'components' => [ @@ -24,52 +15,30 @@ 'apis' => [ 'PutDimTableData' => [ 'summary' => '上传维表数据', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问', - 'tenantRelevance' => 'publicInformation', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'DimTableName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Body', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -77,143 +46,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryEvent' => [ 'summary' => 'QueryEvent', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'EventName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'OrderDesc', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false], ], ], 'responses' => [ @@ -221,146 +136,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'type' => 'string', - ], - 'NextToken' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Datapoints' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + '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.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryMetricLast' => [ 'summary' => 'QueryMetricLast', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -368,145 +224,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Datapoints' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Period' => [ - 'type' => 'string', - ], + '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.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryMetricList' => [ 'summary' => 'QueryMetricList', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -514,205 +312,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Datapoints' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Period' => [ - 'type' => 'string', - ], + '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.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], ], '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', - ], + ['regionId' => 'cn-qingdao', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'metrics.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-hongkong', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'endpoint' => 'metrics.cn-zhongwei.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' => 'metrics.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' => 'ap-southeast-8', 'endpoint' => 'metrics.ap-southeast-8.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' => 'us-southeast-1', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com'], + ['regionId' => 'na-south-1', 'endpoint' => 'metrics.na-south-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'endpoint' => 'metrics.eu-central-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' => 'metrics.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'], + ['regionId' => 'cn-wulanchabu-gic-1', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com'], ], ]; diff --git a/data/en_us/cms/2016-09-22/api-docs.php b/data/en_us/cms/2016-09-22/api-docs.php index feac9bc..18cbbfd 100644 --- a/data/en_us/cms/2016-09-22/api-docs.php +++ b/data/en_us/cms/2016-09-22/api-docs.php @@ -1,29 +1,12 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Cms', - 'version' => '2016-09-22', - ], + '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', - ], + 'children' => ['GetMetricStatistics', 'GetMetrics', 'ListMetrics', 'NodeAgentVersion', 'NodeInstall', 'NodeStatus', 'PutDimTableData', 'QueryEvent', 'QueryMetric', 'QueryMetricLast', 'QueryMetricList', 'QueryMetricTop'], ], ], 'components' => [ @@ -32,100 +15,60 @@ 'apis' => [ 'GetMetricStatistics' => [ 'summary' => 'getmetricstatistics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], ], 'responses' => [ @@ -133,27 +76,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'NextToken' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'NextToken' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], 'Datapoints' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Datapoint' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -163,66 +96,40 @@ ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'GetMetrics' => [ 'summary' => 'GetMetrics', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'MetricStreamName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -230,125 +137,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Result' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Result' => ['type' => 'string'], + 'Success' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => '404', - 'errorMessage' => '%s', - ], + ['errorCode' => '404', 'errorMessage' => '%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'ListMetrics' => [ 'summary' => 'Query Metrics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the project to which the metric belongs.', - 'type' => 'string', - 'required' => false, - 'example' => 'acs_slb_dashboard', - ], + 'schema' => ['description' => 'The name of the project to which the metric belongs.', 'type' => 'string', 'required' => false, 'example' => 'acs_slb_dashboard'], ], [ 'name' => 'MetricStreamName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the stream to which the metric belongs.', - 'type' => 'string', - 'required' => false, - 'example' => 'def_stream', - ], + 'schema' => ['description' => 'The name of the stream to which the metric belongs.', 'type' => 'string', 'required' => false, 'example' => 'def_stream'], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.', - 'type' => 'string', - 'required' => false, - 'example' => 'InstanceActiveConnection', - ], + 'schema' => ['description' => 'The name of the metric.', 'type' => 'string', 'required' => false, 'example' => 'InstanceActiveConnection'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter. Default value: 1.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Pagination parameter. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page. Default value: 1000.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'Number of records per page. Default value: 1000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], ], ], 'responses' => [ @@ -356,26 +205,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The unique identifier generated by Alibaba Cloud for this request.', - 'type' => 'string', - 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C'], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'string', 'example' => 'true'], 'Datapoints' => [ 'type' => 'object', 'itemNode' => true, @@ -383,39 +216,35 @@ 'Datapoint' => [ 'description' => 'List of data points.', 'type' => 'array', - 'items' => [ - 'description' => 'Definition information of the metric item.', - '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", - ], + 'items' => ['description' => 'Definition information of the metric item.', '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"], ], ], ], @@ -425,16 +254,10 @@ ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['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"}]', @@ -443,46 +266,26 @@ ], 'NodeAgentVersion' => [ 'summary' => 'NodeAgentVersion', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + 'RequestId' => ['type' => 'string'], + 'ErrorMessage' => ['type' => 'string'], + 'TianjimonVersion' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], + 'ErrorCode' => ['type' => 'integer', 'format' => 'int32'], ], ], ], @@ -491,49 +294,30 @@ ], 'NodeInstall' => [ 'summary' => 'nodeinstall', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'true'], ], ], 'responses' => [ @@ -541,87 +325,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'ErrorCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['type' => 'string'], + 'ErrorMessage' => ['type' => 'string'], + 'ErrorCode' => ['type' => 'integer', 'format' => 'int32'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.'], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['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' => '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.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], ], 'responseDemo' => null, ], 'NodeStatus' => [ 'summary' => 'Query the Cloud Monitoring Plugin Operation Status of a Specified Instance', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID', - 'type' => 'string', - 'required' => true, - 'example' => 'i-abcdefgh123456', - ], + 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'i-abcdefgh123456'], ], ], 'responses' => [ @@ -629,50 +375,21 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Plugin operation status', - 'type' => 'string', - 'example' => 'stopped', - ], - 'ErrorMessage' => [ - 'description' => 'Error message', - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '9E14096E-68A1-4908-92D0-E5FC6408623A', - ], - 'AutoInstall' => [ - 'description' => 'Whether to automatically install the cloud monitoring plugin on existing ECS hosts. Values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code, 200 indicates success', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InstanceId' => [ - 'description' => '实例id', - 'type' => 'string', - 'example' => 'i-abcdefgh123456', - ], + 'Status' => ['description' => 'Plugin operation status', 'type' => 'string', 'example' => 'stopped'], + 'ErrorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => 'The specified resource is not found.'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9E14096E-68A1-4908-92D0-E5FC6408623A'], + 'AutoInstall' => ['description' => 'Whether to automatically install the cloud monitoring plugin on existing ECS hosts. Values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code, 200 indicates success', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'InstanceId' => ['description' => '实例id', 'type' => 'string', 'example' => 'i-abcdefgh123456'], ], ], ], @@ -683,52 +400,30 @@ ], 'PutDimTableData' => [ 'summary' => '上传维表数据', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问', - 'tenantRelevance' => 'publicInformation', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'DimTableName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Body', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -736,143 +431,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryEvent' => [ 'summary' => 'QueryEvent', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'EventName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'OrderDesc', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false], ], ], 'responses' => [ @@ -880,25 +521,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'type' => 'string', - ], - 'NextToken' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Datapoints' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Cursor' => ['type' => 'string'], + 'NextToken' => ['type' => 'integer', 'format' => 'int32'], + 'RequestId' => ['type' => 'string'], + 'Datapoints' => ['type' => 'string'], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], ], ], ], @@ -908,104 +536,65 @@ ], 'QueryMetric' => [ 'summary' => 'QueryMetric', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Extend', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -1013,34 +602,19 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Success' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'TraceId' => [ - 'type' => 'string', - ], - 'Period' => [ - 'type' => 'string', - ], + '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', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -1050,157 +624,86 @@ ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryMetricLast' => [ 'summary' => 'QueryMetricLast', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'description' => 'Responsible person.', - 'type' => 'string', - 'required' => false, - 'example' => '97u8ers', - ], + 'schema' => ['description' => 'Responsible person.', 'type' => 'string', 'required' => false, 'example' => '97u8ers'], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'description' => 'The project of the monitoring item, used for querying monitoring data.', - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The project of the monitoring item, used for querying monitoring data.', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring item name.', - 'type' => 'string', - 'required' => true, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'Monitoring item name.', 'type' => 'string', 'required' => true, 'example' => 'CPUUtilization'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Time interval of the monitoring item. Unit: seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'Time interval of the monitoring item. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '60'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start time for querying the monitoring item.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:00:00', - ], + 'schema' => ['description' => 'Start time for querying the monitoring item.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'End time for querying the monitoring item.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:10:00', - ], + 'schema' => ['description' => 'End time for querying the monitoring item.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:10:00'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the monitoring dimensions of the resource.'."\n" - ."\n" - .'Format: A collection in `key:value` pairs, such as: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> A single request supports batch querying up to 50 instances at most.'."\n" - ."\n\n" - ."\n\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"instanceId\\":\\"rm-3ns530d6ptf2w47m1\\"}', - ], + 'schema' => ['description' => 'Specifies the monitoring dimensions of the resource.'."\n" + ."\n" + .'Format: A collection in `key:value` pairs, such as: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A single request supports batch querying up to 50 instances at most.'."\n" + ."\n\n" + ."\n\n", 'type' => 'string', 'required' => false, 'example' => '{\\"instanceId\\":\\"rm-3ns530d6ptf2w47m1\\"}'], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'Next page of data; if empty, it indicates there is no next page.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', - ], + 'schema' => ['description' => 'Next page of data; if empty, it indicates there is no next page.', 'type' => 'string', 'required' => false, 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Pagination parameter.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page, used for pagination. Note: The maximum value of Length in a single request is 1440.', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'Number of records per page, used for pagination. Note: The maximum value of Length in a single request is 1440.', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'Expression for real-time calculation on the existing results, for example: `{"groupby":["instanceId"]}`', - 'type' => 'string', - 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', - ], + 'schema' => ['description' => 'Expression for real-time calculation on the existing results, for example: `{"groupby":["instanceId"]}`', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}'], ], ], 'responses' => [ @@ -1208,36 +711,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'description' => 'Next page of data; if empty, it indicates there is no next page.', - 'type' => 'string', - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', - ], - 'RequestId' => [ - 'description' => 'A unique identifier generated by Alibaba Cloud for this request.', - 'type' => 'string', - 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', - ], - 'Datapoints' => [ - 'description' => 'List of monitoring data, with content format such as: `{"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' => 'Status code, 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'Period' => [ - 'description' => 'Time interval. Unit: seconds.', - 'type' => 'string', - 'example' => '60', - ], + 'Cursor' => ['description' => 'Next page of data; if empty, it indicates there is no next page.', 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********'], + 'RequestId' => ['description' => 'A unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3'], + 'Datapoints' => ['description' => 'List of monitoring data, with content format such as: `{"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' => 'Status code, 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'Success'], + 'Period' => ['description' => 'Time interval. Unit: seconds.', 'type' => 'string', 'example' => '60'], ], ], ], @@ -1248,139 +727,74 @@ ], 'QueryMetricList' => [ 'summary' => 'QueryMetricList', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'description' => 'Person in charge.', - 'type' => 'string', - 'required' => false, - 'example' => '97u8ers', - ], + 'schema' => ['description' => 'Person in charge.', 'type' => 'string', 'required' => false, 'example' => '97u8ers'], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'description' => 'The project of the monitoring item, used for querying monitoring data.', - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The project of the monitoring item, used for querying monitoring data.', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring item name.', - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_idle', - ], + 'schema' => ['description' => 'Monitoring item name.', 'type' => 'string', 'required' => true, 'example' => 'cpu_idle'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Time interval of the monitoring item. Unit: seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'Time interval of the monitoring item. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '60'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start time for querying the monitoring item.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:00:00', - ], + 'schema' => ['description' => 'Start time for querying the monitoring item.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'End time for querying the monitoring item.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:10:00', - ], + 'schema' => ['description' => 'End time for querying the monitoring item.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:10:00'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the monitoring dimensions of the resource.'."\n" - ."\n" - .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> A single request supports batch querying up to 50 instances at most.', - 'type' => 'string', - 'required' => false, - 'example' => '[{instanceId:\'rm-zf86h352r1ljuqp4r\'}]', - ], + 'schema' => ['description' => 'Specifies the monitoring dimensions of the resource.'."\n" + ."\n" + .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A single request supports batch querying up to 50 instances at most.', 'type' => 'string', 'required' => false, 'example' => '[{instanceId:\'rm-zf86h352r1ljuqp4r\'}]'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Pagination parameter.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'Next page of data, an empty value indicates no next page.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', - ], + 'schema' => ['description' => 'Next page of data, an empty value indicates no next page.', 'type' => 'string', 'required' => false, 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'Expression for real-time calculation on the queried existing results, for example: `{"groupby":["instanceId"]}`', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"groupby\\":[\\"instanceId\\"]}', - ], + 'schema' => ['description' => 'Expression for real-time calculation on the queried existing results, for example: `{"groupby":["instanceId"]}`', 'type' => 'string', 'required' => false, 'example' => '{\\"groupby\\":[\\"instanceId\\"]}'], ], ], 'responses' => [ @@ -1388,36 +802,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'description' => 'Next page of data, an empty value indicates no next page.', - 'type' => 'string', - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', - ], - 'RequestId' => [ - 'description' => 'A unique identifier generated by Alibaba Cloud for this request.', - 'type' => 'string', - 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', - ], - 'Datapoints' => [ - 'description' => 'List of monitoring data, with a content format such as: `{"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' => 'Status code. A return value of 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'Period' => [ - 'description' => 'Time interval of the monitoring item. Unit: seconds.', - 'type' => 'string', - 'example' => '60', - ], + 'Cursor' => ['description' => 'Next page of data, an empty value indicates no next page.', 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'], + 'RequestId' => ['description' => 'A unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42'], + 'Datapoints' => ['description' => 'List of monitoring data, with a content format such as: `{"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' => 'Status code. A return value of 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'Success'], + 'Period' => ['description' => 'Time interval of the monitoring item. Unit: seconds.', 'type' => 'string', 'example' => '60'], ], ], ], @@ -1428,113 +818,70 @@ ], 'QueryMetricTop' => [ 'summary' => 'QueryMetricTop', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Orderby', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'OrderDesc', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -1542,21 +889,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Datapoints' => [ - 'type' => 'string', - ], - 'Period' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Datapoints' => ['type' => 'string'], + 'Period' => ['type' => 'string'], ], ], ], @@ -1565,165 +902,48 @@ ], ], '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', - ], + ['regionId' => 'cn-qingdao', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'metrics.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-hongkong', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'endpoint' => 'metrics.cn-zhongwei.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' => 'metrics.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' => 'ap-southeast-8', 'endpoint' => 'metrics.ap-southeast-8.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' => 'us-southeast-1', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com'], + ['regionId' => 'na-south-1', 'endpoint' => 'metrics.na-south-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'endpoint' => 'metrics.eu-central-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' => 'metrics.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'], + ['regionId' => 'cn-wulanchabu-gic-1', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com'], ], ]; diff --git a/data/en_us/cms/2017-03-01/api-docs.php b/data/en_us/cms/2017-03-01/api-docs.php index ba22e23..3d709f0 100644 --- a/data/en_us/cms/2017-03-01/api-docs.php +++ b/data/en_us/cms/2017-03-01/api-docs.php @@ -1,31 +1,12 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Cms', - 'version' => '2017-03-01', - ], + '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', - ], + 'children' => ['CreateAlarm', 'DeleteAlarm', 'DescribeAlarms', 'DisableAlarm', 'EnableAlarm', 'ListAlarm', 'ListAlarmHistory', 'NodeInstall', 'NodeStatus', 'NodeStatusList', 'PutCustomMetric', 'QueryMetricLast', 'QueryMetricList', 'UpdateAlarm'], ], ], 'components' => [ @@ -34,165 +15,95 @@ 'apis' => [ 'CreateAlarm' => [ 'summary' => 'CreateAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '300', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '300'], ], [ 'name' => 'Statistics', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'ComparisonOperator', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'EvaluationCount', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '3', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '3'], ], [ 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '24', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '24'], ], [ 'name' => 'SilenceTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '86400', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '86400'], ], [ 'name' => 'NotifyType', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Webhook', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -200,95 +111,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DeleteAlarm' => [ 'summary' => 'DeleteAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], ], 'responses' => [ @@ -296,188 +165,99 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DescribeAlarms' => [ 'summary' => 'Query Alarm Information', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Group ID', - 'type' => 'string', - 'required' => false, - 'example' => '239758093', - ], + 'schema' => ['description' => 'Group ID', 'type' => 'string', 'required' => false, 'example' => '239758093'], ], [ 'name' => 'GroupBy', 'in' => 'query', - 'schema' => [ - 'description' => 'Group\'s groupby.', - 'type' => 'string', - 'required' => false, - 'example' => 'product', - ], + 'schema' => ['description' => 'Group\'s groupby.', 'type' => 'string', 'required' => false, 'example' => 'product'], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'Metric name', - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'Metric name', 'type' => 'string', 'required' => false, 'example' => 'cpu_total'], ], [ 'name' => 'EnableState', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm enable state. Values:'."\n" - .'- true: Enabled.'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Alarm enable state. Values:'."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace', - 'type' => 'string', - 'required' => false, - 'example' => 'default-aliyun', - ], + 'schema' => ['description' => 'Namespace', 'type' => 'string', 'required' => false, 'example' => 'default-aliyun'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number. Default value: 1.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ 'name' => 'AlertState', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm rule state.', - 'type' => 'string', - 'required' => false, - 'example' => 'OK', - ], + 'schema' => ['description' => 'Alarm rule state.', 'type' => 'string', 'required' => false, 'example' => 'OK'], ], [ 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'description' => 'Display name.', - 'type' => 'string', - 'required' => false, - 'example' => 'TestAlarm1', - ], + 'schema' => ['description' => 'Display name.', 'type' => 'string', 'required' => false, 'example' => 'TestAlarm1'], ], [ 'name' => 'Names', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm name.', - 'type' => 'string', - 'required' => false, - 'example' => 'metricRuleTargets-20180308ofoa', - ], + 'schema' => ['description' => 'Alarm name.', 'type' => 'string', 'required' => false, 'example' => 'metricRuleTargets-20180308ofoa'], ], [ 'name' => 'NameKeyword', 'in' => 'query', - 'schema' => [ - 'description' => 'Keyword.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], + 'schema' => ['description' => 'Keyword.', 'type' => 'string', 'required' => false, 'example' => 'key1'], ], ], 'responses' => [ @@ -485,41 +265,16 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '4D3907D7-F747-582F-9A08-D32362857B5F', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'Status code. Note: 200 indicates success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Message.', - 'type' => 'string', - 'example' => 'success', - ], - 'TraceId' => [ - 'description' => 'Trace ID.', - 'type' => 'string', - 'example' => '403F0D3A-30FB-5BB1-9F58-14704EA23DC0', - ], - 'Total' => [ - 'description' => 'Total number of results.', - 'type' => 'string', - 'example' => '23810', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '4D3907D7-F747-582F-9A08-D32362857B5F'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => 'Status code. Note: 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'Message.', 'type' => 'string', 'example' => 'success'], + 'TraceId' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => '403F0D3A-30FB-5BB1-9F58-14704EA23DC0'], + 'Total' => ['description' => 'Total number of results.', 'type' => 'string', 'example' => '23810'], 'Datapoints' => [ 'type' => 'object', 'itemNode' => true, @@ -531,130 +286,34 @@ 'description' => 'Alarm object', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => 'Display name', - 'type' => 'string', - 'example' => '过去5分钟的系统平均负载', - ], - 'MetricName' => [ - 'description' => 'Metric name.', - 'type' => 'string', - 'example' => 'ResponseTime', - ], - 'EffectiveInterval' => [ - 'description' => 'Effective time range for the alarm.', - 'type' => 'string', - 'example' => '0:00-23:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'Time period when the alarm is not effective.', - 'type' => 'string', - 'example' => '00:00-05:30', - ], - 'ComparisonOperator' => [ - 'description' => 'Comparison operator', - 'type' => 'string', - 'example' => 'LessThanLastWeek', - ], - 'Subject' => [ - 'description' => 'Alarm title', - 'type' => 'string', - 'example' => 'JHighSchool_Geography', - ], - 'Dimensions' => [ - 'description' => 'Dimensions.', - 'type' => 'string', - 'example' => '[{\\"instanceId\\":\\"i-2ze1f2hf4tda59jxrjim\\"}]', - ], - 'Name' => [ - 'description' => 'Alarm name.', - 'type' => 'string', - 'example' => 'yc-api-test-rule-black-0onik7', - ], - 'Resources' => [ - 'description' => 'Resource name', - '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' => 'Alarm threshold.', - 'type' => 'string', - 'example' => '97', - ], - 'SilenceTime' => [ - 'description' => 'Silence time.', - 'type' => 'string', - 'example' => '60', - ], - 'EvaluationCount' => [ - 'description' => 'Number of consecutive detections that must meet the threshold condition before an alarm is triggered.', - 'type' => 'string', - 'example' => '3', - ], - 'Webhook' => [ - 'description' => 'URL address for triggering the alarm callback.', - 'type' => 'string', - 'example' => '{\\"method\\":\\"post\\",\\"url\\":\\"https://dns.console.aliyun.com/gtm/webhook/alarm.json?sign=860765935a01fef8f31ea384c11dabc7&aliUid=35160428\\"}', - ], - 'State' => [ - 'description' => 'Alarm state.', - 'type' => 'string', - 'example' => 'OK', - ], - 'ContactGroups' => [ - 'description' => 'Alarm contact groups.', - 'type' => 'string', - 'example' => '云账号报警联系人', - ], - 'Namespace' => [ - 'description' => 'Namespace.', - 'type' => 'string', - 'example' => 'acs_dts', - ], - 'Period' => [ - 'description' => 'Statistical period.', - 'type' => 'string', - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'Alarm rule name.', - 'type' => 'string', - 'example' => 'DBS_EVENT_RULE', - ], - 'Uuid' => [ - 'description' => 'Alarm UUID.', - 'type' => 'string', - 'example' => 'ddd4c5b6-38db-44fa-8ad0-7ce966efc0ba', - ], - 'GroupId' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'example' => '239954856', - ], - 'GroupName' => [ - 'description' => 'Group name.', - 'type' => 'string', - 'example' => 'monitor_group_2018_templateNameFail', - ], - 'Level' => [ - 'description' => 'Alarm level.', - 'type' => 'string', - 'example' => 'INFO', - ], - 'Enable' => [ - 'description' => 'Alarm enable status. Values:'."\n" - ."\n" - .'- true: Enabled.'."\n" - ."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Statistics' => [ - 'description' => 'Statistical information.', - 'type' => 'string', - 'example' => 'Maximum', - ], + 'DisplayName' => ['description' => 'Display name', 'type' => 'string', 'example' => '过去5分钟的系统平均负载'], + 'MetricName' => ['description' => 'Metric name.', 'type' => 'string', 'example' => 'ResponseTime'], + 'EffectiveInterval' => ['description' => 'Effective time range for the alarm.', 'type' => 'string', 'example' => '0:00-23:59'], + 'NoEffectiveInterval' => ['description' => 'Time period when the alarm is not effective.', 'type' => 'string', 'example' => '00:00-05:30'], + 'ComparisonOperator' => ['description' => 'Comparison operator', 'type' => 'string', 'example' => 'LessThanLastWeek'], + 'Subject' => ['description' => 'Alarm title', 'type' => 'string', 'example' => 'JHighSchool_Geography'], + 'Dimensions' => ['description' => 'Dimensions.', 'type' => 'string', 'example' => '[{\\"instanceId\\":\\"i-2ze1f2hf4tda59jxrjim\\"}]'], + 'Name' => ['description' => 'Alarm name.', 'type' => 'string', 'example' => 'yc-api-test-rule-black-0onik7'], + 'Resources' => ['description' => 'Resource name', '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' => 'Alarm threshold.', 'type' => 'string', 'example' => '97'], + 'SilenceTime' => ['description' => 'Silence time.', 'type' => 'string', 'example' => '60'], + 'EvaluationCount' => ['description' => 'Number of consecutive detections that must meet the threshold condition before an alarm is triggered.', 'type' => 'string', 'example' => '3'], + 'Webhook' => ['description' => 'URL address for triggering the alarm callback.', 'type' => 'string', 'example' => '{\\"method\\":\\"post\\",\\"url\\":\\"https://dns.console.aliyun.com/gtm/webhook/alarm.json?sign=860765935a01fef8f31ea384c11dabc7&aliUid=35160428\\"}'], + 'State' => ['description' => 'Alarm state.', 'type' => 'string', 'example' => 'OK'], + 'ContactGroups' => ['description' => 'Alarm contact groups.', 'type' => 'string', 'example' => '云账号报警联系人'], + 'Namespace' => ['description' => 'Namespace.', 'type' => 'string', 'example' => 'acs_dts'], + 'Period' => ['description' => 'Statistical period.', 'type' => 'string', 'example' => '60'], + 'RuleName' => ['description' => 'Alarm rule name.', 'type' => 'string', 'example' => 'DBS_EVENT_RULE'], + 'Uuid' => ['description' => 'Alarm UUID.', 'type' => 'string', 'example' => 'ddd4c5b6-38db-44fa-8ad0-7ce966efc0ba'], + 'GroupId' => ['description' => 'Group ID.', 'type' => 'string', 'example' => '239954856'], + 'GroupName' => ['description' => 'Group name.', 'type' => 'string', 'example' => 'monitor_group_2018_templateNameFail'], + 'Level' => ['description' => 'Alarm level.', 'type' => 'string', 'example' => 'INFO'], + 'Enable' => ['description' => 'Alarm enable status. Values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true'], + 'Statistics' => ['description' => 'Statistical information.', 'type' => 'string', 'example' => 'Maximum'], ], ], ], @@ -666,22 +325,13 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -690,42 +340,25 @@ ], 'DisableAlarm' => [ 'summary' => 'DisableAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], ], 'responses' => [ @@ -733,92 +366,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'EnableAlarm' => [ 'summary' => 'EnableAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], ], 'responses' => [ @@ -826,173 +419,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'ListAlarm' => [ 'summary' => 'Query specific or all alarm rule settings', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'description' => 'Responsible person.', - 'type' => 'string', - 'required' => false, - 'example' => 'user789', - ], + 'schema' => ['description' => 'Responsible person.', 'type' => 'string', 'required' => false, 'example' => 'user789'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'A052CE0CC481AE6F8EE5BFDE8209E39229091623', - ], + 'schema' => ['description' => 'The ID of the alarm rule.', 'type' => 'string', 'required' => false, 'example' => 'A052CE0CC481AE6F8EE5BFDE8209E39229091623'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => '报警测试', - ], + 'schema' => ['description' => 'The name of the alarm rule.', 'type' => 'string', 'required' => false, 'example' => '报警测试'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => 'Dimension', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"clusterId\\":\\"C-9F308DAF783A80DF\\",\\"userId\\":\\"5654008347177444\\"}', - ], + 'schema' => ['description' => 'Dimension', 'type' => 'string', 'required' => false, 'example' => '{\\"clusterId\\":\\"C-9F308DAF783A80DF\\",\\"userId\\":\\"5654008347177444\\"}'], ], [ 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm status.', - 'type' => 'string', - 'required' => false, - 'example' => 'ok', - ], + 'schema' => ['description' => 'Alarm status.', 'type' => 'string', 'required' => false, 'example' => 'ok'], ], [ 'name' => 'IsEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether it is enabled. Value range:'."\n" - ."\n" - .'- true: Enabled.'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Whether it is enabled. Value range:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number, default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Page number, default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '100'], ], ], 'responses' => [ @@ -1000,38 +510,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'Next page, an empty value indicates no next page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => 'Request ID, a unique identifier for each request.'."\n", - 'type' => 'string', - 'example' => 'DC4B526D-D522-59AA-85E2-B6118D4941DC', - ], - 'Success' => [ - 'description' => 'Whether the request was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'Status code. Note: 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Response message from the request', - 'type' => 'string', - 'example' => 'success', - ], - 'Total' => [ - 'description' => 'Total number of data entries that meet the criteria.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '27', - ], + 'NextToken' => ['description' => 'Next page, an empty value indicates no next page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'RequestId' => ['description' => 'Request ID, a unique identifier for each request.'."\n", 'type' => 'string', 'example' => 'DC4B526D-D522-59AA-85E2-B6118D4941DC'], + 'Success' => ['description' => 'Whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => 'Status code. Note: 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Response message from the request', 'type' => 'string', 'example' => 'success'], + 'Total' => ['description' => 'Total number of data entries that meet the criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '27'], 'AlarmList' => [ 'type' => 'object', 'itemNode' => true, @@ -1043,110 +527,28 @@ 'description' => 'Alarm object', 'type' => 'object', 'properties' => [ - 'SilenceTime' => [ - 'description' => 'Silence time', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'MetricName' => [ - 'description' => 'The name of the monitoring item.', - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EvaluationCount' => [ - 'description' => 'Number of consecutive detections that must meet the threshold condition to trigger an alarm.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Webhook' => [ - 'description' => 'URL address for triggering the alarm callback.', - 'type' => 'string', - 'example' => '{\\"method\\":\\"post\\",\\"url\\":\\"https://alidns-http-proxy.aliyuncs.com/api/gtm/alert/callback?sign=494b2a13b63a77def1b3b56d63b96d0a&aliUid=1763735399554991\\"}', - ], - 'State' => [ - 'description' => 'Alarm status.', - 'type' => 'string', - 'example' => 'ok', - ], - 'ContactGroups' => [ - 'description' => 'Alarm contact groups.', - 'type' => 'string', - 'example' => '云账号报警联系人,阿里_gccs告警', - ], - 'Namespace' => [ - 'description' => 'Namespace', - 'type' => 'string', - 'example' => 'acs_event_sys', - ], - 'Period' => [ - 'description' => 'Statistical period.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'EndTime' => [ - 'description' => 'End time for querying alarms.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2025-07-06T02:00:14Z', - ], - 'ComparisonOperator' => [ - 'description' => 'Comparison operator.', - 'type' => 'string', - 'example' => 'NotEqualToThreshold', - ], - 'StartTime' => [ - 'description' => 'Start time for querying alarms.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2025-05-27T16:00:00Z', - ], - 'NotifyType' => [ - 'description' => 'Notification object type', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GroupId' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'example' => '26519034', - ], - 'Dimensions' => [ - 'description' => 'Dimensions.', - 'type' => 'string', - 'example' => '[{instanceId:\'rm-zf83q02vh8r0bzr9c\'}]', - ], - 'Name' => [ - 'description' => 'Alarm name', - 'type' => 'string', - 'example' => 'emr测试集群CPU/内存报警静默', - ], - 'Threshold' => [ - 'description' => 'Alarm threshold.', - 'type' => 'string', - 'example' => '90', - ], - 'Id' => [ - 'description' => 'The ID of the alarm rule.', - 'type' => 'string', - 'example' => 'beec0d28-c81e-49f8-aa54-4fc1738be521', - ], - 'Enable' => [ - 'description' => 'The enablement status of the alarm. Value range:'."\n" - ."\n" - .'- true: Enabled.'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Statistics' => [ - 'description' => 'Alarm statistics.', - 'type' => 'string', - 'example' => 'Maximum', - ], + 'SilenceTime' => ['description' => 'Silence time', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'MetricName' => ['description' => 'The name of the monitoring item.', 'type' => 'string', 'example' => 'cpu_total'], + 'EvaluationCount' => ['description' => 'Number of consecutive detections that must meet the threshold condition to trigger an alarm.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'Webhook' => ['description' => 'URL address for triggering the alarm callback.', 'type' => 'string', 'example' => '{\\"method\\":\\"post\\",\\"url\\":\\"https://alidns-http-proxy.aliyuncs.com/api/gtm/alert/callback?sign=494b2a13b63a77def1b3b56d63b96d0a&aliUid=1763735399554991\\"}'], + 'State' => ['description' => 'Alarm status.', 'type' => 'string', 'example' => 'ok'], + 'ContactGroups' => ['description' => 'Alarm contact groups.', 'type' => 'string', 'example' => '云账号报警联系人,阿里_gccs告警'], + 'Namespace' => ['description' => 'Namespace', 'type' => 'string', 'example' => 'acs_event_sys'], + 'Period' => ['description' => 'Statistical period.', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'EndTime' => ['description' => 'End time for querying alarms.', 'type' => 'integer', 'format' => 'int32', 'example' => '2025-07-06T02:00:14Z'], + 'ComparisonOperator' => ['description' => 'Comparison operator.', 'type' => 'string', 'example' => 'NotEqualToThreshold'], + 'StartTime' => ['description' => 'Start time for querying alarms.', 'type' => 'integer', 'format' => 'int32', 'example' => '2025-05-27T16:00:00Z'], + 'NotifyType' => ['description' => 'Notification object type', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'GroupId' => ['description' => 'Group ID.', 'type' => 'string', 'example' => '26519034'], + 'Dimensions' => ['description' => 'Dimensions.', 'type' => 'string', 'example' => '[{instanceId:\'rm-zf83q02vh8r0bzr9c\'}]'], + 'Name' => ['description' => 'Alarm name', 'type' => 'string', 'example' => 'emr测试集群CPU/内存报警静默'], + 'Threshold' => ['description' => 'Alarm threshold.', 'type' => 'string', 'example' => '90'], + 'Id' => ['description' => 'The ID of the alarm rule.', 'type' => 'string', 'example' => 'beec0d28-c81e-49f8-aa54-4fc1738be521'], + 'Enable' => ['description' => 'The enablement status of the alarm. Value range:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true'], + 'Statistics' => ['description' => 'Alarm statistics.', 'type' => 'string', 'example' => 'Maximum'], ], ], ], @@ -1158,32 +560,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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"}]', @@ -1192,75 +579,45 @@ ], 'ListAlarmHistory' => [ 'summary' => 'ListAlarmHistory', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -1268,21 +625,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Cursor' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'Cursor' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], 'AlarmHistoryList' => [ 'type' => 'object', 'itemNode' => true, @@ -1292,46 +639,18 @@ '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', - ], + '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'], ], ], ], @@ -1343,82 +662,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'NodeInstall' => [ 'summary' => 'NodeInstall', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'true'], ], ], 'responses' => [ @@ -1426,84 +710,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'ErrorCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['type' => 'string'], + 'ErrorMessage' => ['type' => 'string'], + 'ErrorCode' => ['type' => 'integer', 'format' => 'int32'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'NodeStatus' => [ 'summary' => 'NodeStatus', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], ], 'responses' => [ @@ -1511,93 +758,50 @@ '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', - ], + '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', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'NodeStatusList' => [ 'summary' => 'NodeStatusList', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], ], 'responses' => [ @@ -1605,19 +809,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'ErrorCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['type' => 'string'], + 'ErrorMessage' => ['type' => 'string'], + 'ErrorCode' => ['type' => 'integer', 'format' => 'int32'], + 'Success' => ['type' => 'boolean'], 'NodeStatusList' => [ 'type' => 'object', 'itemNode' => true, @@ -1627,15 +822,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'string', - ], - 'InstanceId' => [ - 'type' => 'string', - ], - 'AutoInstall' => [ - 'type' => 'boolean', - ], + 'Status' => ['type' => 'string'], + 'InstanceId' => ['type' => 'string'], + 'AutoInstall' => ['type' => 'boolean'], ], ], ], @@ -1647,65 +836,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'PutCustomMetric' => [ 'summary' => 'PutCustomMetric', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'MetricList', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -1713,60 +874,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'Data' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryMetricLast' => [ 'summary' => 'Query the latest monitoring data for a specified monitoring object.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1774,126 +909,66 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'description' => 'Responsible person.', - 'type' => 'string', - 'required' => false, - 'example' => 'wn32reo1', - ], + 'schema' => ['description' => 'Responsible person.', 'type' => 'string', 'required' => false, 'example' => 'wn32reo1'], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'description' => 'The project of the monitoring item, used for querying monitoring data.', - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The project of the monitoring item, used for querying monitoring data.', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring item name.', - 'type' => 'string', - 'required' => true, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'Monitoring item name.', 'type' => 'string', 'required' => true, 'example' => 'CPUUtilization'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Time interval. Unit: seconds. Values: 60, 300, 900.', - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'Time interval. Unit: seconds. Values: 60, 300, 900.', 'type' => 'string', 'required' => false, 'example' => '60'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start time for querying the monitoring item.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:00:00', - ], + 'schema' => ['description' => 'Start time for querying the monitoring item.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'End time for querying the monitoring item.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:10:00', - ], + 'schema' => ['description' => 'End time for querying the monitoring item.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:10:00'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring dimensions for the specified resource.'."\n" - ."\n" - .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> A single request supports batch querying of up to 50 instances at most.', - 'type' => 'string', - 'required' => false, - 'example' => '{\'instanceId\': \'rm-bp12cn75qrjgpb9s5\'}', - ], + 'schema' => ['description' => 'Monitoring dimensions for the specified resource.'."\n" + ."\n" + .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A single request supports batch querying of up to 50 instances at most.', 'type' => 'string', 'required' => false, 'example' => '{\'instanceId\': \'rm-bp12cn75qrjgpb9s5\'}'], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'Next page of data; if empty, it indicates there is no next page.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', - ], + 'schema' => ['description' => 'Next page of data; if empty, it indicates there is no next page.', 'type' => 'string', 'required' => false, 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Pagination parameter.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size for returning monitoring data, used for pagination queries.', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'Page size for returning monitoring data, used for pagination queries.', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'Expression for real-time calculation on the retrieved results.', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"groupby\\":[\\"userId\\",\\"instanceId\\"]}', - ], + 'schema' => ['description' => 'Expression for real-time calculation on the retrieved results.', 'type' => 'string', 'required' => false, 'example' => '{\\"groupby\\":[\\"userId\\",\\"instanceId\\"]}'], ], ], 'responses' => [ @@ -1901,73 +976,30 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'description' => 'Next page of data; if empty, it indicates there is no next page.', - 'type' => 'string', - 'example' => 'v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for locating logs and troubleshooting issues.', - 'type' => 'string', - 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', - ], - 'Success' => [ - 'description' => 'Indicates whether this call was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Datapoints' => [ - 'description' => 'List of monitoring data.', - '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' => 'Status code, 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'success', - ], - 'Period' => [ - 'description' => 'Time interval. Unit: seconds.', - 'type' => 'string', - 'example' => '60', - ], + 'Cursor' => ['description' => 'Next page of data; if empty, it indicates there is no next page.', 'type' => 'string', 'example' => 'v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***'], + 'RequestId' => ['description' => 'Request ID, used for locating logs and troubleshooting issues.', 'type' => 'string', 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3'], + 'Success' => ['description' => 'Indicates whether this call was successful.', 'type' => 'boolean', 'example' => 'true'], + 'Datapoints' => ['description' => 'List of monitoring data.', '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' => 'Status code, 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'success'], + 'Period' => ['description' => 'Time interval. Unit: seconds.', 'type' => 'string', 'example' => '60'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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"}]', @@ -1976,139 +1008,74 @@ ], 'QueryMetricList' => [ 'summary' => 'Query the monitoring data of a specified product instance over a period of time.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'description' => 'Responsible person.', - 'type' => 'string', - 'required' => false, - 'example' => 'urs879e', - ], + 'schema' => ['description' => 'Responsible person.', 'type' => 'string', 'required' => false, 'example' => 'urs879e'], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace, indicating the product to which the monitoring data belongs, such as `acs_ecs_dashboard`, `acs_rds_dashboard`, etc.', - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'Namespace, indicating the product to which the monitoring data belongs, such as `acs_ecs_dashboard`, `acs_rds_dashboard`, etc.', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring item name.', - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_idle', - ], + 'schema' => ['description' => 'Monitoring item name.', 'type' => 'string', 'required' => true, 'example' => 'cpu_idle'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Time interval. Unit: seconds. Values: 60, 300, 900.', - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'Time interval. Unit: seconds. Values: 60, 300, 900.', 'type' => 'string', 'required' => false, 'example' => '60'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start time. You can pass in the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time, such as 2015-10-20 00:00:00.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:00:00', - ], + 'schema' => ['description' => 'Start time. You can pass in the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time, such as 2015-10-20 00:00:00.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'End time. You can pass in the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time, such as 2015-10-20 00:00:00.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:10:00', - ], + 'schema' => ['description' => 'End time. You can pass in the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time, such as 2015-10-20 00:00:00.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:10:00'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring dimensions for the specified resource.'."\n" - ."\n" - .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> A single request supports querying up to 50 instances in batch.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId": "i-abcdefgh123456"}]', - ], + 'schema' => ['description' => 'Monitoring dimensions for the specified resource.'."\n" + ."\n" + .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A single request supports querying up to 50 instances in batch.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId": "i-abcdefgh123456"}]'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Pagination parameter.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'Next page of data. An empty value indicates there is no next page.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', - ], + 'schema' => ['description' => 'Next page of data. An empty value indicates there is no next page.', 'type' => 'string', 'required' => false, 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********'], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of each query, used for pagination.', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The size of each query, used for pagination.', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'An expression for real-time calculation on the queried results. Currently, only `groupby` is supported, similar to the `groupby` statement in a database.', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"groupby\\":[\\"instanceId\\"]}', - ], + 'schema' => ['description' => 'An expression for real-time calculation on the queried results. Currently, only `groupby` is supported, similar to the `groupby` statement in a database.', 'type' => 'string', 'required' => false, 'example' => '{\\"groupby\\":[\\"instanceId\\"]}'], ], ], 'responses' => [ @@ -2116,73 +1083,30 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'description' => 'Next page of data. An empty value indicates there is no next page.', - 'type' => 'string', - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for locating logs and troubleshooting issues.', - 'type' => 'string', - 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', - ], - 'Success' => [ - 'description' => 'Whether the request was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Datapoints' => [ - 'description' => 'List of monitoring data.', - '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' => 'Status code, normally `200`.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'Period' => [ - 'description' => 'Time interval. Unit: seconds.', - 'type' => 'string', - 'example' => '60', - ], + 'Cursor' => ['description' => 'Next page of data. An empty value indicates there is no next page.', 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'], + 'RequestId' => ['description' => 'Request ID, used for locating logs and troubleshooting issues.', 'type' => 'string', 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42'], + 'Success' => ['description' => 'Whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'Datapoints' => ['description' => 'List of monitoring data.', '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' => 'Status code, normally `200`.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'Success'], + 'Period' => ['description' => 'Time interval. Unit: seconds.', 'type' => 'string', 'example' => '60'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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"}]', @@ -2191,144 +1115,85 @@ ], 'UpdateAlarm' => [ 'summary' => 'UpdateAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'callby_cms_owner', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Statistics', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ComparisonOperator', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'SilenceTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'EvaluationCount', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'NotifyType', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Webhook', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -2336,215 +1201,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], ], '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', - ], + ['regionId' => 'cn-qingdao', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'metrics.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-hongkong', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'endpoint' => 'metrics.cn-zhongwei.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' => 'metrics.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' => 'ap-southeast-8', 'endpoint' => 'metrics.ap-southeast-8.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' => 'us-southeast-1', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com'], + ['regionId' => 'na-south-1', 'endpoint' => 'metrics.na-south-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'endpoint' => 'metrics.eu-central-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' => 'metrics.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'], + ['regionId' => 'cn-wulanchabu-gic-1', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com'], ], ]; diff --git a/data/en_us/cms/2017-08-24/api-docs.php b/data/en_us/cms/2017-08-24/api-docs.php deleted file mode 100644 index 066376e..0000000 --- a/data/en_us/cms/2017-08-24/api-docs.php +++ /dev/null @@ -1,505 +0,0 @@ - '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' => null, - ], - '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' => null, - ], - ], - '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/en_us/cms/2018-03-08/api-docs.php b/data/en_us/cms/2018-03-08/api-docs.php index 2ca2f26..7993a2f 100644 --- a/data/en_us/cms/2018-03-08/api-docs.php +++ b/data/en_us/cms/2018-03-08/api-docs.php @@ -1,89 +1,22 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Cms', - 'version' => '2018-03-08', - ], + 'info' => ['style' => 'RPC', 'product' => 'Cms', 'version' => '2018-03-08'], 'directories' => [ [ 'id' => 59537, 'title' => null, 'type' => 'directory', - 'children' => [ - 'QueryMetricLast', - 'QueryMetricMeta', - 'QueryMetricList', - ], + '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', + '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', ], ], ], @@ -93,133 +26,71 @@ 'apis' => [ 'QueryMetricLast' => [ 'summary' => 'Query the latest monitoring data for a specified monitoring item', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace, indicating the product to which the monitoring data belongs, such as `acs_ecs_dashboard`, `acs_rds_dashboard`, etc.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'Namespace, indicating the product to which the monitoring data belongs, such as `acs_ecs_dashboard`, `acs_rds_dashboard`, etc.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring item name.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'Monitoring item name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CPUUtilization'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Time interval. Unit: seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'Time interval. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '60'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start time, which can be the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time string, such as 2015-10-20 00:00:00.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:00:00', - ], + 'schema' => ['description' => 'Start time, which can be the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time string, such as 2015-10-20 00:00:00.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'End time. Can be the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time string, such as 2015-10-20 00:00:00.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:10:00', - ], + 'schema' => ['description' => 'End time. Can be the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time string, such as 2015-10-20 00:00:00.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:10:00'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring dimensions for the specified resource.'."\n" - ."\n" - .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> A single request supports querying up to 50 instances in batch.'."\n" - ."\n\n" - ."\n\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId":"XXX"}]', - ], + 'schema' => ['description' => 'Monitoring dimensions for the specified resource.'."\n" + ."\n" + .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A single request supports querying up to 50 instances in batch.'."\n" + ."\n\n" + ."\n\n", 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"XXX"}]'], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'Next page of data; if empty, it indicates there is no next page.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', - ], + 'schema' => ['description' => 'Next page of data; if empty, it indicates there is no next page.', 'type' => 'string', 'required' => false, 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Pagination parameter.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of each query, used for pagination.', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The size of each query, used for pagination.', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'An expression for real-time calculation on the existing results, for example: `{"groupby":["instanceId"]}`.', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"groupby\\":[\\"userId\\",\\"instanceId\\"]}', - ], + 'schema' => ['description' => 'An expression for real-time calculation on the existing results, for example: `{"groupby":["instanceId"]}`.', 'type' => 'string', 'required' => false, 'example' => '{\\"groupby\\":[\\"userId\\",\\"instanceId\\"]}'], ], ], 'responses' => [ @@ -227,69 +98,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'description' => 'Next page of data; if empty, it indicates there is no next page.', - 'type' => 'string', - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', - ], - 'RequestId' => [ - 'description' => 'The ID of the request, used for locating logs and troubleshooting issues.', - 'type' => 'string', - 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', - ], - 'Success' => [ - 'description' => 'Indicates whether this call was successful.', - 'type' => 'string', - 'example' => 'true', - ], - 'Datapoints' => [ - 'description' => 'List of monitoring data.', - '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' => 'Status code, where 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'Period' => [ - 'description' => 'Time interval. Unit: seconds.', - 'type' => 'string', - 'example' => '60', - ], + 'Cursor' => ['description' => 'Next page of data; if empty, it indicates there is no next page.', 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********'], + 'RequestId' => ['description' => 'The ID of the request, used for locating logs and troubleshooting issues.', 'type' => 'string', 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3'], + 'Success' => ['description' => 'Indicates whether this call was successful.', 'type' => 'string', 'example' => 'true'], + 'Datapoints' => ['description' => 'List of monitoring data.', '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' => 'Status code, where 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'Success'], + 'Period' => ['description' => 'Time interval. Unit: seconds.', 'type' => 'string', 'example' => '60'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -298,85 +129,48 @@ ], 'QueryMetricMeta' => [ 'summary' => 'Queries the descriptions of time-series monitoring items that are open to cloud monitoring.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'description' => 'The Project to which the metric belongs, matched by equality.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The Project to which the metric belongs, matched by equality.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => 'Filter by labels, format `[{"name":"label name","value":"label value"},{"name":"label name","value":"label value"}]`.'."\n" - .'Existing label name explanations: '."\n" - ."\n" - .'- MetricCategory: Description of the metric category '."\n" - .'- alertEnable: Whether an alert is needed '."\n" - .'- alertUnit: Suggested alert unit '."\n" - .'- unitFactor: Unit conversion factor '."\n" - .'- minAlertPeriod: Minimum alert period '."\n" - .'- productCategory: Product type category ', - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"name\\":\\"alertUnit\\",\\"value\\":\\"%\\"}]', - ], + 'schema' => ['description' => 'Filter by labels, format `[{"name":"label name","value":"label value"},{"name":"label name","value":"label value"}]`.'."\n" + .'Existing label name explanations: '."\n" + ."\n" + .'- MetricCategory: Description of the metric category '."\n" + .'- alertEnable: Whether an alert is needed '."\n" + .'- alertUnit: Suggested alert unit '."\n" + .'- unitFactor: Unit conversion factor '."\n" + .'- minAlertPeriod: Minimum alert period '."\n" + .'- productCategory: Product type category ', 'type' => 'string', 'required' => false, 'example' => '[{\\"name\\":\\"alertUnit\\",\\"value\\":\\"%\\"}]'], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name, matched by equality.', - 'type' => 'string', - 'required' => false, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'The metric name, matched by equality.', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter, default is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Pagination parameter, default is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Maximum number of items per page, default is 30.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'Maximum number of items per page, default is 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], ], 'responses' => [ @@ -384,26 +178,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message code.', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'Used for tracking.', - 'type' => 'string', - 'example' => '0CCE0AF0-053C-4B13-A583-DC9A85785D49', - ], - 'Success' => [ - 'description' => 'Indicates whether this call was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Status code, 200 indicates success, non-200 indicates failure.', - 'type' => 'string', - 'example' => '200', - ], + 'ErrorMessage' => ['description' => 'Error message code.', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => 'Used for tracking.', 'type' => 'string', 'example' => '0CCE0AF0-053C-4B13-A583-DC9A85785D49'], + 'Success' => ['description' => 'Indicates whether this call was successful.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Status code, 200 indicates success, non-200 indicates failure.', 'type' => 'string', 'example' => '200'], 'Resources' => [ 'type' => 'object', 'itemNode' => true, @@ -414,54 +192,22 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'Description of the monitoring item.', - 'type' => 'string', - 'example' => 'ECS.CPUUtilization', - ], - 'Labels' => [ - 'description' => 'Labels of the monitoring item, a JSON string `[{"name":"label name","value":"label value"}]`, can be multiple, names can repeat.'."\n" - .'Existing label name explanations: '."\n" - ."\n" - .'- metricCategory: Metric category '."\n" - .'- alertEnable: Whether it can alert '."\n" - .'- alertUnit: Alert unit '."\n" - .'- unitFactor: Unit conversion factor '."\n" - .'- minAlertPeriod: Minimum alert period '."\n" - .'- productCategory: Product ', - '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' => 'Unit of the monitoring item.', - 'type' => 'string', - 'example' => '%', - ], - 'Dimensions' => [ - 'description' => 'Dimensions of the monitoring item, separated by commas for multiple levels, e.g., userId,instanceId', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'Metric' => [ - 'description' => 'Name of the monitoring item.', - 'type' => 'string', - 'example' => 'CPUUtilization', - ], - 'Project' => [ - 'description' => 'Project name of the monitoring item, used for querying monitoring data.', - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'Periods' => [ - 'description' => 'All statistical periods of the monitoring item, separated by commas, e.g., 15,60,900', - 'type' => 'string', - 'example' => '60,300', - ], - 'Statistics' => [ - 'description' => 'Statistical methods, separated by commas, e.g., Maximum,Minimum,Average', - 'type' => 'string', - 'example' => 'Average,Minimum,Maximum', - ], + 'Description' => ['description' => 'Description of the monitoring item.', 'type' => 'string', 'example' => 'ECS.CPUUtilization'], + 'Labels' => ['description' => 'Labels of the monitoring item, a JSON string `[{"name":"label name","value":"label value"}]`, can be multiple, names can repeat.'."\n" + .'Existing label name explanations: '."\n" + ."\n" + .'- metricCategory: Metric category '."\n" + .'- alertEnable: Whether it can alert '."\n" + .'- alertUnit: Alert unit '."\n" + .'- unitFactor: Unit conversion factor '."\n" + .'- minAlertPeriod: Minimum alert period '."\n" + .'- productCategory: Product ', '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' => 'Unit of the monitoring item.', 'type' => 'string', 'example' => '%'], + 'Dimensions' => ['description' => 'Dimensions of the monitoring item, separated by commas for multiple levels, e.g., userId,instanceId', 'type' => 'string', 'example' => 'instanceId'], + 'Metric' => ['description' => 'Name of the monitoring item.', 'type' => 'string', 'example' => 'CPUUtilization'], + 'Project' => ['description' => 'Project name of the monitoring item, used for querying monitoring data.', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], + 'Periods' => ['description' => 'All statistical periods of the monitoring item, separated by commas, e.g., 15,60,900', 'type' => 'string', 'example' => '60,300'], + 'Statistics' => ['description' => 'Statistical methods, separated by commas, e.g., Maximum,Minimum,Average', 'type' => 'string', 'example' => 'Average,Minimum,Maximum'], ], ], ], @@ -473,28 +219,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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":"\\r\\n\\r\\n\\t60498C25-B5AE-48CD-B03D-207011F21E8A\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tAverage\\r\\n\\t\\t\\t[{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"role"},{"name":"is_alarm","value":"true"}]\\r\\n\\t\\t\\tActiveApplications\\r\\n\\t\\t\\tclusterId,role\\r\\n\\t\\t\\tacs_hbase\\r\\n\\t\\t\\t30,300\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tAverage\\r\\n\\t\\t\\t[{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"role"},{"name":"is_alarm","value":"true"}]\\r\\n\\t\\t\\tActiveApplications\\r\\n\\t\\t\\tclusterId,role\\r\\n\\t\\t\\tacs_emr\\r\\n\\t\\t\\t30,300,3600\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t端口当前活跃连接数\\r\\n\\t\\t\\tAverage,Minimum,Maximum\\r\\n\\t\\t\\t[{"name":"alertUnit","value":"Count"},{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"port"},{"name":"is_alarm","value":"true"}]\\r\\n\\t\\t\\tActiveConnection\\r\\n\\t\\t\\tinstanceId,port,protocol\\r\\n\\t\\t\\tacs_slb_dashboard\\r\\n\\t\\t\\t60,300\\r\\n\\t\\t\\tCount\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t高防IP活跃并发连接\\r\\n\\t\\t\\tMaximum\\r\\n\\t\\t\\t[{"name":"alertUnit","value":"count"},{"name":"minAlertPeriod","value":"60"}]\\r\\n\\t\\t\\tActiveConnection\\r\\n\\t\\t\\tinstanceId,ip\\r\\n\\t\\t\\tacs_ddos\\r\\n\\t\\t\\t30,60,300\\r\\n\\t\\t\\tcount\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t活跃消息数\\r\\n\\t\\t\\tAverage,Minimum,Maximum\\r\\n\\t\\t\\t[{"name":"alertUnit","value":"Count"},{"name":"minAlertPeriod","value":"300"},{"name":"metricCategory","value":"queue"},{"name":"is_alarm","value":"true"}]\\r\\n\\t\\t\\tActiveMessages\\r\\n\\t\\t\\tregion,queue\\r\\n\\t\\t\\tacs_mns_new\\r\\n\\t\\t\\t300\\r\\n\\t\\t\\tCount\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\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}"}]', @@ -507,119 +241,62 @@ ], 'QueryMetricList' => [ 'summary' => 'Query the monitoring data of a specified product instance over a period of time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'description' => 'The project of the monitoring item, used for querying monitoring data.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The project of the monitoring item, used for querying monitoring data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the monitoring item.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_idle', - ], + 'schema' => ['description' => 'The name of the monitoring item.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_idle'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Time interval. Unit: seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'Time interval. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '60'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start time, which can be the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time string, such as 2015-10-20 00:00:00.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:00:00', - ], + 'schema' => ['description' => 'Start time, which can be the number of milliseconds since 00:00:00 on January 1, 1970, or a formatted date and time string, such as 2015-10-20 00:00:00.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'End time. Supported formats: Unix timestamp (the number of milliseconds since 00:00:00 on January 1, 1970) and Format (YYYY-MM-DDThh:mm:ssZ). Note: The interval between StartTime and EndTime should be less than or equal to 31 days.', - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:10:00', - ], + 'schema' => ['description' => 'End time. Supported formats: Unix timestamp (the number of milliseconds since 00:00:00 on January 1, 1970) and Format (YYYY-MM-DDThh:mm:ssZ). Note: The interval between StartTime and EndTime should be less than or equal to 31 days.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:10:00'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring dimensions of the specified resource.'."\n" - ."\n" - .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId": "i-abcdefgh123456"}]', - ], + 'schema' => ['description' => 'Monitoring dimensions of the specified resource.'."\n" + ."\n" + .'Format: A collection of `key:value` pairs, for example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId": "i-abcdefgh123456"}]'], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'Next page of data, an empty value indicates no more pages.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', - ], + 'schema' => ['description' => 'Next page of data, an empty value indicates no more pages.', 'type' => 'string', 'required' => false, 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of each query, used for pagination.', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The size of each query, used for pagination.', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'An expression for real-time calculation on the existing query results. Currently, only groupby is supported, similar to the groupby statement in a database.', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"groupby\\":[\\"instanceId\\"]}', - ], + 'schema' => ['description' => 'An expression for real-time calculation on the existing query results. Currently, only groupby is supported, similar to the groupby statement in a database.', 'type' => 'string', 'required' => false, 'example' => '{\\"groupby\\":[\\"instanceId\\"]}'], ], ], 'responses' => [ @@ -627,69 +304,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Cursor' => [ - 'description' => 'Next page of data, an empty value indicates no more pages.', - 'type' => 'string', - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request, used for locating logs and troubleshooting.', - 'type' => 'string', - 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', - ], - 'Success' => [ - 'description' => 'Indicates whether this call was successful.', - 'type' => 'string', - 'example' => 'true', - ], - 'Datapoints' => [ - 'description' => 'List of monitoring data.', - 'type' => 'string', - 'example' => '[{"timestamp":1548777660000,"userId":"123","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]', - ], - 'Code' => [ - 'description' => 'Status code, normally "200".', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'Period' => [ - 'description' => 'Time interval. Unit: seconds.', - 'type' => 'string', - 'example' => '60', - ], + 'Cursor' => ['description' => 'Next page of data, an empty value indicates no more pages.', 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'], + 'RequestId' => ['description' => 'The ID of the request, used for locating logs and troubleshooting.', 'type' => 'string', 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42'], + 'Success' => ['description' => 'Indicates whether this call was successful.', 'type' => 'string', 'example' => 'true'], + 'Datapoints' => ['description' => 'List of monitoring data.', 'type' => 'string', 'example' => '[{"timestamp":1548777660000,"userId":"123","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]'], + 'Code' => ['description' => 'Status code, normally "200".', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'Success'], + 'Period' => ['description' => 'Time interval. Unit: seconds.', 'type' => 'string', 'example' => '60'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -698,34 +335,20 @@ ], 'AccessKeyGet' => [ 'summary' => 'AccessKeyGet', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false], ], ], 'responses' => [ @@ -733,104 +356,54 @@ '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', - ], + '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.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'AddMyGroupInstances' => [ 'summary' => 'Add Resource Instances in Personal Group', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'ID of the personal application group.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '93958859', - ], + 'schema' => ['description' => 'ID of the personal application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '93958859'], ], [ 'name' => 'Instances', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance information of the application group.', - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"instanceId\\":\\"f1c10843-a18f-11eb-b20e-f23797f49c09\\",\\"instanceName\\":\\"lvaccess-dahua-l2en6bwv1h9kx4r9-64fcd8cb6b-l975v\\",\\"category\\":\\"K8S_POD\\",\\"regionId\\":\\"cn-hangzhou\\"}]', - ], + 'schema' => ['description' => 'Instance information of the application group.', 'type' => 'string', 'required' => false, 'example' => '[{\\"instanceId\\":\\"f1c10843-a18f-11eb-b20e-f23797f49c09\\",\\"instanceName\\":\\"lvaccess-dahua-l2en6bwv1h9kx4r9-64fcd8cb6b-l975v\\",\\"category\\":\\"K8S_POD\\",\\"regionId\\":\\"cn-hangzhou\\"}]'], ], ], 'responses' => [ @@ -838,71 +411,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '8C397B67-530C-5074-8E5D-0076C6E3AA78', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code for failed requests, 200 indicates success, and any other value indicates failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '8C397B67-530C-5074-8E5D-0076C6E3AA78'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code for failed requests, 200 indicates success, and any other value indicates failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => '%s'], + ['errorCode' => 'ResourceExist', 'errorMessage' => '%s'], ], 412 => [ - [ - 'errorCode' => 'ResourcesOverLimit', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => '%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['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"}]', @@ -911,204 +446,95 @@ ], 'CreateAlarm' => [ 'summary' => 'CreateAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abc', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CPUUtilization'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"instanceId":"i-2zecrzcri3d6fhd2ff7j "}]', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"instanceId":"i-2zecrzcri3d6fhd2ff7j "}]'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - 'default' => '300', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'default' => '300'], ], [ 'name' => 'Statistics', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Average', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Average'], ], [ 'name' => 'ComparisonOperator', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '>', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '>'], ], [ 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '90', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '90'], ], [ 'name' => 'EvaluationCount', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'default' => '3', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'default' => '3'], ], [ 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '24', - 'default' => '24', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24', 'default' => '24'], ], [ 'name' => 'SilenceTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - 'default' => '86400', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'default' => '86400'], ], [ 'name' => 'NotifyType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Webhook', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.net.cn/example_callback.htm', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'http://www.net.cn/example_callback.htm'], ], [ 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -1116,63 +542,28 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0c4af0f1-a864-468b-bed3-15c7deff75ee', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '910ABE4E-DC9D-4231-9DC0-C96835553327', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'Data' => ['description' => '', 'type' => 'string', 'example' => '0c4af0f1-a864-468b-bed3-15c7deff75ee'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '910ABE4E-DC9D-4231-9DC0-C96835553327'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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":"\\n 576fbae7-2fd1-411a-ae13-6f09f4fafdde\\n 58C699ED-84BE-44D5-B55F-84AFE73932AB\\n true\\n 200\\n","errorExample":"\\n 576fbae7-2fd1-411a-ae13-6f09f4fafdde\\n 58C699ED-84BE-44D5-B55F-84AFE73932AB\\n true\\n 200\\n"}]', @@ -1180,95 +571,50 @@ ], 'CreateMonitoringTemplate' => [ 'summary' => 'Create a monitoring template', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring template name.', - 'type' => 'string', - 'required' => true, - 'example' => 'Monitor_Template', - ], + 'schema' => ['description' => 'Monitoring template name.', 'type' => 'string', 'required' => true, 'example' => 'Monitor_Template'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Template namespace, with the same semantics as the namespace exposed by metric master.', - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard'."\n", - ], + 'schema' => ['description' => 'Template namespace, with the same semantics as the namespace exposed by metric master.', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard'."\n"], ], [ 'name' => 'AlertTemplatesJson', 'in' => 'query', - 'schema' => [ - 'description' => 'Alert template.', - '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}}}]}', - ], + 'schema' => ['description' => 'Alert template.', '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' => 'Description of the monitoring template.', - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'schema' => ['description' => 'Description of the monitoring template.', 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ 'name' => 'SystemEventTemplates', 'in' => 'query', - 'schema' => [ - 'description' => 'System event template.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]', - ], + 'schema' => ['description' => 'System event template.', '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' => 'Process monitoring template.', - '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"}]', - ], + 'schema' => ['description' => 'Process monitoring template.', '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' => 'Availability monitoring template.', - '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"}]', - ], + 'schema' => ['description' => 'Availability monitoring template.', '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' => [ @@ -1276,75 +622,35 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'InstanceIds is mandatory for this action.', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '78B915FD-01CA-5E38-8C4F-D3DC82598CE0', - ], - 'ErrorCode' => [ - 'description' => 'Error code, 200 indicates success, others indicate failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'Monitoring template ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2224623', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '78B915FD-01CA-5E38-8C4F-D3DC82598CE0'], + 'ErrorCode' => ['description' => 'Error code, 200 indicates success, others indicate failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'Id' => ['description' => 'Monitoring template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2224623'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.'], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['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"}]', @@ -1353,88 +659,47 @@ ], 'CreateMyGroups' => [ 'summary' => 'Create Personal Application Group', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group type. Values:'."\n" - .'- custom: Self-built application group.'."\n" - .'- ehpc_cluster: Application group synchronized from EHPC cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - ], + 'schema' => ['description' => 'Application group type. Values:'."\n" + .'- custom: Self-built application group.'."\n" + .'- ehpc_cluster: Application group synchronized from EHPC cluster.', 'type' => 'string', 'required' => false, 'example' => 'custom'], ], [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group name.', - 'type' => 'string', - 'required' => false, - 'example' => 'monitor_group_2018_metric_ruleioaw', - ], + 'schema' => ['description' => 'Application group name.', '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****', - ], + 'schema' => ['description' => 'ServiceId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '49****'], ], [ 'name' => 'BindUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'Callback URL.', - 'type' => 'string', - 'required' => false, - 'example' => 'https://aliyun.com', - ], + 'schema' => ['description' => 'Callback URL.', 'type' => 'string', 'required' => false, 'example' => 'https://aliyun.com'], ], [ 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm contact group.', - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], + 'schema' => ['description' => 'Alarm contact group.', 'type' => 'string', 'required' => false, 'example' => '[]'], ], [ 'name' => 'Options', 'in' => 'query', - 'schema' => [ - 'description' => 'Advanced settings.', - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], + 'schema' => ['description' => 'Advanced settings.', 'type' => 'string', 'required' => false, 'example' => '[]'], ], ], 'responses' => [ @@ -1442,81 +707,38 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '3A57FF18-32F1-5A95-97E0-8CD905DF417A', - ], - 'GroupId' => [ - 'description' => 'Application group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '239811740', - ], - 'ErrorCode' => [ - 'description' => 'Error code, 200 for success, others for failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The specified resource is not found.'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3A57FF18-32F1-5A95-97E0-8CD905DF417A'], + 'GroupId' => ['description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '239811740'], + 'ErrorCode' => ['description' => 'Error code, 200 for success, others for failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.'], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.'], ], 412 => [ - [ - 'errorCode' => 'ResourcesOverLimit', - 'errorMessage' => 'Resources over limit.', - ], + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => 'Resources over limit.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -1525,125 +747,72 @@ ], 'CreateTask' => [ 'summary' => 'CreateTask', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http://www.aliyun.com', - ], + 'schema' => ['description' => '', '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', - ], + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyunTest', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'aliyunTest'], ], [ 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'IspCity', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], + 'schema' => ['description' => '', '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"}', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'AlertIds', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'caller', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'IntervalUnit', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -1651,32 +820,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - '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', - ], + 'Data' => ['type' => 'string'], + 'RequestId' => ['description' => '', '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, @@ -1686,12 +835,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'type' => 'string', - ], - 'TaskName' => [ - 'type' => 'string', - ], + 'TaskId' => ['type' => 'string'], + 'TaskName' => ['type' => 'string'], ], ], ], @@ -1703,117 +848,61 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'], ], 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], 600 => [ - [ - 'errorCode' => 'IllegalAddress', - 'errorMessage' => 'Illegal HTTP address', - ], + ['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address'], ], 605 => [ - [ - 'errorCode' => 'OperationError', - 'errorMessage' => 'Operation failed', - ], + ['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed'], ], 615 => [ - [ - 'errorCode' => 'TaskNotExists', - 'errorMessage' => 'Task does not exist', - ], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist'], ], 650 => [ - [ - 'errorCode' => 'OperatorInvalid', - 'errorMessage' => 'Operator invalid', - ], - [ - 'errorCode' => 'OperatorCityInvalid', - 'errorMessage' => 'Operator City invalid', - ], + ['errorCode' => 'OperatorInvalid', 'errorMessage' => 'Operator invalid'], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid'], ], 655 => [ - [ - 'errorCode' => 'OperatorCityInvalid', - 'errorMessage' => 'Operator City invalid', - ], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid'], ], 660 => [ - [ - 'errorCode' => 'NameRepeat', - 'errorMessage' => 'Task name repeat', - ], + ['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat'], ], 680 => [ - [ - 'errorCode' => 'CreateAlarmError', - 'errorMessage' => 'Create alarm error', - ], + ['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error'], ], 695 => [ - [ - 'errorCode' => 'NameNotExists', - 'errorMessage' => 'Task name not exists', - ], + ['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":""}]', ], 'DeleteAlarm' => [ 'summary' => 'DeleteAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde'], ], ], 'responses' => [ @@ -1821,58 +910,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A9371CD8-369D-49FA-BED9-35050A0DC6A2', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'A9371CD8-369D-49FA-BED9-35050A0DC6A2'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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":"\\n A9371CD8-369D-49FA-BED9-35050A0DC6A2\\n true\\n 200\\n","errorExample":"{\\n \\"RequestId\\": \\" A9371CD8-369D-49FA-BED9-35050A0DC6A2\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"}]', @@ -1880,58 +938,35 @@ ], 'DeleteCustomMetric' => [ 'summary' => 'DeleteCustomMetric', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Md5', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'UUID', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -1939,87 +974,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Result' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Result' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DeleteMetricRuleTargets' => [ 'summary' => 'DeleteMetricRuleTargets', - 'methods' => [ - 'post', - 'get', - 'delete', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'delete', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'TargetIds', @@ -2027,9 +1022,7 @@ 'style' => 'repeatList', 'schema' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'maxItems' => 5, ], @@ -2040,18 +1033,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], 'FailIds' => [ 'type' => 'object', 'properties' => [ @@ -2061,9 +1046,7 @@ 'properties' => [ 'TargetId' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -2075,42 +1058,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed because of an unknown error, exception or failure.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed because of an unknown error, exception or failure.'], ], ], 'responseDemo' => null, ], 'DeleteMetricRules' => [ 'summary' => 'DeleteMetricRules', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Id', @@ -2118,9 +1084,7 @@ 'style' => 'repeatList', 'schema' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'maxItems' => 100, ], @@ -2131,135 +1095,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.'], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.'], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DeleteMyGroupInstances' => [ 'summary' => 'deleteMyGroupInstances', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Personal group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '239847992', - ], + 'schema' => ['description' => 'Personal group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '239847992'], ], [ 'name' => 'InstanceIdList', 'in' => 'query', - 'schema' => [ - 'description' => 'List of instance IDs to be deleted.', - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], + 'schema' => ['description' => 'List of instance IDs to be deleted.', 'type' => 'string', 'required' => false, 'example' => '[]'], ], [ 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID to be deleted.', - 'type' => 'string', - 'required' => false, - 'example' => 'i-m5e0k0bexac8tykr****', - ], + 'schema' => ['description' => 'Instance ID to be deleted.', 'type' => 'string', 'required' => false, 'example' => 'i-m5e0k0bexac8tykr****'], ], [ 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'Category.', - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'Category.', 'type' => 'string', 'required' => true, 'example' => 'ecs'], ], ], 'responses' => [ @@ -2267,59 +1167,30 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'InvalidAuthorization', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0857B44C-315F-5E40-AA6A-48096D1EB508', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code. 200 indicates success, other values indicate failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'InvalidAuthorization'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0857B44C-315F-5E40-AA6A-48096D1EB508'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code. 200 indicates success, other values indicate failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -2328,36 +1199,20 @@ ], 'DeleteMyGroups' => [ 'summary' => 'Delete Personal Application Group', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '174549092', - ], + 'schema' => ['description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '174549092'], ], ], 'responses' => [ @@ -2365,63 +1220,25 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '107F0464-38F4-57F2-B1E0-237382F0FD72', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Status code, 200 indicates success, non-200 indicates failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '107F0464-38F4-57F2-B1E0-237382F0FD72'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Status code, 200 indicates success, non-200 indicates failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Group' => [ 'description' => 'Group information.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'Application group type. Values:'."\n" - .'- custom: Custom-built application group.'."\n" - .'- ehpc_cluster: Application group synchronized from an EHPC cluster.', - 'type' => 'string', - 'example' => 'custom', - ], - 'GroupName' => [ - 'description' => 'Application group name.', - 'type' => 'string', - 'example' => 'ECS_test', - ], - 'GroupId' => [ - 'description' => 'Application group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15055766', - ], - 'BindUrls' => [ - 'description' => 'Bind URLs', - 'type' => 'string', - 'example' => 'ehpc://i-dadfasdf/Login', - ], - 'ServiceId' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'example' => '1349', - ], + 'Type' => ['description' => 'Application group type. Values:'."\n" + .'- custom: Custom-built application group.'."\n" + .'- ehpc_cluster: Application group synchronized from an EHPC cluster.', 'type' => 'string', 'example' => 'custom'], + 'GroupName' => ['description' => 'Application group name.', 'type' => 'string', 'example' => 'ECS_test'], + 'GroupId' => ['description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '15055766'], + 'BindUrls' => ['description' => 'Bind URLs', 'type' => 'string', 'example' => 'ehpc://i-dadfasdf/Login'], + 'ServiceId' => ['description' => 'Service ID', 'type' => 'string', 'example' => '1349'], 'ContactGroups' => [ 'type' => 'object', 'itemNode' => true, @@ -2432,11 +1249,7 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '报警联系人的姓名。', - 'type' => 'string', - 'example' => 'xiaoming', - ], + 'Name' => ['description' => '报警联系人的姓名。', 'type' => 'string', 'example' => 'xiaoming'], ], ], ], @@ -2450,34 +1263,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -2486,50 +1284,28 @@ ], 'DeleteTasks' => [ 'summary' => 'Delete a site monitoring task', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task, which is the unique identifier for the task', - 'type' => 'string', - 'required' => true, - 'example' => '["2b5e6f7d-108f-4117-85fb-b202ba033468"]', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ID of the site monitoring task, which is the unique identifier for the task', 'type' => 'string', 'required' => true, 'example' => '["2b5e6f7d-108f-4117-85fb-b202ba033468"]', 'docRequired' => true], ], [ 'name' => 'IsDeleteAlarms', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to delete the alarm rules associated with the task. The default value is 1.'."\n" - ."\n" - .'1: Delete the alarm rules as well'."\n" - .'0: Do not delete the alarm rules, only delete the task'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Whether to delete the alarm rules associated with the task. The default value is 1.'."\n" + ."\n" + .'1: Delete the alarm rules as well'."\n" + .'0: Do not delete the alarm rules, only delete the task'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -2537,59 +1313,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Error message', - 'type' => 'string', - 'example' => '请求成功', - ], - 'Data' => [ - 'description' => 'Return information'."\n", - 'type' => 'string', - 'example' => '{"count":1}', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for troubleshooting', - 'type' => 'string', - 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1', - ], - 'Success' => [ - 'description' => 'Indicates whether this call was successful', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => '请求成功'], + 'Data' => ['description' => 'Return information'."\n", 'type' => 'string', 'example' => '{"count":1}'], + 'RequestId' => ['description' => 'Request ID, used for troubleshooting', 'type' => 'string', 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1'], + 'Success' => ['description' => 'Indicates whether this call was successful', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'], ], [ - [ - 'errorCode' => 'TaskNotExists', - 'errorMessage' => 'Task not exist', - ], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task not exist'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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":""}]', @@ -2599,131 +1343,80 @@ ], 'DescribeAlarmHistory' => [ 'summary' => 'DescribeAlarmHistory', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AlertName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Ascending', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false], ], [ 'name' => 'OnlyCount', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], ], 'responses' => [ @@ -2731,21 +1424,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Total' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Total' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], 'AlarmHistoryList' => [ 'type' => 'object', 'itemNode' => true, @@ -2755,76 +1438,32 @@ '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', - ], + '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', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -2834,9 +1473,7 @@ 'properties' => [ 'ContactALIIM' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -2846,9 +1483,7 @@ 'properties' => [ 'ContactMail' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -2858,9 +1493,7 @@ 'properties' => [ 'ContactSms' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -2870,9 +1503,7 @@ 'properties' => [ 'ContactGroup' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -2887,176 +1518,102 @@ ], 'errorCodes' => [ 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 206 => [ - [ - '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'], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 409 => [ - [ - '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. ', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError ', 'errorMessage' => 'The request processing has failed due to some unknown error. '], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], ], 'responseDemo' => null, ], 'DescribeAlarms' => [ 'summary' => 'DescribeAlarms', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'GroupBy', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EnableState', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'AlertState', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Names', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'NameKeyword', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -3064,25 +1621,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'Code' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Message' => [ - 'type' => 'string', - ], - 'TraceId' => [ - 'type' => 'string', - ], - 'Total' => [ - 'type' => 'string', - ], + '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, @@ -3092,160 +1636,68 @@ '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', - ], + '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', - ], + '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', - ], + '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', - ], + 'ComparisonOperator' => ['type' => 'string'], + 'PreCondition' => ['type' => 'string'], + 'Times' => ['type' => 'string'], + 'Threshold' => ['type' => 'string'], + 'HistoryDataRange' => ['type' => 'string'], + 'Statistics' => ['type' => 'string'], + 'AlertSensitivity' => ['type' => 'string'], ], ], ], @@ -3261,181 +1713,97 @@ ], 'errorCodes' => [ 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.'], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['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' => '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.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['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.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], ], 'responseDemo' => null, ], 'DescribeAlarmsForResources' => [ 'summary' => 'describealarmsforresources', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the monitoring item for the cloud product.', - 'type' => 'string', - 'required' => false, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'The name of the monitoring item for the cloud product.', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization'], ], [ 'name' => 'EnableState', 'in' => 'query', - 'schema' => [ - 'description' => 'The enabled state of the alarm rule. Values: -true: Enabled. -false: Disabled.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The enabled state of the alarm rule. Values: -true: Enabled. -false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The data namespace of the monitoring item.', - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The data namespace of the monitoring item.', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'schema' => ['description' => 'Group ID.', 'type' => 'string', 'required' => false, 'example' => '123456'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number. '."\n" - ."\n" - .'Default value: 1.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number. '."\n" + ."\n" + .'Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ 'name' => 'AlertState', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alarm rule. Values: '."\n" - .'- OK: Normal. '."\n" - .'- ALARM: Alarm. '."\n" - .'- INSUFFICIENT_DATA: Insufficient data.', - 'type' => 'string', - 'required' => false, - 'example' => 'OK', - ], + 'schema' => ['description' => 'The status of the alarm rule. Values: '."\n" + .'- OK: Normal. '."\n" + .'- ALARM: Alarm. '."\n" + .'- INSUFFICIENT_DATA: Insufficient data.', 'type' => 'string', 'required' => false, 'example' => 'OK'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Dimension map used to query monitoring data for specific resources.', - 'type' => 'string', - 'required' => true, - 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', - ], + 'schema' => ['description' => 'Dimension map used to query monitoring data for specific resources.', 'type' => 'string', 'required' => true, 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]'], ], ], 'responses' => [ @@ -3443,46 +1811,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values: '."\n" - .'- true: Success. '."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Dimensions' => [ - 'description' => 'Dimension map used to query monitoring data for specific resources.', - 'type' => 'string', - 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}', - ], - 'Code' => [ - 'description' => 'Status code. '."\n" - ."\n" - .'> 200 indicates success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'TraceId' => [ - 'description' => 'Call chain ID.', - 'type' => 'string', - 'example' => 'f1b83c3b-b6ea-4a4e-9087-b5752e7da052', - ], - 'Total' => [ - 'description' => 'Total number of records.', - 'type' => 'string', - 'example' => '22', - ], + 'RequestId' => ['description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values: '."\n" + .'- true: Success. '."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'Dimensions' => ['description' => 'Dimension map used to query monitoring data for specific resources.', 'type' => 'string', 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}'], + 'Code' => ['description' => 'Status code. '."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], + 'TraceId' => ['description' => 'Call chain ID.', 'type' => 'string', 'example' => 'f1b83c3b-b6ea-4a4e-9087-b5752e7da052'], + 'Total' => ['description' => 'Total number of records.', 'type' => 'string', 'example' => '22'], 'Datapoints' => [ 'type' => 'object', 'itemNode' => true, @@ -3494,139 +1833,51 @@ 'description' => 'Alarm rule object.', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => 'Display name of the alarm rule.', - 'type' => 'string', - 'example' => '磁盘使用率', - ], - 'SilenceTime' => [ - 'description' => 'Channel silence time. Unit: seconds.', - 'type' => 'string', - 'example' => '3600', - ], - 'MetricName' => [ - 'description' => 'Monitoring item name.', - 'type' => 'string', - 'example' => 'CPUUtilization', - ], - 'EvaluationCount' => [ - 'description' => 'Number of consecutive detections that must meet the threshold condition before an alarm is triggered.', - 'type' => 'string', - 'example' => '3', - ], - 'Webhook' => [ - 'description' => 'URL address to be called back when an alarm occurs.', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb', - ], - 'State' => [ - 'description' => 'Alarm state.', - 'type' => 'string', - 'example' => 'OK', - ], - 'ContactGroups' => [ - 'description' => 'Alarm contact groups.', - 'type' => 'string', - 'example' => 'Server', - ], - 'Namespace' => [ - 'description' => 'Namespace of the cloud product.', - 'type' => 'string', - 'example' => 'platform-acs-fc-metrics', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alarm rule is not effective.', - 'type' => 'string', - 'example' => '00:00-05:30', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alarm rule is effective.', - 'type' => 'string', - 'example' => '0:00-23:59', - ], - 'Period' => [ - 'description' => 'The statistical period for monitoring data.', - 'type' => 'string', - 'example' => '60', - ], - 'ComparisonOperator' => [ - 'description' => 'Info level threshold comparison operator. Values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" - .'- GreaterThanThreshold: Greater than.'."\n" - .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" - .'- LessThanThreshold: Less than.'."\n" - .'- NotEqualToThreshold: Not equal to.'."\n" - .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" - .'- LessThanLastPeriod: Decreased compared to the previous period.', - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Uuid' => [ - 'description' => 'Alarm UUID.', - 'type' => 'string', - 'example' => 'abb18b9fc4ca45468a94763f24ddf898', - ], - 'GroupName' => [ - 'description' => 'Application group name.', - 'type' => 'string', - 'example' => 'edgeah-3ce900a3617747dcbd49cd7ff752b32a-iot-1wdrsc-ReplicaSet-lvmonitor-gf9bs0jt0dwdjlad-d6f999676', - ], - 'GroupId' => [ - 'description' => 'Application group ID.', - 'type' => 'string', - 'example' => '239757988', - ], - 'Subject' => [ - 'description' => 'Alarm title', - 'type' => 'string', - 'example' => 'Alibaba Cloud', - ], - 'Name' => [ - 'description' => 'Alarm name.', - 'type' => 'string', - 'example' => 'Ecs_Mem_Utilization', - ], - 'Threshold' => [ - 'description' => 'Alarm threshold.', - 'type' => 'string', - 'example' => '85', - ], - 'Level' => [ - 'description' => 'Alarm level. Values:'."\n" - .'- CRITICAL: Critical.'."\n" - .'- WARN: Warning.'."\n" - .'- INFO: Information.', - 'type' => 'string', - 'example' => 'CRITICAL', - ], - 'Resources' => [ - 'description' => 'Resources.', - 'type' => 'string', - 'example' => '[{\\"instanceId\\":\\"rmq-cn-o493nio5v0i\\",\\"userId\\":\\"1493622401794734\\"}]', - ], - 'Statistics' => [ - 'description' => 'Critical level alarm statistical method.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the specified cloud product\'s `MetricName`, such as Maximum, Minimum, and Average. For more information on how to obtain the value of this parameter, see [Cloud Product Monitoring Items](~~163515~~).'."\n" - ."\n" - .'> At least one of the alarm levels (Critical, Warn, or Info) must be set, and the parameters Statistics, ComparisonOperator, Threshold, and Times in that alarm level must all be set simultaneously.', - 'type' => 'string', - 'example' => 'Average', - ], - 'Enable' => [ - 'description' => 'The enablement status of the alarm. Values:'."\n" - ."\n" - .'- true: Enabled.'."\n" - ."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'DisplayName' => ['description' => 'Display name of the alarm rule.', 'type' => 'string', 'example' => '磁盘使用率'], + 'SilenceTime' => ['description' => 'Channel silence time. Unit: seconds.', 'type' => 'string', 'example' => '3600'], + 'MetricName' => ['description' => 'Monitoring item name.', 'type' => 'string', 'example' => 'CPUUtilization'], + 'EvaluationCount' => ['description' => 'Number of consecutive detections that must meet the threshold condition before an alarm is triggered.', 'type' => 'string', 'example' => '3'], + 'Webhook' => ['description' => 'URL address to be called back when an alarm occurs.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb'], + 'State' => ['description' => 'Alarm state.', 'type' => 'string', 'example' => 'OK'], + 'ContactGroups' => ['description' => 'Alarm contact groups.', 'type' => 'string', 'example' => 'Server'], + 'Namespace' => ['description' => 'Namespace of the cloud product.', 'type' => 'string', 'example' => 'platform-acs-fc-metrics'], + 'NoEffectiveInterval' => ['description' => 'The time period during which the alarm rule is not effective.', 'type' => 'string', 'example' => '00:00-05:30'], + 'EffectiveInterval' => ['description' => 'The time period during which the alarm rule is effective.', 'type' => 'string', 'example' => '0:00-23:59'], + 'Period' => ['description' => 'The statistical period for monitoring data.', 'type' => 'string', 'example' => '60'], + 'ComparisonOperator' => ['description' => 'Info level threshold comparison operator. Values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" + .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" + .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" + .'- LessThanLastPeriod: Decreased compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanThreshold'], + 'Uuid' => ['description' => 'Alarm UUID.', 'type' => 'string', 'example' => 'abb18b9fc4ca45468a94763f24ddf898'], + 'GroupName' => ['description' => 'Application group name.', 'type' => 'string', 'example' => 'edgeah-3ce900a3617747dcbd49cd7ff752b32a-iot-1wdrsc-ReplicaSet-lvmonitor-gf9bs0jt0dwdjlad-d6f999676'], + 'GroupId' => ['description' => 'Application group ID.', 'type' => 'string', 'example' => '239757988'], + 'Subject' => ['description' => 'Alarm title', 'type' => 'string', 'example' => 'Alibaba Cloud'], + 'Name' => ['description' => 'Alarm name.', 'type' => 'string', 'example' => 'Ecs_Mem_Utilization'], + 'Threshold' => ['description' => 'Alarm threshold.', 'type' => 'string', 'example' => '85'], + 'Level' => ['description' => 'Alarm level. Values:'."\n" + .'- CRITICAL: Critical.'."\n" + .'- WARN: Warning.'."\n" + .'- INFO: Information.', 'type' => 'string', 'example' => 'CRITICAL'], + 'Resources' => ['description' => 'Resources.', 'type' => 'string', 'example' => '[{\\"instanceId\\":\\"rmq-cn-o493nio5v0i\\",\\"userId\\":\\"1493622401794734\\"}]'], + 'Statistics' => ['description' => 'Critical level alarm statistical method.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the specified cloud product\'s `MetricName`, such as Maximum, Minimum, and Average. For more information on how to obtain the value of this parameter, see [Cloud Product Monitoring Items](~~163515~~).'."\n" + ."\n" + .'> At least one of the alarm levels (Critical, Warn, or Info) must be set, and the parameters Statistics, ComparisonOperator, Threshold, and Times in that alarm level must all be set simultaneously.', 'type' => 'string', 'example' => 'Average'], + 'Enable' => ['description' => 'The enablement status of the alarm. Values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true'], 'Escalations' => [ 'description' => 'Alarm escalation configuration.', 'type' => 'object', @@ -3635,117 +1886,69 @@ 'description' => 'Info level alarm.', 'type' => 'object', 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'Comparison operator for the Info level threshold. Values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" - .'- GreaterThanThreshold: greater than.'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" - .'- LessThanThreshold: less than.'."\n" - .'- NotEqualToThreshold: not equal to.'."\n" - .'- EqualToThreshold: equal to.'."\n" - .'- GreaterThanYesterday: increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: increased compared to the previous period.'."\n" - .'- LessThanLastPeriod: decreased compared to the previous period.'."\n" - ."\n" - .'> At least one of the alarm levels (Critical, Warn, or Info) must be set, and the parameters Statistics, ComparisonOperator, Threshold, and Times must be set simultaneously for that alarm level.', - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Times' => [ - 'description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'Threshold for the Info level.', - 'type' => 'string', - 'example' => '99', - ], - 'Statistics' => [ - 'description' => 'Alarm statistical method.', - 'type' => 'string', - 'example' => 'Average', - ], + 'ComparisonOperator' => ['description' => 'Comparison operator for the Info level threshold. Values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- EqualToThreshold: equal to.'."\n" + .'- GreaterThanYesterday: increased compared to the same time yesterday.'."\n" + .'- LessThanYesterday: decreased compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: increased compared to the same time last week.'."\n" + .'- LessThanLastWeek: decreased compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: increased compared to the previous period.'."\n" + .'- LessThanLastPeriod: decreased compared to the previous period.'."\n" + ."\n" + .'> At least one of the alarm levels (Critical, Warn, or Info) must be set, and the parameters Statistics, ComparisonOperator, Threshold, and Times must be set simultaneously for that alarm level.', 'type' => 'string', 'example' => 'GreaterThanThreshold'], + 'Times' => ['description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', 'type' => 'string', 'example' => '3'], + 'Threshold' => ['description' => 'Threshold for the Info level.', 'type' => 'string', 'example' => '99'], + 'Statistics' => ['description' => 'Alarm statistical method.', 'type' => 'string', 'example' => 'Average'], ], ], 'Warn' => [ 'description' => 'Warn level alarm.', 'type' => 'object', 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'Comparison operator for the Warn level threshold. Values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" - .'- GreaterThanThreshold: greater than.'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" - .'- LessThanThreshold: less than.'."\n" - .'- NotEqualToThreshold: not equal to.'."\n" - .'- GreaterThanYesterday: increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: increased compared to the previous period.'."\n" - .'- LessThanLastPeriod: decreased compared to the previous period.', - 'type' => 'string', - 'example' => 'LessThanOrEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'Threshold for the Warn level.', - 'type' => 'string', - 'example' => '100', - ], - 'Statistics' => [ - 'description' => 'Alarm statistical method.', - 'type' => 'string', - 'example' => 'Average', - ], + 'ComparisonOperator' => ['description' => 'Comparison operator for the Warn level threshold. Values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: increased compared to the same time yesterday.'."\n" + .'- LessThanYesterday: decreased compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: increased compared to the same time last week.'."\n" + .'- LessThanLastWeek: decreased compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: increased compared to the previous period.'."\n" + .'- LessThanLastPeriod: decreased compared to the previous period.', 'type' => 'string', 'example' => 'LessThanOrEqualToThreshold'], + 'Times' => ['description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', 'type' => 'string', 'example' => '3'], + 'Threshold' => ['description' => 'Threshold for the Warn level.', 'type' => 'string', 'example' => '100'], + 'Statistics' => ['description' => 'Alarm statistical method.', 'type' => 'string', 'example' => 'Average'], ], ], 'Critical' => [ 'description' => 'Critical level alarm.', 'type' => 'object', 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'Threshold comparison operator. Values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" - .'- GreaterThanThreshold: Greater than.'."\n" - .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" - .'- LessThanThreshold: Less than.'."\n" - .'- NotEqualToThreshold: Not equal to.'."\n" - .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" - .'- LessThanLastPeriod: Decreased compared to the previous period.', - 'type' => 'string', - 'example' => 'LessThanThreshold', - ], - 'Times' => [ - 'description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'Critical level threshold.', - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'Alarm statistical method.', - 'type' => 'string', - 'example' => 'Average', - ], + 'ComparisonOperator' => ['description' => 'Threshold comparison operator. Values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" + .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" + .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" + .'- LessThanLastPeriod: Decreased compared to the previous period.', 'type' => 'string', 'example' => 'LessThanThreshold'], + 'Times' => ['description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', 'type' => 'string', 'example' => '3'], + 'Threshold' => ['description' => 'Critical level threshold.', 'type' => 'string', 'example' => '90'], + 'Statistics' => ['description' => 'Alarm statistical method.', 'type' => 'string', 'example' => 'Average'], ], ], ], @@ -3761,22 +1964,13 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -3785,164 +1979,87 @@ ], 'DescribeAlertHistoryList' => [ 'summary' => 'Query alarm history details', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AlertName', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm name.', - 'type' => 'string', - 'required' => false, - 'example' => 'HighErrorRate', - ], + 'schema' => ['description' => 'Alarm name.', 'type' => 'string', 'required' => false, 'example' => 'HighErrorRate'], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm rule name.', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Rule', - ], + 'schema' => ['description' => 'Alarm rule name.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Rule'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'Metric name.', - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'Metric name.', 'type' => 'string', 'required' => false, 'example' => 'cpu_total'], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'required' => false, - 'example' => '35235226', - ], + 'schema' => ['description' => 'Group ID.', 'type' => 'string', 'required' => false, 'example' => '35235226'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'Channel silence status. Values:'."\n" - .'- 2 (default): Channel is silent.'."\n" - .'- 0: Alarm or recovery.'."\n" - .'- 1: Invalid period.', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'Channel silence status. Values:'."\n" + .'- 2 (default): Channel is silent.'."\n" + .'- 0: Alarm or recovery.'."\n" + .'- 1: Invalid period.', 'type' => 'string', 'required' => false, 'example' => '2'], ], [ 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm status. Values:'."\n" - .'- ALARM (default): Alarm state.'."\n" - .'- OK: Normal state.', - 'type' => 'string', - 'required' => false, - 'example' => 'ok', - ], + 'schema' => ['description' => 'Alarm status. Values:'."\n" + .'- ALARM (default): Alarm state.'."\n" + .'- OK: Normal state.', 'type' => 'string', 'required' => false, 'example' => 'ok'], ], [ 'name' => 'Ascending', 'in' => 'query', - 'schema' => [ - 'description' => 'Time sorting. Values: true (default): indicates reverse chronological order. false: indicates chronological order.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Time sorting. Values: true (default): indicates reverse chronological order. false: indicates chronological order.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'OnlyCount', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether the alarm threshold is met. Values: -true: condition is met. -false: condition is not met.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Whether the alarm threshold is met. Values: -true: condition is met. -false: condition is not met.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start time for querying alarms.', - 'type' => 'string', - 'required' => false, - 'example' => '1552209685596', - ], + 'schema' => ['description' => 'Start time for querying alarms.', 'type' => 'string', 'required' => false, 'example' => '1552209685596'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'End time for querying alarms.', - 'type' => 'string', - 'required' => false, - 'example' => '1640608200000', - ], + 'schema' => ['description' => 'End time for querying alarms.', 'type' => 'string', 'required' => false, 'example' => '1640608200000'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.'."\n" - ."\n" - .'Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -3950,31 +2067,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code. 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for troubleshooting.', - 'type' => 'string', - 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63', - ], - 'Total' => [ - 'description' => 'Total number of records.', - 'type' => 'string', - 'example' => '2', - ], - 'Success' => [ - 'description' => 'Whether the operation was successful. true indicates success, false indicates failure.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code. 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => 'Request ID, used for troubleshooting.', 'type' => 'string', 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63'], + 'Total' => ['description' => 'Total number of records.', 'type' => 'string', 'example' => '2'], + 'Success' => ['description' => 'Whether the operation was successful. true indicates success, false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'AlarmHistoryList' => [ 'type' => 'object', 'itemNode' => true, @@ -3985,105 +2082,25 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Alarm status.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'stopped', - ], - 'MetricName' => [ - 'description' => 'Metric name', - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EvaluationCount' => [ - 'description' => 'Number of consecutive detections that meet the threshold condition before an alarm is triggered.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'State' => [ - 'description' => 'Alarm status.', - 'type' => 'string', - 'example' => 'Finished', - ], - 'UserId' => [ - 'description' => 'User ID', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'PreLevel' => [ - 'description' => 'Previous alarm level', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'Namespace' => [ - 'description' => 'Namespace.', - 'type' => 'string', - 'example' => 'acs_vpc_eip', - ], - 'AlertName' => [ - 'description' => 'Alarm name.', - 'type' => 'string', - 'example' => '测评内测-数据库慢调用-低', - ], - 'Webhooks' => [ - 'description' => '报警发生时,回调的URL地址', - 'type' => 'string', - 'example' => '[\\"https://oapi.dingtalk.com/robot/send?access_token=cca17c14bbc6b81b35fdc7caa19fdda531b659eee2969cc35a6362e3b2d10c13\\"]', - ], - 'RuleName' => [ - 'description' => 'Alarm rule name.', - 'type' => 'string', - 'example' => 'ecs 5分钟tcp连接数超过80%', - ], - 'LastTime' => [ - 'description' => 'Duration of the alarm.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1744597658', - ], - 'Value' => [ - 'description' => 'Tag value of the alarm template.', - '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' => 'Expression.', - 'type' => 'string', - 'example' => '1', - ], - 'GroupId' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'example' => '239765677', - ], - 'AlertTime' => [ - 'description' => 'Time when the alarm occurred.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552209685596', - ], - 'InstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'example' => 'prd-sflocalizationapi-5855fd9d6d-8hhx9', - ], - 'Dimensions' => [ - 'description' => 'Dimensions.', - 'type' => 'string', - 'example' => '{\\"instanceId\\":\\"i-wz9fovee1h4jv7igaz8i\\"}', - ], - 'Level' => [ - 'description' => 'Alarm level.', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'Id' => [ - 'description' => 'Alarm ID.', - 'type' => 'string', - 'example' => '3393FD4A10BD5723CD0DCFB4B25AC79928735672', - ], + 'Status' => ['description' => 'Alarm status.', 'type' => 'integer', 'format' => 'int32', 'example' => 'stopped'], + 'MetricName' => ['description' => 'Metric name', 'type' => 'string', 'example' => 'cpu_total'], + 'EvaluationCount' => ['description' => 'Number of consecutive detections that meet the threshold condition before an alarm is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'State' => ['description' => 'Alarm status.', 'type' => 'string', 'example' => 'Finished'], + 'UserId' => ['description' => 'User ID', 'type' => 'string', 'example' => 'xxxxxx'], + 'PreLevel' => ['description' => 'Previous alarm level', 'type' => 'string', 'example' => 'NORMAL'], + 'Namespace' => ['description' => 'Namespace.', 'type' => 'string', 'example' => 'acs_vpc_eip'], + 'AlertName' => ['description' => 'Alarm name.', 'type' => 'string', 'example' => '测评内测-数据库慢调用-低'], + 'Webhooks' => ['description' => '报警发生时,回调的URL地址', 'type' => 'string', 'example' => '[\\"https://oapi.dingtalk.com/robot/send?access_token=cca17c14bbc6b81b35fdc7caa19fdda531b659eee2969cc35a6362e3b2d10c13\\"]'], + 'RuleName' => ['description' => 'Alarm rule name.', 'type' => 'string', 'example' => 'ecs 5分钟tcp连接数超过80%'], + 'LastTime' => ['description' => 'Duration of the alarm.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744597658'], + 'Value' => ['description' => 'Tag value of the alarm template.', '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' => 'Expression.', 'type' => 'string', 'example' => '1'], + 'GroupId' => ['description' => 'Group ID.', 'type' => 'string', 'example' => '239765677'], + 'AlertTime' => ['description' => 'Time when the alarm occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552209685596'], + 'InstanceName' => ['description' => 'Instance name.', 'type' => 'string', 'example' => 'prd-sflocalizationapi-5855fd9d6d-8hhx9'], + 'Dimensions' => ['description' => 'Dimensions.', 'type' => 'string', 'example' => '{\\"instanceId\\":\\"i-wz9fovee1h4jv7igaz8i\\"}'], + 'Level' => ['description' => 'Alarm level.', 'type' => 'string', 'example' => 'NORMAL'], + 'Id' => ['description' => 'Alarm ID.', 'type' => 'string', 'example' => '3393FD4A10BD5723CD0DCFB4B25AC79928735672'], 'Contacts' => [ 'type' => 'object', 'itemNode' => true, @@ -4091,11 +2108,7 @@ 'Contact' => [ 'description' => 'List of contacts', 'type' => 'array', - 'items' => [ - 'description' => 'Contact', - 'type' => 'string', - 'example' => '185xxxx0307', - ], + 'items' => ['description' => 'Contact', 'type' => 'string', 'example' => '185xxxx0307'], ], ], ], @@ -4106,11 +2119,7 @@ 'ContactALIIM' => [ 'description' => 'List of Aliwangwang contacts', 'type' => 'array', - 'items' => [ - 'description' => 'Aliwangwang contact', - 'type' => 'string', - 'example' => 'seller001', - ], + 'items' => ['description' => 'Aliwangwang contact', 'type' => 'string', 'example' => 'seller001'], ], ], ], @@ -4121,11 +2130,7 @@ 'ContactMail' => [ 'description' => 'List of email contacts', 'type' => 'array', - 'items' => [ - 'description' => 'Email contact', - 'type' => 'string', - 'example' => 'xxx@xxx.com', - ], + 'items' => ['description' => 'Email contact', 'type' => 'string', 'example' => 'xxx@xxx.com'], ], ], ], @@ -4136,11 +2141,7 @@ 'ContactSms' => [ 'description' => 'List of SMS contacts', 'type' => 'array', - 'items' => [ - 'description' => 'Phone number of the contact', - 'type' => 'string', - 'example' => '185xxxx0307', - ], + 'items' => ['description' => 'Phone number of the contact', 'type' => 'string', 'example' => '185xxxx0307'], ], ], ], @@ -4151,11 +2152,7 @@ 'ContactGroup' => [ 'description' => 'List of alarm contact groups.', 'type' => 'array', - 'items' => [ - 'description' => 'Alarm contact group.', - 'type' => 'string', - 'example' => '开发运维报警组', - ], + 'items' => ['description' => 'Alarm contact group.', 'type' => 'string', 'example' => '开发运维报警组'], ], ], ], @@ -4170,62 +2167,32 @@ ], 'errorCodes' => [ 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 206 => [ - [ - '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'], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 409 => [ - [ - '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. ', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError ', 'errorMessage' => 'The request processing has failed due to some unknown error. '], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['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 \\"xxx@xxx.com\\"\\n ]\\n },\\n \\"ContactSmses\\": {\\n \\"ContactSms\\": [\\n \\"185xxxx0307\\"\\n ]\\n },\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"开发运维报警组\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', @@ -4234,35 +2201,20 @@ ], 'DescribeContact' => [ 'summary' => 'Describe Contact', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ContactName', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm contact name.', - 'type' => 'string', - 'required' => true, - 'example' => 'SCRM报警群', - ], + 'schema' => ['description' => 'Alarm contact name.', 'type' => 'string', 'required' => true, 'example' => 'SCRM报警群'], ], ], 'responses' => [ @@ -4270,36 +2222,15 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code. Note 200 indicates success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for troubleshooting.', - 'type' => 'string', - 'example' => '325232CF-6F24-513B-A55C-49B2071F72A3', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code. Note 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => 'Request ID, used for troubleshooting.', 'type' => 'string', 'example' => '325232CF-6F24-513B-A55C-49B2071F72A3'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', 'type' => 'boolean', 'example' => 'true'], 'Datapoints' => [ 'description' => 'Monitoring data list.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Alarm contact name.', - 'type' => 'string', - 'example' => 'hostName', - ], + 'Name' => ['description' => 'Alarm contact name.', 'type' => 'string', 'example' => 'hostName'], 'Channels' => [ 'type' => 'object', 'itemNode' => true, @@ -4311,16 +2242,8 @@ 'description' => 'Subscription channels.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'Subscription type', - 'type' => 'string', - 'example' => 'SMS', - ], - 'Value' => [ - 'description' => 'Value.', - 'type' => 'string', - 'example' => 'SMS', - ], + 'Type' => ['description' => 'Subscription type', 'type' => 'string', 'example' => 'SMS'], + 'Value' => ['description' => 'Value.', 'type' => 'string', 'example' => 'SMS'], ], ], ], @@ -4334,28 +2257,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'], ], [ - [ - 'errorCode' => 'InvalidAction', - 'errorMessage' => 'The specified GroupName does not exist.', - ], + ['errorCode' => 'InvalidAction', 'errorMessage' => 'The specified GroupName does not exist.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -4364,45 +2275,25 @@ ], 'DescribeISPAreaCity' => [ 'summary' => '获取探针列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Isp', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''], ], [ 'name' => 'City', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ @@ -4410,181 +2301,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '84C8BA48-7FD3-46F8-AEE3-E24657C22289', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => '', 'type' => 'string', 'example' => ''], + 'RequestId' => ['description' => '', '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.', - ], + ['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.', - ], + ['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":""}]', ], 'DescribeMetricRuleList' => [ 'summary' => 'Query the list of alarm rules', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'Name of the monitoring item.', - 'type' => 'string', - 'required' => false, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'Name of the monitoring item.', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization'], ], [ 'name' => 'EnableState', 'in' => 'query', - 'schema' => [ - 'description' => 'The enabled state of the alarm rule. Values:'."\n" - .'- true: Enabled.'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The enabled state of the alarm rule. Values:'."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Namespace of the cloud product.', - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'Namespace of the cloud product.', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.'."\n" - ."\n" - .'Starting value: 1. Default value: 1.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number.'."\n" + ."\n" + .'Starting value: 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ 'name' => 'AlertState', 'in' => 'query', - 'schema' => [ - 'description' => 'State of the alarm rule. Values:'."\n" - .'- OK: Normal.'."\n" - .'- ALARM: Alarm.'."\n" - .'- INSUFFICIENT_DATA: Insufficient data.', - 'type' => 'string', - 'required' => false, - 'example' => 'OK', - ], + 'schema' => ['description' => 'State of the alarm rule. Values:'."\n" + .'- OK: Normal.'."\n" + .'- ALARM: Alarm.'."\n" + .'- INSUFFICIENT_DATA: Insufficient data.', 'type' => 'string', 'required' => false, 'example' => 'OK'], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'Dimensions of the alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', - ], + 'schema' => ['description' => 'Dimensions of the alarm rule.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]'], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Name of the alarm rule.'."\n" - ."\n" - .'This parameter supports fuzzy search.', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_CPU_Alarm', - ], + 'schema' => ['description' => 'Name of the alarm rule.'."\n" + ."\n" + .'This parameter supports fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'ECS_CPU_Alarm'], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'group-1234567890', - ], + 'schema' => ['description' => 'Group ID.', 'type' => 'string', 'required' => false, 'example' => 'group-1234567890'], ], [ 'name' => 'RuleIds', 'in' => 'query', - 'schema' => [ - 'description' => 'List of alarm rule IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule-1234567890,rule-2345678901', - ], + 'schema' => ['description' => 'List of alarm rule IDs.', 'type' => 'string', 'required' => false, 'example' => 'rule-1234567890,rule-2345678901'], ], ], 'responses' => [ @@ -4592,36 +2397,15 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code. 200 indicates success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for troubleshooting.', - 'type' => 'string', - 'example' => '386C6712-335F-5054-930A-CC92B851ECBA', - ], - 'Total' => [ - 'description' => 'Total number of records.', - 'type' => 'string', - 'example' => '96', - ], - 'Success' => [ - 'description' => 'Whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code. 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => 'Request ID, used for troubleshooting.', 'type' => 'string', 'example' => '386C6712-335F-5054-930A-CC92B851ECBA'], + 'Total' => ['description' => 'Total number of records.', 'type' => 'string', 'example' => '96'], + 'Success' => ['description' => 'Whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], 'Alarms' => [ 'type' => 'object', 'itemNode' => true, @@ -4633,104 +2417,32 @@ 'description' => 'Alarm rule object.', 'type' => 'object', 'properties' => [ - 'SilenceTime' => [ - 'description' => 'Notification silence time', - 'type' => 'string', - 'example' => '3600', - ], - 'MetricName' => [ - 'description' => 'Name of the monitoring item.', - 'type' => 'string', - 'example' => 'Availability', - ], - 'Webhook' => [ - 'description' => 'URL address specified for callback when an alarm occurs.', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb', - ], - 'ContactGroups' => [ - 'description' => 'Alarm contact groups.', - 'type' => 'string', - 'example' => 'test_monitor', - ], - 'SourceType' => [ - 'description' => 'Alert source type.', - 'type' => 'string', - 'example' => 'ecs', - ], - 'Namespace' => [ - 'description' => 'Namespace of the cloud product.', - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'MailSubject' => [ - 'description' => 'Email subject.', - 'type' => 'string', - 'example' => 'ECS CPU excessive usage rate', - ], - 'NoEffectiveInterval' => [ - 'description' => 'Time period during which the alarm is not effective.', - 'type' => 'string', - 'example' => '00:00-05:30', - ], - 'EffectiveInterval' => [ - 'description' => 'Effective time period of the alarm rule.', - 'type' => 'string', - 'example' => '10:00-18:59', - ], - 'RuleName' => [ - 'description' => '报警规则名称。', - 'type' => 'string', - 'example' => 'DefaultEventRule', - ], - 'AlertState' => [ - 'description' => 'Alarm rule status. Values:'."\n" - ."\n" - .'- OK: Normal.'."\n" - .'- ALARM: Alarm.'."\n" - .'- INSUFFICIENT_DATA: Insufficient data.', - 'type' => 'string', - 'example' => 'OK', - ], - 'Period' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - .'Unit: seconds.', - 'type' => 'string', - 'example' => '60', - ], - 'RuleId' => [ - 'description' => 'Alarm rule ID.', - 'type' => 'string', - 'example' => 'rule-1234567890', - ], - 'GroupName' => [ - 'description' => 'Alarm group name.', - 'type' => 'string', - 'example' => 'ops_group', - ], - 'GroupId' => [ - 'description' => 'Alarm group ID.', - 'type' => 'string', - 'example' => 'group-1234567890', - ], - 'Dimensions' => [ - 'description' => 'Resource dimension information.', - 'type' => 'string', - 'example' => '{\'instanceId\': \'ts-2ze34h60m9pv0ck3v\'}', - ], - 'EnableState' => [ - 'description' => 'The enablement status of the alarm rule. Values:'."\n" - ."\n" - .'- true: Enabled.'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ - 'description' => 'Resource name', - 'type' => 'string', - 'example' => '[{\\"instanceId\\": \\"i-bp17raa25u0rbg9xreti\\"}]', - ], + 'SilenceTime' => ['description' => 'Notification silence time', 'type' => 'string', 'example' => '3600'], + 'MetricName' => ['description' => 'Name of the monitoring item.', 'type' => 'string', 'example' => 'Availability'], + 'Webhook' => ['description' => 'URL address specified for callback when an alarm occurs.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb'], + 'ContactGroups' => ['description' => 'Alarm contact groups.', 'type' => 'string', 'example' => 'test_monitor'], + 'SourceType' => ['description' => 'Alert source type.', 'type' => 'string', 'example' => 'ecs'], + 'Namespace' => ['description' => 'Namespace of the cloud product.', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], + 'MailSubject' => ['description' => 'Email subject.', 'type' => 'string', 'example' => 'ECS CPU excessive usage rate'], + 'NoEffectiveInterval' => ['description' => 'Time period during which the alarm is not effective.', 'type' => 'string', 'example' => '00:00-05:30'], + 'EffectiveInterval' => ['description' => 'Effective time period of the alarm rule.', 'type' => 'string', 'example' => '10:00-18:59'], + 'RuleName' => ['description' => '报警规则名称。', 'type' => 'string', 'example' => 'DefaultEventRule'], + 'AlertState' => ['description' => 'Alarm rule status. Values:'."\n" + ."\n" + .'- OK: Normal.'."\n" + .'- ALARM: Alarm.'."\n" + .'- INSUFFICIENT_DATA: Insufficient data.', 'type' => 'string', 'example' => 'OK'], + 'Period' => ['description' => 'The statistical period of the monitoring data.'."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60'], + 'RuleId' => ['description' => 'Alarm rule ID.', 'type' => 'string', 'example' => 'rule-1234567890'], + 'GroupName' => ['description' => 'Alarm group name.', 'type' => 'string', 'example' => 'ops_group'], + 'GroupId' => ['description' => 'Alarm group ID.', 'type' => 'string', 'example' => 'group-1234567890'], + 'Dimensions' => ['description' => 'Resource dimension information.', 'type' => 'string', 'example' => '{\'instanceId\': \'ts-2ze34h60m9pv0ck3v\'}'], + 'EnableState' => ['description' => 'The enablement status of the alarm rule. Values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true'], + 'Resources' => ['description' => 'Resource name', 'type' => 'string', 'example' => '[{\\"instanceId\\": \\"i-bp17raa25u0rbg9xreti\\"}]'], 'Escalations' => [ 'description' => 'Alarm escalation policy object.', 'type' => 'object', @@ -4739,131 +2451,83 @@ 'description' => 'Info level object.', 'type' => 'object', 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'Info level threshold comparison operator. Values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" - .'- GreaterThanThreshold: Greater than.'."\n" - .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" - .'- LessThanThreshold: Less than.'."\n" - .'- NotEqualToThreshold: Not equal to.'."\n" - .'- EqualToThreshold: Equal to.'."\n" - .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" - .'- LessThanLastPeriod: Decreased compared to the previous period.'."\n" - ."\n" - .'N value range: 1~50.'."\n" - ."\n" - .'> At least one of the alarm levels (Critical, Warn, or Info) must be set, and the parameters Statistics, ComparisonOperator, Threshold, and Times for that alarm level must all be set.', - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Times' => [ - 'description' => 'The number of times the alarm condition must be met to trigger an alarm notification.', - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'Alarm threshold.'."\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', - ], + 'ComparisonOperator' => ['description' => 'Info level threshold comparison operator. Values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- EqualToThreshold: Equal to.'."\n" + .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" + .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" + .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" + .'- LessThanLastPeriod: Decreased compared to the previous period.'."\n" + ."\n" + .'N value range: 1~50.'."\n" + ."\n" + .'> At least one of the alarm levels (Critical, Warn, or Info) must be set, and the parameters Statistics, ComparisonOperator, Threshold, and Times for that alarm level must all be set.', 'type' => 'string', 'example' => 'GreaterThanThreshold'], + 'Times' => ['description' => 'The number of times the alarm condition must be met to trigger an alarm notification.', 'type' => 'string', 'example' => '3'], + 'Threshold' => ['description' => 'Alarm threshold.'."\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 level object.', 'type' => 'object', 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'Warn level threshold comparison operator. Values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" - .'- GreaterThanThreshold: Greater than.'."\n" - .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" - .'- LessThanThreshold: Less than.'."\n" - .'- NotEqualToThreshold: Not equal to.'."\n" - .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" - .'- LessThanLastPeriod: Decreased compared to the previous period.', - 'type' => 'string', - 'example' => 'NotEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'Alarm threshold.', - 'type' => 'string', - 'example' => '70', - ], - 'Statistics' => [ - 'description' => 'Warn level alarm statistical method. Multiple statistical methods are separated by a comma (,).'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified cloud product, such as Maximum, Minimum, and Average. For more information on how to obtain the value of this parameter, see [Cloud Product Monitoring Items](~~163515~~).', - 'type' => 'string', - 'example' => 'Average', - ], + 'ComparisonOperator' => ['description' => 'Warn level threshold comparison operator. Values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" + .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" + .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" + .'- LessThanLastPeriod: Decreased compared to the previous period.', 'type' => 'string', 'example' => 'NotEqualToThreshold'], + 'Times' => ['description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', 'type' => 'string', 'example' => '3'], + 'Threshold' => ['description' => 'Alarm threshold.', 'type' => 'string', 'example' => '70'], + 'Statistics' => ['description' => 'Warn level alarm statistical method. Multiple statistical methods are separated by a comma (,).'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified cloud product, such as Maximum, Minimum, and Average. For more information on how to obtain the value of this parameter, see [Cloud Product Monitoring Items](~~163515~~).', 'type' => 'string', 'example' => 'Average'], ], ], 'Critical' => [ 'description' => 'Critical level object.', 'type' => 'object', 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'Critical level threshold comparison operator. Values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" - .'- GreaterThanThreshold: Greater than.'."\n" - .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" - .'- LessThanThreshold: Less than.'."\n" - .'- NotEqualToThreshold: Not equal to.'."\n" - .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" - .'- LessThanLastPeriod: Decreased compared to the previous period.', - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'Alarm threshold.', - 'type' => 'string', - 'example' => '85', - ], - 'Statistics' => [ - 'description' => 'Critical level alarm statistical method.'."\n" - ."\n" - .'The value range for N is 1~50.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified cloud product, such as Maximum, Minimum, and Average. For more information on how to obtain the value of this parameter, see [Cloud Product Monitoring Items](~~163515~~).'."\n" - ."\n" - .'> At least one of the alarm levels Critical (severe), Warn (warning), or Info (information) must be set, and the parameters Statistics, ComparisonOperator, Threshold, and Times in that alarm level must all be set simultaneously.', - 'type' => 'string', - 'example' => 'Average', - ], + 'ComparisonOperator' => ['description' => 'Critical level threshold comparison operator. Values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- GreaterThanYesterday: Increased compared to the same time yesterday.'."\n" + .'- LessThanYesterday: Decreased compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Increased compared to the same time last week.'."\n" + .'- LessThanLastWeek: Decreased compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: Increased compared to the previous period.'."\n" + .'- LessThanLastPeriod: Decreased compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold'], + 'Times' => ['description' => 'The number of times the alarm condition must be met before an alarm notification is sent.', 'type' => 'string', 'example' => '3'], + 'Threshold' => ['description' => 'Alarm threshold.', 'type' => 'string', 'example' => '85'], + 'Statistics' => ['description' => 'Critical level alarm statistical method.'."\n" + ."\n" + .'The value range for N is 1~50.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified cloud product, such as Maximum, Minimum, and Average. For more information on how to obtain the value of this parameter, see [Cloud Product Monitoring Items](~~163515~~).'."\n" + ."\n" + .'> At least one of the alarm levels Critical (severe), Warn (warning), or Info (information) must be set, and the parameters Statistics, ComparisonOperator, Threshold, and Times in that alarm level must all be set simultaneously.', 'type' => 'string', 'example' => 'Average'], ], ], ], @@ -4879,22 +2543,13 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -4903,37 +2558,20 @@ ], 'DescribeTaskDetail' => [ 'summary' => 'Query the configuration details of a specified task', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID for site monitoring, which is the unique identifier of the task', - 'type' => 'string', - 'required' => true, - 'example' => '339e0d96-2505-425f-a5c6-22e2c12f8fee', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The task ID for site monitoring, which is the unique identifier of the task', 'type' => 'string', 'required' => true, 'example' => '339e0d96-2505-425f-a5c6-22e2c12f8fee', 'docRequired' => true], ], ], 'responses' => [ @@ -4941,59 +2579,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Error message', - 'type' => 'string', - 'example' => '请求成功', - ], - 'Data' => [ - 'description' => 'Response information', - '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' => 'Request ID, used for troubleshooting', - 'type' => 'string', - 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1', - ], - 'Success' => [ - 'description' => 'Indicates whether this call was successful', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => '请求成功'], + 'Data' => ['description' => 'Response information', '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' => 'Request ID, used for troubleshooting', 'type' => 'string', 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1'], + 'Success' => ['description' => 'Indicates whether this call was successful', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], 615 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'Task Id does not exist', - ], + ['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":""}]', @@ -5003,77 +2609,40 @@ ], 'DescribeTasks' => [ 'summary' => 'DescribeTasks', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '18b0c27f-bab3-441d-a747-9cdcaa8bbac8', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '18b0c27f-bab3-441d-a747-9cdcaa8bbac8'], ], [ 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -5081,108 +2650,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => '', - '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', - ], + 'Data' => ['description' => '', 'type' => 'string', 'example' => ''], + 'RequestId' => ['description' => '', '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.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['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":""}]', ], 'DisableAlarm' => [ 'summary' => 'DisableAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde'], ], ], 'responses' => [ @@ -5190,58 +2698,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DEF01F10-E747-42FE-9152-85CB43B1B552', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'DEF01F10-E747-42FE-9152-85CB43B1B552'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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":"\\n CF9F20A2-D4CF-4FA0-B8A3-1F4C151B3C91\\n true\\n 200\\n","errorExample":"\\n CF9F20A2-D4CF-4FA0-B8A3-1F4C151B3C91\\n true\\n 200\\n"}]', @@ -5249,37 +2726,20 @@ ], 'EnableAlarm' => [ 'summary' => 'EnableAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde'], ], ], 'responses' => [ @@ -5287,58 +2747,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1C5E0E5D-76D5-469C-9FA8-D74799B24860', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '1C5E0E5D-76D5-469C-9FA8-D74799B24860'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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":"\\n 1B77FA9C-4E5A-4DF9-82CB-0E898C9FDA2F\\n true\\n 200\\n","errorExample":"\\n 1B77FA9C-4E5A-4DF9-82CB-0E898C9FDA2F\\n true\\n 200\\n"}]', @@ -5346,35 +2775,20 @@ ], 'GetContacts' => [ 'summary' => 'Get Contacts', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'Alarm contact group name.', - 'type' => 'string', - 'required' => true, - 'example' => 'rabb', - ], + 'schema' => ['description' => 'Alarm contact group name.', 'type' => 'string', 'required' => true, 'example' => 'rabb'], ], ], 'responses' => [ @@ -5382,44 +2796,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => 'Status code. Note: 200 indicates success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for troubleshooting.', - 'type' => 'string', - 'example' => 'FF66C10B-AA35-58FD-BD30-8CE1B275BA44', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - .'* true: Success.'."\n" - .'* false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => 'Status code. Note: 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => 'Request ID, used for troubleshooting.', 'type' => 'string', 'example' => 'FF66C10B-AA35-58FD-BD30-8CE1B275BA44'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + .'* true: Success.'."\n" + .'* false: Failure.', 'type' => 'boolean', 'example' => 'true'], 'Datapoints' => [ 'description' => 'Data points.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Name.', - 'type' => 'string', - 'example' => 'rabb', - ], + 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'rabb'], 'Contacts' => [ 'type' => 'object', 'itemNode' => true, @@ -5427,11 +2815,7 @@ 'Contact' => [ 'description' => 'Contact list', 'type' => 'array', - 'items' => [ - 'description' => 'Contact.', - 'type' => 'string', - 'example' => '188xxxx7155', - ], + 'items' => ['description' => 'Contact.', 'type' => 'string', 'example' => '188xxxx7155'], ], ], ], @@ -5443,28 +2827,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -5473,45 +2845,25 @@ ], 'GetMonitoringTemplate' => [ 'summary' => 'Get Monitoring Template', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring template name.', - 'type' => 'string', - 'required' => false, - 'example' => 'ft20180308_templateNameFail', - ], + 'schema' => ['description' => 'Monitoring template name.', 'type' => 'string', 'required' => false, 'example' => 'ft20180308_templateNameFail'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring template ID.', - 'type' => 'string', - 'required' => false, - 'example' => '2203505', - ], + 'schema' => ['description' => 'Monitoring template ID.', 'type' => 'string', 'required' => false, 'example' => '2203505'], ], ], 'responses' => [ @@ -5519,80 +2871,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'InstanceIds is mandatory for this action.', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '578B4400-4EF1-5A73-90A1-2EDE29B781AD', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Status code, 200 indicates success, any other value indicates failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '578B4400-4EF1-5A73-90A1-2EDE29B781AD'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Status code, 200 indicates success, any other value indicates failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Resource' => [ 'description' => 'Template resource information', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'Template description.', - 'type' => 'string', - 'example' => 'ECS模板', - ], - 'SystemEventTemplates' => [ - 'description' => 'System event templates.', - 'type' => 'string', - 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]', - ], - 'AlertTemplatesJson' => [ - 'description' => 'Alert templates.', - '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' => 'Template namespace, with the same semantics as the namespace exposed by the metric master.', - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'ProcessMonitorTemplates' => [ - 'description' => 'Process monitoring templates', - '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' => 'Host availability templates', - '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' => 'Data version number', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => 'Template name', - 'type' => 'string', - 'example' => 'ECS_Template1', - ], - 'Id' => [ - 'description' => 'Template ID', - 'type' => 'string', - 'example' => '123', - ], + 'Description' => ['description' => 'Template description.', 'type' => 'string', 'example' => 'ECS模板'], + 'SystemEventTemplates' => ['description' => 'System event templates.', 'type' => 'string', 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]'], + 'AlertTemplatesJson' => ['description' => 'Alert templates.', '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' => 'Template namespace, with the same semantics as the namespace exposed by the metric master.', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], + 'ProcessMonitorTemplates' => ['description' => 'Process monitoring templates', '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' => 'Host availability templates', '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' => 'Data version number', 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => 'Template name', 'type' => 'string', 'example' => 'ECS_Template1'], + 'Id' => ['description' => 'Template ID', 'type' => 'string', 'example' => '123'], ], ], ], @@ -5601,28 +2900,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -5631,89 +2918,47 @@ ], 'GetMyGroups' => [ 'summary' => 'Get Personal Application Groups', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '239765766', - ], + 'schema' => ['description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '239765766'], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group type. Values:'."\n" - .'- custom: Custom-built application group.'."\n" - .'- ehpc_cluster: Application group synchronized from an EHPC cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - ], + 'schema' => ['description' => 'Application group type. Values:'."\n" + .'- custom: Custom-built application group.'."\n" + .'- ehpc_cluster: Application group synchronized from an EHPC cluster.', 'type' => 'string', 'required' => false, 'example' => 'custom'], ], [ 'name' => 'SelectContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to return the alarm contact groups. Values: -true: Yes. -false (default): No.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Whether to return the alarm contact groups. Values: -true: Yes. -false (default): No.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'i-hp3hl3cx1pbahzy8****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-hp3hl3cx1pbahzy8****'], ], [ 'name' => 'BindUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'Binding URL', - 'type' => 'string', - 'required' => false, - 'example' => 'ehpc://i-dadfasdf/Login', - ], + 'schema' => ['description' => 'Binding URL', 'type' => 'string', 'required' => false, 'example' => 'ehpc://i-dadfasdf/Login'], ], [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group name.', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'Application group name.', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], ], 'responses' => [ @@ -5721,64 +2966,25 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ECA294F7-7408-5069-B260-4896967D5131', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code. 200 indicates success, other values indicate failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'ECA294F7-7408-5069-B260-4896967D5131'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code. 200 indicates success, other values indicate failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Group' => [ 'description' => 'Application group information.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'Application group type. Values:'."\n" - .'- custom: Custom-built application group.'."\n" - .'- ehpc_cluster: Application group synchronized from an EHPC cluster.', - 'type' => 'string', - 'example' => 'custom', - ], - 'BindUrl' => [ - 'description' => 'Binding URL', - 'type' => 'string', - 'example' => 'ehpc://i-dadfasdf/Login', - ], - 'GroupName' => [ - 'description' => 'Application group name.', - 'type' => 'string', - 'example' => 'ECS_test', - ], - 'GroupId' => [ - 'description' => 'Application group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '58789173', - ], - 'ServiceId' => [ - 'description' => 'Service ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'eds', - ], + 'Type' => ['description' => 'Application group type. Values:'."\n" + .'- custom: Custom-built application group.'."\n" + .'- ehpc_cluster: Application group synchronized from an EHPC cluster.', 'type' => 'string', 'example' => 'custom'], + 'BindUrl' => ['description' => 'Binding URL', 'type' => 'string', 'example' => 'ehpc://i-dadfasdf/Login'], + 'GroupName' => ['description' => 'Application group name.', 'type' => 'string', 'example' => 'ECS_test'], + 'GroupId' => ['description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '58789173'], + 'ServiceId' => ['description' => 'Service ID', 'type' => 'integer', 'format' => 'int64', 'example' => 'eds'], 'ContactGroups' => [ 'type' => 'object', 'itemNode' => true, @@ -5790,11 +2996,7 @@ 'description' => 'Alarm contact groups.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Name of the alarm contact person.', - 'type' => 'string', - 'example' => 'name', - ], + 'Name' => ['description' => 'Name of the alarm contact person.', 'type' => 'string', 'example' => 'name'], ], ], ], @@ -5808,32 +3010,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], - [ - 'errorCode' => 'UniqueResult', - 'errorMessage' => 'The query condition does not return the only result.', - ], + ['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' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -5842,109 +3029,55 @@ ], 'ListAlarm' => [ 'summary' => 'ListAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard'], ], [ 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"instanceId":"XXX"}', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '{"instanceId":"XXX"}'], ], [ 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ok', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'ok'], ], [ 'name' => 'IsEnable', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - 'default' => '100', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '100'], ], ], 'responses' => [ @@ -5952,38 +3085,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EFD27F56-5799-4CE8-B625-56DF3332331C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '27', - ], + 'NextToken' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'EFD27F56-5799-4CE8-B625-56DF3332331C'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'Total' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '27'], 'AlarmList' => [ 'type' => 'object', 'itemNode' => true, @@ -5994,102 +3101,24 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SilenceTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'MetricName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CPUUtilization', - ], - 'EvaluationCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Webhook' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'State' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ok', - ], - 'ContactGroups' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Dimensions' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["{\\"instanceId\\":\\" i-abcdefgh123456\\"}"]', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'string', - 'example' => '90', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf', - ], - 'Enable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Statistics' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Average', - ], + 'SilenceTime' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '86400'], + 'MetricName' => ['description' => '', 'type' => 'string', 'example' => 'CPUUtilization'], + 'EvaluationCount' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'Webhook' => ['description' => '', 'type' => 'string', 'example' => 'null'], + 'State' => ['description' => '', 'type' => 'string', 'example' => 'ok'], + 'ContactGroups' => ['description' => '', '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' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Dimensions' => ['description' => '', 'type' => 'string', 'example' => '["{\\"instanceId\\":\\" i-abcdefgh123456\\"}"]'], + 'Name' => ['description' => '', 'type' => 'string', 'example' => ''], + 'Threshold' => ['description' => '', 'type' => 'string', 'example' => '90'], + 'Id' => ['description' => '', 'type' => 'string', 'example' => 'i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf'], + 'Enable' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], + 'Statistics' => ['description' => '', 'type' => 'string', 'example' => 'Average'], ], ], ], @@ -6101,32 +3130,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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":"\\n 2\\n CC2CDD2B-4EA5-43CD-BEE3-758E93C36B7F\\n \\n \\n 300\\n Average\\n ecs_cpu_total\\n cpu_total\\n OK\\n 90\\n true\\n 86400\\n 1\\n [\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]\\n acs_ecs_dashboard\\n [\\"test4nudou\\"]\\n putNewAlarm_group_e8da18b9-bc95-4edf-a8bf-159eb6c8286b\\n 24\\n 0\\n >=\\n \\n \\n 300\\n Average\\n ecs_diskusage_utilization\\n diskusage_utilization\\n OK\\n 90\\n true\\n 86400\\n 1\\n [\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]\\n acs_ecs_dashboard\\n [\\"test4nudou\\"]\\n putNewAlarm_group_3233eba5-0dd4-4e80-a5d5-7399dec3d7cc\\n 24\\n 0\\n >=\\n \\n \\n true\\n 200\\n 27","errorExample":"\\n 2\\n CC2CDD2B-4EA5-43CD-BEE3-758E93C36B7F\\n \\n \\n 300\\n Average\\n ecs_cpu_total\\n cpu_total\\n OK\\n 90\\n true\\n 86400\\n 1\\n [\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]\\n acs_ecs_dashboard\\n [\\"test4nudou\\"]\\n putNewAlarm_group_e8da18b9-bc95-4edf-a8bf-159eb6c8286b\\n 24\\n 0\\n >=\\n \\n \\n 300\\n Average\\n ecs_diskusage_utilization\\n diskusage_utilization\\n OK\\n 90\\n true\\n 86400\\n 1\\n [\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]\\n acs_ecs_dashboard\\n [\\"test4nudou\\"]\\n putNewAlarm_group_3233eba5-0dd4-4e80-a5d5-7399dec3d7cc\\n 24\\n 0\\n >=\\n \\n \\n true\\n 200\\n 27"}]', @@ -6134,76 +3148,40 @@ ], 'ListAlarmHistory' => [ 'summary' => 'ListAlarmHistory', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed'], ], [ 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1548913091223', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1548913091223'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1548927491223', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1548927491223'], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -6211,31 +3189,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Cursor' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1DBBCE29-0F69-435C-B65C-53D1011D1D72', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'Cursor' => ['description' => '', 'type' => 'string', 'example' => '1'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '1DBBCE29-0F69-435C-B65C-53D1011D1D72'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], 'AlarmHistoryList' => [ 'type' => 'object', 'itemNode' => true, @@ -6246,75 +3204,19 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'MetricName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CPUUtilization', - ], - 'EvaluationCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'State' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALARM', - ], - 'ContactGroups' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'Dimension' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed', - ], + 'Status' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'MetricName' => ['description' => '', 'type' => 'string', 'example' => 'CPUUtilization'], + 'EvaluationCount' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'State' => ['description' => '', 'type' => 'string', 'example' => 'ALARM'], + 'ContactGroups' => ['description' => '', 'type' => 'string', 'example' => ''], + 'Namespace' => ['description' => '', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], + 'Dimension' => ['description' => '', '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' => '', 'type' => 'string', 'example' => '1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed'], ], ], ], @@ -6326,32 +3228,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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":"\\n \\n \\n 2\\n {\\"Maximum\\":301,\\"Minimum\\":301}\\n http.status_groupbyinstanceid#60\\n ALARM\\n 122088\\n 1489568222088\\n acs_sitemonitor\\n null\\n 1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\n 3\\n \\n \\n 0\\n {\\"Maximum\\":301,\\"Minimum\\":301}\\n http.status_groupbyinstanceid#60\\n ALARM\\n 62078\\n 1489568162078\\n acs_sitemonitor\\n [\\"云账号报警联系人\\"]\\n 1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\n 3\\n \\n \\n 7E7A6173-EC07-43A1-ABBF-1F05EBB4C2BB\\n true\\n 200\\n","errorExample":"\\n \\n \\n 2\\n {\\"Maximum\\":301,\\"Minimum\\":301}\\n http.status_groupbyinstanceid#60\\n ALARM\\n 122088\\n 1489568222088\\n acs_sitemonitor\\n null\\n 1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\n 3\\n \\n \\n 0\\n {\\"Maximum\\":301,\\"Minimum\\":301}\\n http.status_groupbyinstanceid#60\\n ALARM\\n 62078\\n 1489568162078\\n acs_sitemonitor\\n [\\"云账号报警联系人\\"]\\n 1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\n 3\\n \\n \\n 7E7A6173-EC07-43A1-ABBF-1F05EBB4C2BB\\n true\\n 200\\n"}]', @@ -6359,49 +3246,25 @@ ], 'ListContactGroup' => [ 'summary' => 'List Contact Groups', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number. Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '100'], ], ], 'responses' => [ @@ -6409,42 +3272,16 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'Next page, an empty value indicates no more data.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for troubleshooting.', - 'type' => 'string', - 'example' => 'D3D03B0A-CF1A-4DAB-BF0D-D4B6ACD5677A', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'Status code. Note that 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'Total' => [ - 'description' => 'Total number of entries that meet the criteria.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'NextToken' => ['description' => 'Next page, an empty value indicates no more data.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'RequestId' => ['description' => 'Request ID, used for troubleshooting.', 'type' => 'string', 'example' => 'D3D03B0A-CF1A-4DAB-BF0D-D4B6ACD5677A'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => 'Status code. Note that 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], + 'Total' => ['description' => 'Total number of entries that meet the criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'ContactGroups' => [ 'type' => 'object', 'itemNode' => true, @@ -6452,11 +3289,7 @@ 'ContactGroup' => [ 'description' => 'List of alarm contact groups.', 'type' => 'array', - 'items' => [ - 'description' => 'Alarm contact group.', - 'type' => 'string', - 'example' => '云账号报警联系人', - ], + 'items' => ['description' => 'Alarm contact group.', 'type' => 'string', 'example' => '云账号报警联系人'], ], ], ], @@ -6466,38 +3299,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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', - ], + ['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"}]', @@ -6506,68 +3321,37 @@ ], 'ListEventRules' => [ 'summary' => 'Get Event Rule List', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'NamePrefix', 'in' => 'query', - 'schema' => [ - 'description' => 'Prefix of the event alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Prefix of the event alarm rule.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.'."\n" - ."\n" - .'Starting value: 1. Default value: 1.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number.'."\n" + ."\n" + .'Starting value: 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'required' => false, - 'example' => '239933048', - ], + 'schema' => ['description' => 'Group ID.', 'type' => 'string', 'required' => false, 'example' => '239933048'], ], ], 'responses' => [ @@ -6575,47 +3359,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'Next page, an empty value indicates no next page.', - 'type' => 'string', - 'example' => '2', - ], - 'CurrentPage' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'Request ID, used for troubleshooting.', - 'type' => 'string', - 'example' => 'fd54aeca-cfb1-4900-a417-3d30de11cbb9', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'Status code. Note: 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'Total' => [ - 'description' => 'Total number of data entries that meet the criteria.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '101', - ], + 'NextToken' => ['description' => 'Next page, an empty value indicates no next page.', 'type' => 'string', 'example' => '2'], + 'CurrentPage' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => 'Request ID, used for troubleshooting.', 'type' => 'string', 'example' => 'fd54aeca-cfb1-4900-a417-3d30de11cbb9'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => 'Status code. Note: 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], + 'Total' => ['description' => 'Total number of data entries that meet the criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '101'], 'Datapoints' => [ 'type' => 'object', 'itemNode' => true, @@ -6626,35 +3380,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'EventType' => [ - 'description' => 'Event type.', - 'type' => 'string', - 'example' => 'Exception', - ], - 'Description' => [ - 'description' => 'Description information.', - 'type' => 'string', - 'example' => 'helloworld', - ], - 'GroupId' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'example' => '239677374', - ], - 'Name' => [ - 'description' => 'Name of the event alarm rule.', - 'type' => 'string', - 'example' => 'test', - ], - 'State' => [ - 'description' => 'State of the event alarm rule. Values:'."\n" - ."\n" - .'- ENABLED: Enabled.'."\n" - ."\n" - .'- DISABLED: Disabled.', - 'type' => 'string', - 'example' => 'disabled', - ], + 'EventType' => ['description' => 'Event type.', 'type' => 'string', 'example' => 'Exception'], + 'Description' => ['description' => 'Description information.', 'type' => 'string', 'example' => 'helloworld'], + 'GroupId' => ['description' => 'Group ID.', 'type' => 'string', 'example' => '239677374'], + 'Name' => ['description' => 'Name of the event alarm rule.', 'type' => 'string', 'example' => 'test'], + 'State' => ['description' => 'State of the event alarm rule. Values:'."\n" + ."\n" + .'- ENABLED: Enabled.'."\n" + ."\n" + .'- DISABLED: Disabled.', 'type' => 'string', 'example' => 'disabled'], 'EventPattern' => [ 'type' => 'object', 'itemNode' => true, @@ -6666,11 +3400,7 @@ 'description' => 'Event alarm rule pattern.', 'type' => 'object', 'properties' => [ - 'Product' => [ - 'description' => 'Product name.', - 'type' => 'string', - 'example' => 'RDS', - ], + 'Product' => ['description' => 'Product name.', 'type' => 'string', 'example' => 'RDS'], 'EventTypeList' => [ 'type' => 'object', 'itemNode' => true, @@ -6678,11 +3408,7 @@ 'EventTypeList' => [ 'description' => 'List of event alarm types.', 'type' => 'array', - 'items' => [ - 'description' => 'Event alarm type.', - 'type' => 'string', - 'example' => 'Alert', - ], + 'items' => ['description' => 'Event alarm type.', 'type' => 'string', 'example' => 'Alert'], ], ], ], @@ -6693,17 +3419,13 @@ 'LevelList' => [ 'description' => 'List of event alarm rule levels.', 'type' => 'array', - 'items' => [ - 'description' => 'The level of the event. Possible values:'."\n" - ."\n" - .'- CRITICAL: Critical.'."\n" - ."\n" - .'- WARN: Warning.'."\n" - ."\n" - .'- INFO: Information.', - 'type' => 'string', - 'example' => 'CRITICAL', - ], + 'items' => ['description' => 'The level of the event. Possible values:'."\n" + ."\n" + .'- CRITICAL: Critical.'."\n" + ."\n" + .'- WARN: Warning.'."\n" + ."\n" + .'- INFO: Information.', 'type' => 'string', 'example' => 'CRITICAL'], ], ], ], @@ -6714,11 +3436,7 @@ 'StatusList' => [ 'description' => 'A list of event statuses.', 'type' => 'array', - 'items' => [ - 'description' => 'The status of the event.', - 'type' => 'string', - 'example' => '[]', - ], + 'items' => ['description' => 'The status of the event.', 'type' => 'string', 'example' => '[]'], ], ], ], @@ -6729,11 +3447,7 @@ 'NameList' => [ 'description' => 'A list of event names.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the event.', - 'type' => 'string', - 'example' => 'Instance:LiveMigrationAcrossDDH', - ], + 'items' => ['description' => 'The name of the event.', 'type' => 'string', 'example' => 'Instance:LiveMigrationAcrossDDH'], ], ], ], @@ -6753,32 +3467,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'ResourceNotFound', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'ResourceNotFound'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -6787,98 +3486,50 @@ ], 'ListMyGroupInstances' => [ 'summary' => 'List My Group Instances', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Total', 'in' => 'query', - 'schema' => [ - 'description' => 'Total number of records.', - 'type' => 'boolean', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'Total number of records.', 'type' => 'boolean', 'required' => false, 'example' => '100'], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '4728420', - ], + 'schema' => ['description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '4728420'], ], [ 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'Category', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'Category', 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'Search keyword.', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'Search keyword.', 'type' => 'string', 'required' => false, 'example' => 'aliyun'], ], [ 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID list', - 'type' => 'string', - 'required' => false, - 'example' => 'i-hp3dunahluwajv6f****', - ], + 'schema' => ['description' => 'Instance ID list', 'type' => 'string', 'required' => false, 'example' => 'i-hp3dunahluwajv6f****'], ], ], 'responses' => [ @@ -6886,45 +3537,13 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '1B43E02C-8794-5E8A-9F8C-3874DF7AF03F', - ], - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'InstanceIds is mandatory for this action.', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. `true` for success, `false` for failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code for failed requests. 200 indicates success, non-200 indicates failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'PageNumber' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1B43E02C-8794-5E8A-9F8C-3874DF7AF03F'], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'], + 'Success' => ['description' => 'Indicates whether the operation was successful. `true` for success, `false` for failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code for failed requests. 200 indicates success, non-200 indicates failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'Resources' => [ 'type' => 'object', 'itemNode' => true, @@ -6936,38 +3555,12 @@ 'description' => 'Resource object', 'type' => 'object', 'properties' => [ - 'InstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'example' => 'teacher-redis-online', - ], - 'AliUid' => [ - 'description' => 'Aliyun account ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Category' => [ - 'description' => 'Category', - 'type' => 'string', - 'example' => 'ecs', - ], - 'InstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rm-bp1e012cy94o85355', - ], - 'Id' => [ - 'description' => 'Resource ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RegionId' => [ - 'description' => 'Region ID of the instance.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'InstanceName' => ['description' => 'Instance name.', 'type' => 'string', 'example' => 'teacher-redis-online'], + 'AliUid' => ['description' => 'Aliyun account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Category' => ['description' => 'Category', 'type' => 'string', 'example' => 'ecs'], + 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'rm-bp1e012cy94o85355'], + 'Id' => ['description' => 'Resource ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'RegionId' => ['description' => 'Region ID of the instance.', 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], @@ -6979,28 +3572,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -7009,109 +3590,57 @@ ], 'ListMyGroups' => [ 'summary' => 'List Personal Application Groups', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group type. Values:'."\n" - .'- custom: Self-built application group.'."\n" - .'- ehpc_cluster: Application group synchronized from EHPC cluster.', - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - ], + 'schema' => ['description' => 'Application group type. Values:'."\n" + .'- custom: Self-built application group.'."\n" + .'- ehpc_cluster: Application group synchronized from EHPC cluster.', 'type' => 'string', 'required' => false, 'example' => 'custom'], ], [ 'name' => 'SelectContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to return the alarm contact group. Values: -true: Yes. -false (default): No.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Whether to return the alarm contact group. Values: -true: Yes. -false (default): No.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'Search keyword.', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'Search keyword.', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'i-m5e0k0bexac8tykr****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-m5e0k0bexac8tykr****'], ], [ 'name' => 'BindUrls', 'in' => 'query', - 'schema' => [ - 'description' => 'Bind URL', - 'type' => 'string', - 'required' => false, - 'example' => 'ehpc://i-dadfasdf/Login', - ], + 'schema' => ['description' => 'Bind URL', 'type' => 'string', 'required' => false, 'example' => 'ehpc://i-dadfasdf/Login'], ], [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group name.', - 'type' => 'string', - 'required' => false, - 'example' => 'fc_monitor_group_2018_ctNameFail', - ], + 'schema' => ['description' => 'Application group name.', 'type' => 'string', 'required' => false, 'example' => 'fc_monitor_group_2018_ctNameFail'], ], ], 'responses' => [ @@ -7119,49 +3648,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '996A6748-2F6F-561F-971A-BB5928B24F3C', - ], - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'InstanceIds is mandatory for this action.', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code. 200 indicates success, other values indicate failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '996A6748-2F6F-561F-971A-BB5928B24F3C'], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code. 200 indicates success, other values indicate failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'PageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'Resources' => [ 'type' => 'object', 'itemNode' => true, @@ -7173,51 +3670,16 @@ 'description' => 'List of personal application groups', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'Application group type. Values:'."\n" - .'- custom: Self-built application group.'."\n" - .'- ehpc_cluster: Application group synchronized from EHPC cluster.', - 'type' => 'string', - 'example' => 'custom', - ], - 'BindUrl' => [ - 'description' => 'Bind URL', - 'type' => 'string', - 'example' => 'ehpc://i-dadfasdf/Login', - ], - 'GroupId' => [ - 'description' => 'Application group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '236889260', - ], - 'GroupName' => [ - 'description' => 'Application group name.', - 'type' => 'string', - 'example' => 'monitor_group_2018_metric_rulebemd', - ], - 'BindUrls' => [ - 'description' => 'Bind URL', - 'type' => 'string', - 'example' => '["ehpc://i-dadfasdf/Login"]', - ], - 'ServiceId' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'example' => 'service-9b7395c020ae4e16825d', - ], - 'GmtCreate' => [ - 'description' => 'Time when the application group was created.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2017-08-09 16:09:41', - ], - 'GmtModified' => [ - 'description' => 'Modification time', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2017-08-09 16:09:41', - ], + 'Type' => ['description' => 'Application group type. Values:'."\n" + .'- custom: Self-built application group.'."\n" + .'- ehpc_cluster: Application group synchronized from EHPC cluster.', 'type' => 'string', 'example' => 'custom'], + 'BindUrl' => ['description' => 'Bind URL', 'type' => 'string', 'example' => 'ehpc://i-dadfasdf/Login'], + 'GroupId' => ['description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '236889260'], + 'GroupName' => ['description' => 'Application group name.', 'type' => 'string', 'example' => 'monitor_group_2018_metric_rulebemd'], + 'BindUrls' => ['description' => 'Bind URL', 'type' => 'string', 'example' => '["ehpc://i-dadfasdf/Login"]'], + 'ServiceId' => ['description' => 'Service ID', 'type' => 'string', 'example' => 'service-9b7395c020ae4e16825d'], + 'GmtCreate' => ['description' => 'Time when the application group was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '2017-08-09 16:09:41'], + 'GmtModified' => ['description' => 'Modification time', 'type' => 'integer', 'format' => 'int64', 'example' => '2017-08-09 16:09:41'], 'ContactGroups' => [ 'type' => 'object', 'itemNode' => true, @@ -7228,11 +3690,7 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the alarm contact group.', - 'type' => 'string', - 'example' => 'contact_group_01', - ], + 'Name' => ['description' => 'The name of the alarm contact group.', 'type' => 'string', 'example' => 'contact_group_01'], ], ], ], @@ -7249,28 +3707,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -7279,133 +3725,71 @@ ], 'ModifyTask' => [ 'summary' => 'Modify task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'Address.', - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], + 'schema' => ['description' => 'Address.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com'], ], [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8f880e3d-d924-47ab-84d2-fa1a72e24211', - ], + 'schema' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8f880e3d-d924-47ab-84d2-fa1a72e24211'], ], [ 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The task name.', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyunTest', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'aliyunTest'], ], [ 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which detection requests are sent.'."\n" - ."\n" - .'Valid values: 1, 5, 15, 30, and 60. Unit: minutes.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The interval at which detection requests are sent.'."\n" + ."\n" + .'Valid values: 1, 5, 15, 30, and 60. Unit: minutes.'."\n" + ."\n" + .'Default value: 1.'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'IspCity', 'in' => 'query', - 'schema' => [ - 'description' => 'isp city.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], + 'schema' => ['description' => 'isp city.', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]'], ], [ 'name' => 'Options', 'in' => 'query', - 'schema' => [ - 'description' => 'The options.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"dns_type\\":\\"A\\",\\"expect_value\\":\\"171.222.205.250\\",\\"match_rule\\":\\"DNS_IN\\"}', - ], + 'schema' => ['description' => 'The options.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"dns_type\\":\\"A\\",\\"expect_value\\":\\"171.222.205.250\\",\\"match_rule\\":\\"DNS_IN\\"}'], ], [ 'name' => 'AlertRule', 'in' => 'query', - 'schema' => [ - 'description' => 'The details of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => ' [{"alarmActions":"xxx","metricName":"Availability","expression":"$Availability<96"}]', - ], + 'schema' => ['description' => 'The details of the alert rule.'."\n", 'type' => 'string', 'required' => false, 'example' => ' [{"alarmActions":"xxx","metricName":"Availability","expression":"$Availability<96"}]'], ], [ 'name' => 'AlertIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.', - 'type' => 'string', - 'required' => false, - 'example' => '5e9b-4c12-b39e-7f277ac44b11', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => false, 'example' => '5e9b-4c12-b39e-7f277ac44b11'], ], [ 'name' => 'caller', 'in' => 'query', - 'schema' => [ - 'description' => 'caller.', - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'caller.', 'type' => 'string', 'required' => false, 'example' => 'cms'], ], [ 'name' => 'IntervalUnit', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the metric.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ms', - ], + 'schema' => ['description' => 'The unit of the metric.'."\n" + ."\n" + .'Unit: milliseconds.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ms'], ], ], 'responses' => [ @@ -7413,116 +3797,57 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successfull', - ], - 'Data' => [ - 'description' => 'The returned data.', - 'type' => 'string', - 'example' => '{"count":1}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successfull'], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '{"count":1}'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'], ], 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], 600 => [ - [ - 'errorCode' => 'IllegalAddress', - 'errorMessage' => 'Illegal HTTP address', - ], + ['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address'], ], 605 => [ - [ - 'errorCode' => 'OperationError', - 'errorMessage' => 'Operation failed', - ], + ['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed'], ], 615 => [ - [ - 'errorCode' => 'TaskNotExists', - 'errorMessage' => 'Task does not exist', - ], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist'], ], 650 => [ - [ - 'errorCode' => 'OperatorInvalid', - 'errorMessage' => 'Operator invalid', - ], - [ - 'errorCode' => 'OperatorCityInvalid', - 'errorMessage' => 'Operator City invalid', - ], + ['errorCode' => 'OperatorInvalid', 'errorMessage' => 'Operator invalid'], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid'], ], 655 => [ - [ - 'errorCode' => 'OperatorCityInvalid', - 'errorMessage' => 'Operator City invalid', - ], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid'], ], 660 => [ - [ - 'errorCode' => 'NameRepeat', - 'errorMessage' => 'Task name repeat', - ], + ['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat'], ], 680 => [ - [ - 'errorCode' => 'CreateAlarmError', - 'errorMessage' => 'Create alarm error', - ], + ['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error'], ], 695 => [ - [ - 'errorCode' => 'NameNotExists', - 'errorMessage' => 'Task name not exists', - ], + ['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"}]', @@ -7530,100 +3855,60 @@ ], 'NodeList' => [ 'summary' => 'NodeList', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'KeyWord', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true], ], [ 'name' => 'HostName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'SerialNumbers', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'InstanceRegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -7631,35 +3916,14 @@ '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', - ], + '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, @@ -7669,49 +3933,20 @@ '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', - ], + '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'], ], ], ], @@ -7723,93 +3958,56 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'NodeProcessCreate' => [ 'summary' => 'NodeProcessCreate', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ProcessUser', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Command', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -7817,84 +4015,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'ErrorCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + '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.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'NodeProcesses' => [ 'summary' => 'NodeProcesses', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -7902,19 +4063,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'ErrorCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['type' => 'string'], + 'ErrorMessage' => ['type' => 'string'], + 'ErrorCode' => ['type' => 'integer', 'format' => 'int32'], + 'Success' => ['type' => 'boolean'], 'NodeProcesses' => [ 'type' => 'object', 'itemNode' => true, @@ -7924,25 +4076,12 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ProcessName' => [ - 'type' => 'string', - ], - 'Command' => [ - 'type' => 'string', - ], - 'ProcessUser' => [ - 'type' => 'string', - ], - 'InstanceId' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'ProcessName' => ['type' => 'string'], + 'Command' => ['type' => 'string'], + 'ProcessUser' => ['type' => 'string'], + 'InstanceId' => ['type' => 'string'], + 'Name' => ['type' => 'string'], + 'Id' => ['type' => 'integer', 'format' => 'int64'], ], ], ], @@ -7954,64 +4093,36 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'NodeStatusList' => [ 'summary' => 'NodeStatusList', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'i-abcdefgh123456,i-abcdefgh123457', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-abcdefgh123456,i-abcdefgh123457'], ], ], 'responses' => [ @@ -8019,27 +4130,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1BB8FE8E-9BBE-490F-82EC-BF70FB849D55', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InstanceIds is mandatory for this action.', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '1BB8FE8E-9BBE-490F-82EC-BF70FB849D55'], + 'ErrorMessage' => ['description' => '', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'], + 'ErrorCode' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], 'NodeStatusList' => [ 'type' => 'object', 'itemNode' => true, @@ -8050,21 +4144,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'running', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-abcdefgh123456', - ], - 'AutoInstall' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Status' => ['description' => '', 'type' => 'string', 'example' => 'running'], + 'InstanceId' => ['description' => '', 'type' => 'string', 'example' => 'i-abcdefgh123456'], + 'AutoInstall' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -8076,28 +4158,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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":"\\n \\n \\n running\\n i-abcdefgh123456\\n true\\n \\n \\n uninstalled\\n i-abcdefgh123457\\n true\\n \\n \\n true\\n 200\\n","errorExample":"\\n \\n \\n running\\n i-abcdefgh123456\\n true\\n \\n \\n uninstalled\\n i-abcdefgh123457\\n true\\n \\n \\n true\\n 200\\n"}]', @@ -8105,33 +4175,20 @@ ], 'NodeUninstall' => [ 'summary' => 'NodeUninstall', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -8139,87 +4196,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'ErrorCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['type' => 'string'], + 'ErrorMessage' => ['type' => 'string'], + 'ErrorCode' => ['type' => 'integer', 'format' => 'int32'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 412 => [ - [ - 'errorCode' => 'AgentStateError', - 'errorMessage' => 'Expected agent running state is stopped.', - ], + ['errorCode' => 'AgentStateError', 'errorMessage' => 'Expected agent running state is stopped.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'PutCustomMetric' => [ 'summary' => 'PutCustomMetric', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'MetricList', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -8227,84 +4246,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'PutEvent' => [ 'summary' => 'PutEvent', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'EventInfo', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -8312,98 +4294,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'PutEventRule' => [ 'summary' => 'Create or Modify Time-based Alarm Rules', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Name of the event alarm rule.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DBS_EVENT_RULE', - ], + 'schema' => ['description' => 'Name of the event alarm rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DBS_EVENT_RULE'], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Group ID.', - 'type' => 'string', - 'required' => false, - 'example' => '240992827', - ], + 'schema' => ['description' => 'Group ID.', 'type' => 'string', 'required' => false, 'example' => '240992827'], ], [ 'name' => 'EventType', @@ -8415,27 +4351,16 @@ .'- CUSTOM: Custom event.', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'SYSTEM' => 'SYSTEM', - 'CUSTOM' => 'CUSTOM', - ], + 'enumValueTitles' => ['SYSTEM' => 'SYSTEM', 'CUSTOM' => 'CUSTOM'], 'example' => 'SYSTEM', 'default' => 'SYSTEM', - 'enum' => [ - 'SYSTEM', - 'BUSSINESS', - ], + 'enum' => ['SYSTEM', 'BUSSINESS'], ], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'Description of the event alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => '事件报警测试', - ], + 'schema' => ['description' => 'Description of the event alarm rule.', 'type' => 'string', 'required' => false, 'example' => '事件报警测试'], ], [ 'name' => 'State', @@ -8447,10 +4372,7 @@ 'enumValueTitles' => [], 'example' => 'Enable', 'default' => 'ENABLED', - 'enum' => [ - 'ENABLED', - 'DISABLED', - ], + 'enum' => ['ENABLED', 'DISABLED'], ], ], [ @@ -8467,54 +4389,29 @@ 'EventTypeList' => [ 'description' => 'List of event types for the alarm rule.', 'type' => 'array', - 'items' => [ - 'description' => 'Type of the event alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'Alert', - ], + 'items' => ['description' => 'Type of the event alarm rule.', 'type' => 'string', 'required' => false, 'example' => 'Alert'], 'required' => false, 'maxItems' => 5, ], 'StatusList' => [ 'description' => 'List of statuses for the event alarm rule.', 'type' => 'array', - 'items' => [ - 'description' => 'Status of the event alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], + 'items' => ['description' => 'Status of the event alarm rule.', 'type' => 'string', 'required' => false, 'example' => '[]'], 'required' => false, 'maxItems' => 5, ], - 'Product' => [ - 'description' => 'Product.', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'Product' => ['description' => 'Product.', 'type' => 'string', 'required' => false, 'example' => 'ECS'], 'LevelList' => [ 'description' => 'List of levels for the event alarm rule.', 'type' => 'array', - 'items' => [ - 'description' => 'Level of the event alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', - ], + 'items' => ['description' => 'Level of the event alarm rule.', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL'], 'required' => false, 'maxItems' => 5, ], 'NameList' => [ 'description' => 'List of names for the event alarm rule.', 'type' => 'array', - 'items' => [ - 'description' => 'Name of the event alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'Agent_Status_Stopped', - ], + 'items' => ['description' => 'Name of the event alarm rule.', 'type' => 'string', 'required' => false, 'example' => 'Agent_Status_Stopped'], 'required' => false, 'maxItems' => 50, ], @@ -8531,56 +4428,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code. 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Response message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => 'Returned data.', - 'type' => 'string', - 'example' => '100', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code. 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => 'Returned data.', 'type' => 'string', 'example' => '100'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['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' => '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"}]', @@ -8589,38 +4457,20 @@ ], 'PutEventTargets' => [ 'summary' => 'Set Event Targets', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alarm rule.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DBS_EVENT_RULE', - ], + 'schema' => ['description' => 'The name of the alarm rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DBS_EVENT_RULE'], ], [ 'name' => 'FcParameters', @@ -8633,30 +4483,10 @@ 'description' => 'Parameters of the function.', 'type' => 'object', 'properties' => [ - 'FunctionName' => [ - 'description' => 'Function name.', - 'type' => 'string', - 'required' => false, - 'example' => 'fcTest1', - ], - 'Region' => [ - 'description' => 'Region corresponding to the function.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'ServiceName' => [ - 'description' => 'Service name.', - 'type' => 'string', - 'required' => false, - 'example' => 'service1', - ], - 'Id' => [ - 'description' => 'Entity ID', - 'type' => 'string', - 'required' => false, - 'example' => '1911729', - ], + 'FunctionName' => ['description' => 'Function name.', 'type' => 'string', 'required' => false, 'example' => 'fcTest1'], + 'Region' => ['description' => 'Region corresponding to the function.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'required' => false, 'example' => 'service1'], + 'Id' => ['description' => 'Entity ID', 'type' => 'string', 'required' => false, 'example' => '1911729'], ], 'required' => false, ], @@ -8675,24 +4505,9 @@ 'description' => 'Parameters of the alarm contact group.', 'type' => 'object', 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'Alarm contact group name.', - 'type' => 'string', - 'required' => false, - 'example' => '云账号报警联系人', - ], - 'Id' => [ - 'description' => 'ID.', - 'type' => 'string', - 'required' => false, - 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', - ], - 'Level' => [ - 'description' => 'Alarm level.', - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - ], + 'ContactGroupName' => ['description' => 'Alarm contact group name.', 'type' => 'string', 'required' => false, 'example' => '云账号报警联系人'], + 'Id' => ['description' => 'ID.', 'type' => 'string', 'required' => false, 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'], + 'Level' => ['description' => 'Alarm level.', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'], ], 'required' => false, ], @@ -8711,24 +4526,9 @@ 'description' => 'Lightweight message queue (formerly MNS) notification.', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'Queue' => [ - 'description' => 'Message queue.', - 'type' => 'string', - 'required' => false, - 'example' => 'testQueue', - ], - 'Id' => [ - 'description' => 'id', - 'type' => 'string', - 'required' => false, - 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', - ], + 'Region' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'Queue' => ['description' => 'Message queue.', 'type' => 'string', 'required' => false, 'example' => 'testQueue'], + 'Id' => ['description' => 'id', 'type' => 'string', 'required' => false, 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'], ], 'required' => false, ], @@ -8747,32 +4547,12 @@ 'description' => 'URL callback parameters.', 'type' => 'object', 'properties' => [ - 'Protocol' => [ - 'description' => 'Protocol type.', - 'type' => 'string', - 'required' => false, - 'example' => 'https', - ], - 'Url' => [ - 'description' => 'Callback URL.', - 'type' => 'string', - 'required' => false, - 'example' => 'http://alert.xxxxxxx.com:8080/callback', - ], - 'Method' => [ - 'description' => 'HTTP callback request method.'."\n" - ."\n" - .'Supports GET and POST.', - 'type' => 'string', - 'required' => false, - 'example' => 'POST', - ], - 'Id' => [ - 'description' => 'ID.', - 'type' => 'string', - 'required' => false, - 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', - ], + 'Protocol' => ['description' => 'Protocol type.', 'type' => 'string', 'required' => false, 'example' => 'https'], + 'Url' => ['description' => 'Callback URL.', 'type' => 'string', 'required' => false, 'example' => 'http://alert.xxxxxxx.com:8080/callback'], + 'Method' => ['description' => 'HTTP callback request method.'."\n" + ."\n" + .'Supports GET and POST.', 'type' => 'string', 'required' => false, 'example' => 'POST'], + 'Id' => ['description' => 'ID.', 'type' => 'string', 'required' => false, 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'], ], 'required' => false, ], @@ -8791,30 +4571,10 @@ 'description' => 'SLS (Log Service) parameters.', 'type' => 'object', 'properties' => [ - 'LogStore' => [ - 'description' => 'Log store corresponding to the log service.', - 'type' => 'string', - 'required' => false, - 'example' => 'logstore_test', - ], - 'Region' => [ - 'description' => 'Region corresponding to the log service.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'Project' => [ - 'description' => 'Project corresponding to the log service.', - 'type' => 'string', - 'required' => false, - 'example' => 'sls-rdscustom-event', - ], - 'Id' => [ - 'description' => 'ID.', - 'type' => 'string', - 'required' => false, - 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', - ], + 'LogStore' => ['description' => 'Log store corresponding to the log service.', 'type' => 'string', 'required' => false, 'example' => 'logstore_test'], + 'Region' => ['description' => 'Region corresponding to the log service.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'Project' => ['description' => 'Project corresponding to the log service.', 'type' => 'string', 'required' => false, 'example' => 'sls-rdscustom-event'], + 'Id' => ['description' => 'ID.', 'type' => 'string', 'required' => false, 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'], ], 'required' => false, ], @@ -8828,40 +4588,16 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Unique identifier for the request, used for subsequent error troubleshooting.', - 'type' => 'string', - 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParameterCount' => [ - 'description' => 'Number of parameters.', - 'type' => 'string', - 'example' => '132', - ], - 'FailedParameterCount' => [ - 'description' => 'Count of failed parameters.', - 'type' => 'string', - 'example' => '2', - ], - 'Code' => [ - 'description' => 'Status code. Note: 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], + 'RequestId' => ['description' => 'Unique identifier for the request, used for subsequent error troubleshooting.', 'type' => 'string', 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ParameterCount' => ['description' => 'Number of parameters.', 'type' => 'string', 'example' => '132'], + 'FailedParameterCount' => ['description' => 'Count of failed parameters.', 'type' => 'string', 'example' => '2'], + 'Code' => ['description' => 'Status code. Note: 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], 'ContactParameters' => [ 'type' => 'object', 'itemNode' => true, @@ -8873,22 +4609,9 @@ 'description' => 'Alarm contact group parameter.', 'type' => 'object', 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'Name of the alarm contact group.', - 'type' => 'string', - 'example' => '云账号报警联系人', - ], - 'Id' => [ - 'description' => 'ID number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'ca66c5ae-8e46-445c-8ca9-7ccf10a0e183', - ], - 'Level' => [ - 'description' => 'Alarm level.', - 'type' => 'string', - 'example' => 'CRITICAL', - ], + 'ContactGroupName' => ['description' => 'Name of the alarm contact group.', 'type' => 'string', 'example' => '云账号报警联系人'], + 'Id' => ['description' => 'ID number.', 'type' => 'integer', 'format' => 'int32', 'example' => 'ca66c5ae-8e46-445c-8ca9-7ccf10a0e183'], + 'Level' => ['description' => 'Alarm level.', 'type' => 'string', 'example' => 'CRITICAL'], ], ], ], @@ -8905,22 +4628,9 @@ 'description' => 'MNS parameter.', 'type' => 'object', 'properties' => [ - 'Queue' => [ - 'description' => 'Name of the lightweight message queue (formerly MNS).', - 'type' => 'string', - 'example' => 'spotmax-spot-interruption-notice', - ], - 'Id' => [ - 'description' => 'ID number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '91ace627-ed2c-4a35-8cd8-3a52b149c47e', - ], - 'Region' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'Queue' => ['description' => 'Name of the lightweight message queue (formerly MNS).', 'type' => 'string', 'example' => 'spotmax-spot-interruption-notice'], + 'Id' => ['description' => 'ID number.', 'type' => 'integer', 'format' => 'int32', 'example' => '91ace627-ed2c-4a35-8cd8-3a52b149c47e'], + 'Region' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], @@ -8937,27 +4647,10 @@ 'description' => 'Function service parameter.', 'type' => 'object', 'properties' => [ - 'ServiceName' => [ - 'description' => 'Service name of the function service.', - 'type' => 'string', - 'example' => 'esign-production-dba', - ], - 'FunctionName' => [ - 'description' => 'Function name.', - 'type' => 'string', - 'example' => 'cdn_waf', - ], - 'Id' => [ - 'description' => 'ID number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', - ], - 'Region' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'ServiceName' => ['description' => 'Service name of the function service.', 'type' => 'string', 'example' => 'esign-production-dba'], + 'FunctionName' => ['description' => 'Function name.', 'type' => 'string', 'example' => 'cdn_waf'], + 'Id' => ['description' => 'ID number.', 'type' => 'integer', 'format' => 'int32', 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'], + 'Region' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], @@ -8974,22 +4667,9 @@ 'description' => 'Failed alarm contact group parameter.', 'type' => 'object', 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'Name of the alarm contact group.', - 'type' => 'string', - 'example' => '云账号报警联系人', - ], - 'Id' => [ - 'description' => 'id', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', - ], - 'Level' => [ - 'description' => 'Alarm level.', - 'type' => 'string', - 'example' => 'CRITICAL', - ], + 'ContactGroupName' => ['description' => 'Name of the alarm contact group.', 'type' => 'string', 'example' => '云账号报警联系人'], + 'Id' => ['description' => 'id', 'type' => 'integer', 'format' => 'int32', 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'], + 'Level' => ['description' => 'Alarm level.', 'type' => 'string', 'example' => 'CRITICAL'], ], ], ], @@ -9006,22 +4686,9 @@ 'description' => 'Failed MNS parameter.', 'type' => 'object', 'properties' => [ - 'Queue' => [ - 'description' => 'Name of the lightweight message queue (formerly MNS).', - 'type' => 'string', - 'example' => 'spotmax-spot-interruption-notice', - ], - 'Id' => [ - 'description' => 'Code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'bc2cbb0f-c96b-45b7-81a1-b2356c232b79', - ], - 'Region' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'Queue' => ['description' => 'Name of the lightweight message queue (formerly MNS).', 'type' => 'string', 'example' => 'spotmax-spot-interruption-notice'], + 'Id' => ['description' => 'Code.', 'type' => 'integer', 'format' => 'int32', 'example' => 'bc2cbb0f-c96b-45b7-81a1-b2356c232b79'], + 'Region' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], @@ -9038,27 +4705,10 @@ 'description' => 'Failed function service parameter.', 'type' => 'object', 'properties' => [ - 'ServiceName' => [ - 'description' => 'Service name of the function service.', - 'type' => 'string', - 'example' => 'esign-production-dba', - ], - 'FunctionName' => [ - 'description' => 'Function name.', - 'type' => 'string', - 'example' => 'dba-alert-severity', - ], - 'Id' => [ - 'description' => 'Code ID.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '98c049b7-f8f5-4001-ac4c-be21fd6d38e6', - ], - 'Region' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'ServiceName' => ['description' => 'Service name of the function service.', 'type' => 'string', 'example' => 'esign-production-dba'], + 'FunctionName' => ['description' => 'Function name.', 'type' => 'string', 'example' => 'dba-alert-severity'], + 'Id' => ['description' => 'Code ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '98c049b7-f8f5-4001-ac4c-be21fd6d38e6'], + 'Region' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], @@ -9075,26 +4725,10 @@ 'description' => 'Failed SLS parameter.', 'type' => 'object', 'properties' => [ - 'Project' => [ - 'description' => 'Project corresponding to the log service.', - 'type' => 'string', - 'example' => 'acs_disk', - ], - 'LogStore' => [ - 'description' => 'Logstore corresponding to the log service.', - 'type' => 'string', - 'example' => 'alb_access_log', - ], - 'Id' => [ - 'description' => 'Code.', - 'type' => 'string', - 'example' => 'be96c43d-b680-4ac5-aa21-1465e477e98f', - ], - 'Region' => [ - 'description' => 'Region Id.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'Project' => ['description' => 'Project corresponding to the log service.', 'type' => 'string', 'example' => 'acs_disk'], + 'LogStore' => ['description' => 'Logstore corresponding to the log service.', 'type' => 'string', 'example' => 'alb_access_log'], + 'Id' => ['description' => 'Code.', 'type' => 'string', 'example' => 'be96c43d-b680-4ac5-aa21-1465e477e98f'], + 'Region' => ['description' => 'Region Id.', 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], @@ -9106,32 +4740,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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"}]', @@ -9140,44 +4759,25 @@ ], 'PutMetricRuleTargets' => [ 'summary' => 'PutMetricRuleTargets', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Actions', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Targets', @@ -9188,17 +4788,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'type' => 'string', - 'required' => false, - ], - 'Arn' => [ - 'type' => 'string', - 'required' => false, - ], - 'Level' => [ - 'type' => 'string', - ], + 'Id' => ['type' => 'string', 'required' => false], + 'Arn' => ['type' => 'string', 'required' => false], + 'Level' => ['type' => 'string'], ], ], 'required' => true, @@ -9211,18 +4803,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], 'FailData' => [ 'type' => 'object', 'properties' => [ @@ -9235,15 +4819,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'type' => 'string', - ], - 'Arn' => [ - 'type' => 'string', - ], - 'Level' => [ - 'type' => 'string', - ], + 'Id' => ['type' => 'string'], + 'Arn' => ['type' => 'string'], + 'Level' => ['type' => 'string'], ], ], ], @@ -9257,288 +4835,166 @@ ], 'errorCodes' => [ 200 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'PutResourceMetricRule' => [ 'summary' => 'PutResourceMetricRule', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Resources', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], [ 'name' => 'Webhook', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EffectiveInterval', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'NoEffectiveInterval', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'SilenceTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '86400', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '86400'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => '300', - ], + 'schema' => ['type' => 'string', 'required' => false, 'default' => '300'], ], [ 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EmailSubject', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Critical.Statistics', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Critical.ComparisonOperator', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Critical.Threshold', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Critical.Times', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Escalations.Warn.Statistics', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Warn.ComparisonOperator', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Warn.Threshold', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Warn.Times', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Escalations.Info.Statistics', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Info.ComparisonOperator', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Info.Threshold', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Escalations.Info.Times', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], ], 'responses' => [ @@ -9546,161 +5002,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 206 => [ - [ - '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'], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], ], 'responseDemo' => null, ], 'QueryCustomMetricList' => [ 'summary' => 'Query Custom Metric List', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group ID.', - 'type' => 'string', - 'required' => true, - 'example' => '24232', - ], + 'schema' => ['description' => 'Application group ID.', 'type' => 'string', 'required' => true, 'example' => '24232'], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'Name of the monitoring item.', - 'type' => 'string', - 'required' => false, - 'example' => 'GPUUtilization', - ], + 'schema' => ['description' => 'Name of the monitoring item.', 'type' => 'string', 'required' => false, 'example' => 'GPUUtilization'], ], [ 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => 'Dimension filter condition, for example, k1=v1&k2=v2.', - 'type' => 'string', - 'required' => false, - 'example' => 'sampleName1=value1&sampleName2=value2', - ], + 'schema' => ['description' => 'Dimension filter condition, for example, k1=v1&k2=v2.', 'type' => 'string', 'required' => false, 'example' => 'sampleName1=value1&sampleName2=value2'], ], [ 'name' => 'Md5', 'in' => 'query', - 'schema' => [ - 'description' => 'Unique value of project + groupId + metricName + dimension.', - 'type' => 'string', - 'required' => false, - 'example' => '97c25982d9745a231276bff27469****', - ], + 'schema' => ['description' => 'Unique value of project + groupId + metricName + dimension.', 'type' => 'string', 'required' => false, 'example' => '97c25982d9745a231276bff27469****'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number. Default value: 1.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size.', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Page size.', 'type' => 'string', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -9708,58 +5089,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code. Note: 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The unique identifier generated by Alibaba Cloud for this request.', - 'type' => 'string', - 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1', - ], - 'Result' => [ - 'description' => 'List of custom monitoring data.', - 'type' => 'string', - 'example' => '{\\"data\\":[],\\"param\\":{\\"metric\\":\\"{\\\\\\"groupId\\\\\\":242135xxx,\\\\\\"project\\\\\\":\\\\\\"acs_customMetric_1672753017899xxx\\\\\\",\\\\\\"status\\\\\\":1}\\",\\"service\\":\\"metric-center.aliyun-inc.com\\"}}', - ], + 'Code' => ['description' => 'Status code. Note: 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1'], + 'Result' => ['description' => 'List of custom monitoring data.', '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', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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"}]', @@ -9768,89 +5118,55 @@ ], 'QueryMetricData' => [ 'summary' => 'QueryMetricData', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -9858,154 +5174,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Datapoints' => [ - 'type' => 'string', - ], - 'Period' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Datapoints' => ['type' => 'string'], + 'Period' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryMetricTop' => [ 'summary' => 'QueryMetricTop', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'Metric', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Orderby', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'OrderDesc', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -10013,107 +5267,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Datapoints' => [ - 'type' => 'string', - ], - 'Period' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Datapoints' => ['type' => 'string'], + 'Period' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryProjectMeta' => [ 'summary' => 'Queries the list of time-series monitoring item products supported by cloud monitoring.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => 'Filter by labels, the format is `[{"name":"label name","value":"label value"},{"name":"label name","value":"label value"}]`​.'."\n" - .'Supported label names include product and groupFlag.'."\n" - .'The value of the product label is the English name of the product. '."\n" - .'The groupFlag indicates whether the product supports application grouping, with a value of true or false​ .', - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"name\\":\\"product\\",\\"value\\":\\"MongoDB\\"]', - ], + 'schema' => ['description' => 'Filter by labels, the format is `[{"name":"label name","value":"label value"},{"name":"label name","value":"label value"}]`​.'."\n" + .'Supported label names include product and groupFlag.'."\n" + .'The value of the product label is the English name of the product. '."\n" + .'The groupFlag indicates whether the product supports application grouping, with a value of true or false​ .', 'type' => 'string', 'required' => false, 'example' => '[{\\"name\\":\\"product\\",\\"value\\":\\"MongoDB\\"]'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter, default is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Pagination parameter, default is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Maximum number of items per page, default is 30.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'Maximum number of items per page, default is 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], ], 'responses' => [ @@ -10121,26 +5328,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'Used for tracking.', - 'type' => 'string', - 'example' => 'D3DBF9F5-7C4D-4A67-B869-097C069C481D', - ], - 'Success' => [ - 'description' => 'Indicates whether this call was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => 'Used for tracking.', 'type' => 'string', 'example' => 'D3DBF9F5-7C4D-4A67-B869-097C069C481D'], + 'Success' => ['description' => 'Indicates whether this call was successful.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code 200 indicates success.', 'type' => 'string', 'example' => '200'], 'Resources' => [ 'type' => 'object', 'itemNode' => true, @@ -10151,27 +5342,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Project' => [ - 'description' => 'The Project of the monitoring item, used for querying monitoring data.', - 'type' => 'string', - 'example' => 'acs_mongodb', - ], - 'Description' => [ - 'description' => 'Description of the monitoring item.', - 'type' => 'string', - 'example' => 'ApsaraDB for MongoDB', - ], - 'Labels' => [ - 'description' => '`[{"name":"label name","value":"label value"},{"name":"label name","value":"label value"}]`'."\n" - ."\n" - .'Supported label names include product and groupFlag.'."\n" - ."\n" - .'The value of the product label is the English name of the product.'."\n" - ."\n" - .'groupFlag indicates whether the product supports application grouping, with a value of true or false.', - 'type' => 'string', - 'example' => '[{\\"name\\":\\"product\\",\\"value\\":\\"MongoDB\\"]', - ], + 'Project' => ['description' => 'The Project of the monitoring item, used for querying monitoring data.', 'type' => 'string', 'example' => 'acs_mongodb'], + 'Description' => ['description' => 'Description of the monitoring item.', 'type' => 'string', 'example' => 'ApsaraDB for MongoDB'], + 'Labels' => ['description' => '`[{"name":"label name","value":"label value"},{"name":"label name","value":"label value"}]`'."\n" + ."\n" + .'Supported label names include product and groupFlag.'."\n" + ."\n" + .'The value of the product label is the English name of the product.'."\n" + ."\n" + .'groupFlag indicates whether the product supports application grouping, with a value of true or false.', 'type' => 'string', 'example' => '[{\\"name\\":\\"product\\",\\"value\\":\\"MongoDB\\"]'], ], ], ], @@ -10183,28 +5362,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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":"\\n\\tD3DBF9F5-7C4D-4A67-B869-097C069C481D\\n\\t200\\n\\ttrue\\n\\t\\n\\t\\t\\n\\t\\t\\tAnalyticDB\\n\\t\\t\\t[{"name":"product","value":"ADS"},{"name":"groupFlag","value":"true"}]\\n\\t\\t\\tacs_ads\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tAPI Gateway\\n\\t\\t\\t[{"name":"product","value":"APIGateway"},{"name":"groupFlag","value":"true"}]\\n\\t\\t\\tacs_apigateway_dashboard\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tInternet Shared Bandwidth\\n\\t\\t\\t[{"name":"product","value":"InternetSharedBandwidth"},{"name":"groupFlag","value":"true"}]\\n\\t\\t\\tacs_bandwidth_package\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCDN\\n\\t\\t\\t[{"name":"product","value":"CDN"},{"name":"groupFlag","value":"true"}]\\n\\t\\t\\tacs_cdn\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCloud Enterprise Network\\n\\t\\t\\t[{"name":"product","value":"CEN"},{"name":"groupFlag","value":"false"}]\\n\\t\\t\\tacs_cen\\n\\t\\t\\n\\t\\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}"}]', @@ -10217,45 +5384,25 @@ ], 'QueryStaticsAvailability' => [ 'summary' => 'Query Static Availability', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'Availability monitoring task ID.', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'Availability monitoring task ID.', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ 'name' => 'TimeRange', 'in' => 'query', - 'schema' => [ - 'description' => 'Statistical period.', - 'type' => 'string', - 'required' => false, - 'example' => '1440', - ], + 'schema' => ['description' => 'Statistical period.', 'type' => 'string', 'required' => false, 'example' => '1440'], ], ], 'responses' => [ @@ -10263,58 +5410,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code.'."\n" - .'>200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'Data' => [ - 'description' => 'Returned availability metric data.', - 'type' => 'string', - 'example' => '[]', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code.'."\n" + .'>200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'Success'], + 'Data' => ['description' => 'Returned availability metric data.', 'type' => 'string', 'example' => '[]'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['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"}]', @@ -10323,45 +5441,25 @@ ], 'QueryStaticsResponseTime' => [ 'summary' => 'Query Static Response Time', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'Task ID.', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'Task ID.', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ 'name' => 'TimeRange', 'in' => 'query', - 'schema' => [ - 'description' => 'Response time range.', - 'type' => 'string', - 'required' => false, - 'example' => '1440', - ], + 'schema' => ['description' => 'Response time range.', 'type' => 'string', 'required' => false, 'example' => '1440'], ], ], 'responses' => [ @@ -10369,58 +5467,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code.'."\n" - .'>200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'Data' => [ - 'description' => 'Return data.', - 'type' => 'string', - 'example' => '[]', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code.'."\n" + .'>200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.'], + 'Data' => ['description' => 'Return data.', 'type' => 'string', 'example' => '[]'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['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"}]', @@ -10429,35 +5498,20 @@ ], 'QuerySystemEventCount' => [ 'summary' => 'QuerySystemEventCount', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'QueryJson', 'in' => 'query', - 'schema' => [ - 'description' => 'Query conditions', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"timeEnd\\":1745461671353,\\"timeStart\\":1745375271353,\\"level\\":\\"WARN\\"}', - ], + 'schema' => ['description' => 'Query conditions', 'type' => 'string', 'required' => false, 'example' => '{\\"timeEnd\\":1745461671353,\\"timeStart\\":1745375271353,\\"level\\":\\"WARN\\"}'], ], ], 'responses' => [ @@ -10465,65 +5519,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code.'."\n" - ."\n" - .'> 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => '( (userId:5024495213896020) ) and ( (level:WARN) )', - ], - 'Data' => [ - 'description' => 'Returned data.', - 'type' => 'string', - 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]', - ], - 'RequestId' => [ - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', - 'type' => 'string', - 'example' => '282127F4-2F58-5DE6-88CE-B71BDD085E8B', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => '( (userId:5024495213896020) ) and ( (level:WARN) )'], + 'Data' => ['description' => 'Returned data.', 'type' => 'string', 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]'], + 'RequestId' => ['description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '282127F4-2F58-5DE6-88CE-B71BDD085E8B'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -10532,48 +5554,25 @@ ], 'QuerySystemEventDemo' => [ 'summary' => 'System Event Query Demo', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud service for the event.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ECS', - ], + 'schema' => ['description' => 'The name of the cloud service for the event.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS'], ], [ 'name' => 'EventName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the event.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Agent_Status_Stopped', - ], + 'schema' => ['description' => 'The name of the event.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent_Status_Stopped'], ], ], 'responses' => [ @@ -10581,61 +5580,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code. Note that 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => 'Returned data.', - 'type' => 'string', - 'example' => '{"count":1}', - ], - 'RequestId' => [ - 'description' => 'The ID of the request, used for locating logs and troubleshooting issues.', - 'type' => 'string', - 'example' => '90117AC0-01F8-562C-B8F3-17E4D81743AC', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful, with values: '."\n" - .'- `true`: Success'."\n" - .'- `false`: Failure', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code. Note that 200 indicates success.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => 'Returned data.', 'type' => 'string', 'example' => '{"count":1}'], + 'RequestId' => ['description' => 'The ID of the request, used for locating logs and troubleshooting issues.', 'type' => 'string', 'example' => '90117AC0-01F8-562C-B8F3-17E4D81743AC'], + 'Success' => ['description' => 'Indicates whether the operation was successful, with values: '."\n" + .'- `true`: Success'."\n" + .'- `false`: Failure', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -10644,82 +5611,43 @@ ], 'QueryTaskConfig' => [ 'summary' => 'Query Task Configuration', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Request failure status code, 200 indicates success, non-200 indicates failure.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'The request has failed due to a temporary failure of the server.', - ], - 'Data' => [ - 'description' => 'Returned data.', - 'type' => 'string', - 'example' => '[]', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'Request failure status code, 200 indicates success, non-200 indicates failure.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.'], + 'Data' => ['description' => 'Returned data.', 'type' => 'string', 'example' => '[]'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '68192f5d-0d45-4b98-9724-892813f86c71'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.'."\n", 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['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"}]', @@ -10728,92 +5656,55 @@ ], 'QueryTaskMonitorData' => [ 'summary' => 'QueryTaskMonitorData', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'metricName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Cursor', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], ], 'responses' => [ @@ -10821,125 +5712,65 @@ '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', - ], + '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', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['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.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'TaskConfigList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Application group ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '92****', - ], + 'schema' => ['description' => 'Application group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '92****'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'Monitoring task ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123****', - ], + 'schema' => ['description' => 'Monitoring task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123****'], ], [ 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'Task name.', - 'type' => 'string', - 'required' => false, - 'example' => 'task2', - ], + 'schema' => ['description' => 'Task name.', 'type' => 'string', 'required' => false, 'example' => 'task2'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -10947,55 +5778,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'MissingInstanceId', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'BF120AD5-7D14-5EF6-8118-E3C2BCF849E1', - ], - 'ErrorCode' => [ - 'description' => 'Request failure status code, 200 for success, non-200 for failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PageTotal' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'PageNumber' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'MissingInstanceId'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BF120AD5-7D14-5EF6-8118-E3C2BCF849E1'], + 'ErrorCode' => ['description' => 'Request failure status code, 200 for success, non-200 for failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'PageTotal' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'TaskList' => [ 'type' => 'object', 'itemNode' => true, @@ -11006,60 +5800,22 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TaskType' => [ - 'description' => 'Monitoring task type.', - 'type' => 'string', - 'example' => 'PING', - ], - 'JsonData' => [ - 'description' => 'Configuration information.', - 'type' => 'string', - 'example' => '[]', - ], - 'GroupName' => [ - 'description' => 'Application group name.', - 'type' => 'string', - 'example' => 'test-monitor-group-1758247893736-modified', - ], - 'GroupId' => [ - 'description' => 'Application group ID.'."\n" - ."\n" - .'For more information on how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123******', - ], - 'TaskName' => [ - 'description' => 'Monitoring task name.'."\n" - ."\n" - .'For more information on how to obtain the monitoring task ID, see [DescribeHybridMonitorTaskList](~~428624~~).', - 'type' => 'string', - 'example' => 'ft-task-20190101N***', - ], - 'Disabled' => [ - 'description' => 'Indicates whether the monitoring task is disabled. Values:'."\n" - .'- true: Disabled.'."\n" - ."\n" - .'- false: Enabled.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertConfig' => [ - 'description' => 'Alert configuration.', - 'type' => 'string', - 'example' => '[]', - ], - 'TaskScope' => [ - 'description' => 'Task detection scope.', - 'type' => 'string', - 'example' => '*', - ], - 'Id' => [ - 'description' => 'Task ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123***', - ], + 'TaskType' => ['description' => 'Monitoring task type.', 'type' => 'string', 'example' => 'PING'], + 'JsonData' => ['description' => 'Configuration information.', 'type' => 'string', 'example' => '[]'], + 'GroupName' => ['description' => 'Application group name.', 'type' => 'string', 'example' => 'test-monitor-group-1758247893736-modified'], + 'GroupId' => ['description' => 'Application group ID.'."\n" + ."\n" + .'For more information on how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '123******'], + 'TaskName' => ['description' => 'Monitoring task name.'."\n" + ."\n" + .'For more information on how to obtain the monitoring task ID, see [DescribeHybridMonitorTaskList](~~428624~~).', 'type' => 'string', 'example' => 'ft-task-20190101N***'], + 'Disabled' => ['description' => 'Indicates whether the monitoring task is disabled. Values:'."\n" + .'- true: Disabled.'."\n" + ."\n" + .'- false: Enabled.', 'type' => 'boolean', 'example' => 'true'], + 'AlertConfig' => ['description' => 'Alert configuration.', 'type' => 'string', 'example' => '[]'], + 'TaskScope' => ['description' => 'Task detection scope.', 'type' => 'string', 'example' => '*'], + 'Id' => ['description' => 'Task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123***'], 'InstanceList' => [ 'type' => 'object', 'itemNode' => true, @@ -11067,11 +5823,7 @@ 'String' => [ 'description' => 'Instance list.', 'type' => 'array', - 'items' => [ - 'description' => 'Instance list.', - 'type' => 'string', - 'example' => 'i-x12er****', - ], + 'items' => ['description' => 'Instance list.', 'type' => 'string', 'example' => 'i-x12er****'], ], ], ], @@ -11086,28 +5838,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -11117,176 +5857,85 @@ ], 'UpdateAlarm' => [ 'summary' => 'UpdateAlarm', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_modify', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'test_modify'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde'], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'], ], [ 'name' => 'Statistics', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'Average'], ], [ 'name' => 'ComparisonOperator', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '>', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '>'], ], [ 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '40'], ], [ 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '24', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'], ], [ 'name' => 'SilenceTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400'], ], [ 'name' => 'EvaluationCount', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], ], [ 'name' => 'NotifyType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Webhook', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.net.cn/example_callback.htm', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'http://www.net.cn/example_callback.htm'], ], [ 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -11294,58 +5943,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '945B9183-95C0-44FF-B30C-9ED37D44F6DC', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '945B9183-95C0-44FF-B30C-9ED37D44F6DC'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s'], ], [ - [ - '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.', - ], + ['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":"\\r\\n C08FADC4-CFDB-42F7-B9B8-0ED5391CD084\\r\\n true\\r\\n 200\\r\\n","errorExample":""}]', @@ -11353,107 +5971,55 @@ ], 'UpdateMonitoringTemplate' => [ 'summary' => 'Update Monitoring Template', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Template name.', - 'type' => 'string', - 'required' => false, - 'example' => '常用基础模板', - ], + 'schema' => ['description' => 'Template name.', 'type' => 'string', 'required' => false, 'example' => '常用基础模板'], ], [ 'name' => 'AlertTemplatesJson', 'in' => 'query', - 'schema' => [ - 'description' => 'Alert template.', - '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}}}]}', - ], + 'schema' => ['description' => 'Alert template.', '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' => 'Template description.', - 'type' => 'string', - 'required' => false, - 'example' => 'Description', - ], + 'schema' => ['description' => 'Template description.', 'type' => 'string', 'required' => false, 'example' => 'Description'], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'Template ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1097583', - ], + 'schema' => ['description' => 'Template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1097583'], ], [ 'name' => 'RestVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Data version number.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '9', - ], + 'schema' => ['description' => 'Data version number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9'], ], [ 'name' => 'SystemEventTemplates', 'in' => 'query', - 'schema' => [ - 'description' => 'System event template.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]', - ], + 'schema' => ['description' => 'System event template.', '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' => 'Process monitoring template.', - '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"}]', - ], + 'schema' => ['description' => 'Process monitoring template.', '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' => 'Availability monitoring template.', - '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"}]', - ], + 'schema' => ['description' => 'Availability monitoring template.', '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' => [ @@ -11461,65 +6027,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'Error message.', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '987CC16C-D1E4-5EB1-A1CD-27906161EFFA', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code, 200 indicates success, other values indicate failure.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '987CC16C-D1E4-5EB1-A1CD-27906161EFFA'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'Error code, 200 indicates success, other values indicate failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['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"}]', @@ -11528,13 +6062,8 @@ ], 'GetLogColumnTranslateResult' => [ 'summary' => '获取日期提取结果的翻译', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11542,26 +6071,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ColumnValue', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'TranslateConfig', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -11570,74 +6090,37 @@ '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', - ], + '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', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 429 => [ - [ - 'errorCode' => 'ResourceOverLimit', - 'errorMessage' => 'The resource has exceeded the limit. %s', - ], + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s'], ], ], ], 'GetLineSplitResult' => [ 'summary' => '获取行切分结果', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11645,53 +6128,32 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'SplitType', 'in' => 'query', - 'schema' => [ - 'title' => '切分类型', - 'type' => 'string', - 'example' => 'simple|regex', - ], + 'schema' => ['title' => '切分类型', 'type' => 'string', 'example' => 'simple|regex'], ], [ 'name' => 'Line', 'in' => 'query', - 'schema' => [ - 'title' => '需要提取的行', - 'type' => 'string', - ], + 'schema' => ['title' => '需要提取的行', 'type' => 'string'], ], [ 'name' => 'Prefix', 'in' => 'query', - 'schema' => [ - 'title' => '已经完成提取的部分', - 'type' => 'string', - ], + 'schema' => ['title' => '已经完成提取的部分', 'type' => 'string'], ], [ 'name' => 'SelectContent', 'in' => 'query', - 'schema' => [ - 'title' => '提取的内容', - 'type' => 'string', - ], + 'schema' => ['title' => '提取的内容', 'type' => 'string'], ], [ 'name' => 'Regex', 'in' => 'query', - 'schema' => [ - 'title' => '提取完成的正则表达式', - 'type' => 'string', - ], + 'schema' => ['title' => '提取完成的正则表达式', 'type' => 'string'], ], ], 'responses' => [ @@ -11700,48 +6162,22 @@ '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', - ], + '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', - ], + 'StartSplitSymbol' => ['type' => 'string'], + 'EndSplitSymbol' => ['type' => 'string'], + 'StartSplitSymbolIndex' => ['type' => 'integer', 'format' => 'int64'], + 'Regex' => ['type' => 'string'], + 'AdditionalRegex' => ['type' => 'string'], 'RegexSplitResult' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -11751,45 +6187,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'The parameter is missing or invalid. %s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'], ], 429 => [ - [ - 'errorCode' => 'ResourceOverLimit', - 'errorMessage' => 'The resource has exceeded the limit. %s', - ], + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s'], ], ], ], 'DeleteHybridDoubleWrite' => [ 'summary' => '删除双写配置', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11802,23 +6217,12 @@ [ 'name' => 'SourceUserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12706766********', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12706766********'], ], [ 'name' => 'SourceNamespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-source', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'test-source'], ], ], 'responses' => [ @@ -11828,76 +6232,36 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '6F815BDC-9063-5417-BA88-E1BBD84BAA1E', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '6F815BDC-9063-5417-BA88-E1BBD84BAA1E'], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'success'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'InvalidAuthorization.', - ], - [ - 'errorCode' => 'NotAuthSLR', - 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'InvalidAuthorization.'], + ['errorCode' => 'NotAuthSLR', 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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"}]', ], 'CreateHybridDoubleWrite' => [ 'summary' => '创建双写配置', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11910,44 +6274,22 @@ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-target', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'test-target'], ], [ 'name' => 'SourceUserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12706766********', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12706766********'], ], [ 'name' => 'SourceNamespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-source', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'test-source'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12706766********', - ], + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12706766********'], ], ], 'responses' => [ @@ -11957,75 +6299,36 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'FAAC3C5D-00BF-543A-9E08-FAAC3C5D', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'FAAC3C5D-00BF-543A-9E08-FAAC3C5D'], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'success'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'InvalidAuthorization.', - ], - [ - 'errorCode' => 'NotAuthSLR', - 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'InvalidAuthorization.'], + ['errorCode' => 'NotAuthSLR', 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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"}]', ], 'DescribeHybridDoubleWrite' => [ 'summary' => '查询本数据源被双写到哪里', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12037,36 +6340,22 @@ [ 'name' => 'SourceNamespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-source', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'test-source'], ], [ 'name' => 'SourceUserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12706766**********', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '12706766**********'], ], [ 'name' => 'TargetUserId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'TargetNamespace', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -12076,27 +6365,10 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F'], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'Success' => ['description' => '', 'type' => 'string', 'example' => 'true'], 'Result' => [ 'description' => '', 'type' => 'array', @@ -12104,28 +6376,10 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11234766**********', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-target', - ], - 'SourceUserId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12706766**********', - ], - 'SourceNamespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-source', - ], + 'UserId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '11234766**********'], + 'Namespace' => ['description' => '', 'type' => 'string', 'example' => 'test-target'], + 'SourceUserId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '12706766**********'], + 'SourceNamespace' => ['description' => '', 'type' => 'string', 'example' => 'test-source'], ], ], ], @@ -12135,200 +6389,66 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'InvalidAuthorization.', - ], - [ - 'errorCode' => 'NotAuthSLR', - 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'InvalidAuthorization.'], + ['errorCode' => 'NotAuthSLR', 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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"}]', ], ], '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', - ], + ['regionId' => 'cn-qingdao', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'metrics.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-hongkong', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'endpoint' => 'metrics.cn-zhongwei.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' => 'metrics.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' => 'ap-southeast-8', 'endpoint' => 'metrics.ap-southeast-8.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' => 'us-southeast-1', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com'], + ['regionId' => 'na-south-1', 'endpoint' => 'metrics.na-south-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'endpoint' => 'metrics.eu-central-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' => 'metrics.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'], + ['regionId' => 'cn-wulanchabu-gic-1', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com'], ], ]; diff --git a/data/en_us/cms/2019-01-01/api-docs.php b/data/en_us/cms/2019-01-01/api-docs.php index 9ec4475..eca5157 100644 --- a/data/en_us/cms/2019-01-01/api-docs.php +++ b/data/en_us/cms/2019-01-01/api-docs.php @@ -1,325 +1,119 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Cms', - 'version' => '2019-01-01', - ], + 'info' => ['style' => 'RPC', 'product' => 'Cms', 'version' => '2019-01-01'], 'directories' => [ [ - 'id' => 184857, - 'title' => 'Application groups', - 'type' => 'directory', 'children' => [ [ - 'id' => 59483, - 'title' => 'Manage application groups', + 'children' => ['CreateMonitorGroup', 'ModifyMonitorGroup', 'DeleteMonitorGroup', 'DescribeMonitorGroups', 'CreateMonitorGroupInstances', 'ModifyMonitorGroupInstances', 'DescribeMonitorGroupInstances', 'DescribeMonitorGroupDynamicRules', 'DescribeMonitorGroupInstanceAttribute', 'DeleteMonitorGroupDynamicRule', 'DeleteMonitorGroupInstances', 'DescribeMonitorGroupCategories', 'PutMonitorGroupDynamicRule', 'CreateGroupMonitoringAgentProcess', 'ModifyGroupMonitoringAgentProcess', 'DeleteGroupMonitoringAgentProcess', 'DescribeGroupMonitoringAgentProcess', 'CreateMonitorGroupNotifyPolicy', 'DeleteMonitorGroupNotifyPolicy', 'DescribeMonitorGroupNotifyPolicyList'], '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' => 'Label', + 'title' => 'Manage application groups', + ], + [ + 'children' => ['CreateDynamicTagGroup', 'DeleteDynamicTagGroup', 'DescribeTagValueList', 'DescribeTagKeyList', 'DescribeProductResourceTagKeyList', 'DescribeDynamicTagRuleList'], 'type' => 'directory', - 'children' => [ - 'AddTags', - 'CreateDynamicTagGroup', - 'DeleteDynamicTagGroup', - 'DescribeTagValueList', - 'DescribeTagKeyList', - 'DescribeProductResourceTagKeyList', - 'DescribeDynamicTagRuleList', - 'RemoveTags', - ], + 'title' => 'Tags', ], [ - 'id' => 59436, - 'title' => 'Availability monitoring', + 'children' => ['CreateHostAvailability', 'DeleteHostAvailability', 'EnableHostAvailability', 'DisableHostAvailability', 'ModifyHostAvailability', 'DescribeUnhealthyHostAvailability', 'DescribeHostAvailabilityList'], 'type' => 'directory', - 'children' => [ - 'CreateHostAvailability', - 'DeleteHostAvailability', - 'EnableHostAvailability', - 'DisableHostAvailability', - 'ModifyHostAvailability', - 'DescribeUnhealthyHostAvailability', - 'DescribeHostAvailabilityList', - ], + 'title' => 'Availability monitoring', ], ], + 'type' => 'directory', + 'title' => 'Application group', ], [ - 'id' => 59416, - 'title' => 'Host monitoring', + 'children' => ['InstallMonitoringAgent', 'DescribeMonitoringAgentHosts', 'DescribeMonitoringAgentAccessKey', 'DescribeMonitoringAgentConfig', 'DescribeMonitoringAgentStatuses', 'ModifyHostInfo', 'DescribeMonitoringConfig', 'PutMonitoringConfig', 'UninstallMonitoringAgent', 'CreateMonitoringAgentProcess', 'CreateMonitorAgentProcess', 'DescribeMonitoringAgentProcesses', 'DeleteMonitoringAgentProcess'], 'type' => 'directory', - 'children' => [ - 'InstallMonitoringAgent', - 'DescribeMonitoringAgentHosts', - 'DescribeMonitoringAgentAccessKey', - 'DescribeMonitoringAgentConfig', - 'DescribeMonitoringAgentStatuses', - 'ModifyHostInfo', - 'DescribeMonitoringConfig', - 'PutMonitoringConfig', - 'UninstallMonitoringAgent', - 'CreateMonitoringAgentProcess', - 'CreateMonitorAgentProcess', - 'DescribeMonitoringAgentProcesses', - 'DeleteMonitoringAgentProcess', - ], + 'title' => 'Host monitoring', ], [ - 'id' => 184858, - 'title' => 'Event center', - 'type' => 'directory', 'children' => [ [ - 'id' => 59447, - 'title' => 'System events', + 'children' => ['DescribeSystemEventHistogram', 'DescribeSystemEventMetaList', 'DescribeSystemEventAttribute', 'DescribeSystemEventCount', 'DescribeMonitorResourceQuotaAttribute', 'SendDryRunSystemEvent'], 'type' => 'directory', - 'children' => [ - 'DescribeSystemEventHistogram', - 'DescribeSystemEventMetaList', - 'DescribeSystemEventAttribute', - 'DescribeSystemEventCount', - 'DescribeMonitorResourceQuotaAttribute', - 'SendDryRunSystemEvent', - ], + 'title' => 'System events', ], [ - 'id' => 59478, - 'title' => 'Custom events', + 'children' => ['DescribeCustomEventCount', 'DescribeCustomEventHistogram', 'DescribeCustomEventAttribute', 'PutCustomEvent'], 'type' => 'directory', - 'children' => [ - 'DescribeCustomEventCount', - 'DescribeCustomEventHistogram', - 'DescribeCustomEventAttribute', - 'PutCustomEvent', - ], + 'title' => 'Custom events', ], ], + 'type' => 'directory', + 'title' => 'Event center', ], [ - 'id' => 59473, - 'title' => 'Custom monitoring', + 'children' => ['PutCustomMetric', 'PutCustomMetricRule', 'DescribeCustomMetricList', 'DeleteCustomMetric'], 'type' => 'directory', - 'children' => [ - 'PutCustomMetric', - 'PutCustomMetricRule', - 'DescribeCustomMetricList', - 'DeleteCustomMetric', - ], + 'title' => 'Custom monitoring', ], [ - 'id' => 59526, - 'title' => 'Log monitoring', + 'children' => ['PutLogMonitor', 'DeleteLogMonitor', 'DescribeLogMonitorList', 'DescribeLogMonitorAttribute'], 'type' => 'directory', - 'children' => [ - 'PutLogMonitor', - 'DeleteLogMonitor', - 'DescribeLogMonitorList', - 'DescribeLogMonitorAttribute', - ], + 'title' => 'Log monitoring', ], [ - 'id' => 184946, - 'title' => 'Site monitoring', + 'children' => ['CreateMonitorGroupByResourceGroupId', 'CreateInstantSiteMonitor', 'BatchCreateInstantSiteMonitor', 'DeleteSiteMonitors', 'DisableSiteMonitors', 'ModifySiteMonitor', 'EnableSiteMonitors', 'DescribeSiteMonitorQuota', 'DescribeSiteMonitorAttribute', 'DescribeSiteMonitorISPCityList', 'DescribeSiteMonitorData', 'DescribeSiteMonitorStatistics', 'DescribeSiteMonitorList', 'DescribeSiteMonitorLog'], 'type' => 'directory', - 'children' => [ - 'CreateMonitorGroupByResourceGroupId', - 'CreateSiteMonitor', - 'CreateInstantSiteMonitor', - 'BatchCreateInstantSiteMonitor', - 'DeleteSiteMonitors', - 'DisableSiteMonitors', - 'ModifySiteMonitor', - 'EnableSiteMonitors', - 'DescribeSiteMonitorQuota', - 'DescribeSiteMonitorAttribute', - 'DescribeSiteMonitorISPCityList', - 'DescribeSiteMonitorData', - 'DescribeSiteMonitorStatistics', - 'DescribeSiteMonitorList', - 'DescribeSiteMonitorLog', - ], + 'title' => 'Site monitoring', ], [ - 'id' => 59386, - 'title' => 'Cloud products', + 'children' => ['DescribeMetricData', 'DescribeProjectMeta', 'DeleteExporterOutput', 'DeleteExporterRule', 'DescribeExporterOutputList', 'DescribeExporterRuleList', 'PutExporterOutput', 'PutExporterRule'], 'type' => 'directory', - 'children' => [ - 'DescribeMetricLast', - 'DescribeMetricList', - 'DescribeMetricData', - 'DescribeMetricMetaList', - 'DescribeProjectMeta', - 'DeleteExporterOutput', - 'DeleteExporterRule', - 'DescribeExporterOutputList', - 'DescribeExporterRuleList', - 'DescribeMetricTop', - 'PutExporterOutput', - 'PutExporterRule', - ], + 'title' => 'Cloud service monitoring', ], [ - 'id' => 184862, - 'title' => 'Alert service', - 'type' => 'directory', 'children' => [ [ - 'id' => 184895, - 'title' => 'Alert history', + 'children' => ['DescribeAlertHistoryList', 'DescribeAlertLogCount', 'DescribeAlertLogList', 'DescribeAlertLogHistogram'], 'type' => 'directory', - 'children' => [ - 'DescribeAlertHistoryList', - 'DescribeAlertLogCount', - 'DescribeAlertLogList', - 'DescribeAlertLogHistogram', - ], + 'title' => 'Alert history', ], [ - 'id' => 184896, - 'title' => 'Initiative alert list', + 'children' => ['DescribeProductsOfActiveMetricRule', 'DescribeActiveMetricRuleList', 'EnableActiveMetricRule', 'DisableActiveMetricRule'], 'type' => 'directory', - 'children' => [ - 'DescribeProductsOfActiveMetricRule', - 'DescribeActiveMetricRuleList', - 'EnableActiveMetricRule', - 'DisableActiveMetricRule', - ], + 'title' => 'One-click alert', ], [ - 'id' => 59454, + 'children' => ['CreateMetricRuleTemplate', 'DeleteMetricRuleTemplate', 'ModifyMetricRuleTemplate', 'DescribeMetricRuleTemplateAttribute', 'DescribeMetricRuleTemplateList', 'ApplyMetricRuleTemplate'], + 'type' => 'directory', 'title' => 'Alert templates', + ], + [ + 'children' => ['DescribeMetricRuleList', 'CreateGroupMetricRules', 'CreateMetricRuleResources', 'DeleteMetricRuleTargets', 'DeleteMetricRules', 'DeleteMetricRuleResources', 'EnableMetricRules', 'DisableMetricRules', 'DescribeMetricRuleTargets', 'DescribeMetricRuleCount', 'DescribeAlertingMetricRuleResources', 'PutMetricRuleTargets', 'PutResourceMetricRule', 'PutResourceMetricRules', 'PutGroupMetricRule'], 'type' => 'directory', - 'children' => [ - 'CreateMetricRuleTemplate', - 'DeleteMetricRuleTemplate', - 'ModifyMetricRuleTemplate', - 'DescribeMetricRuleTemplateAttribute', - 'DescribeMetricRuleTemplateList', - 'ApplyMetricRuleTemplate', - ], + 'title' => 'Threshold alert rules', ], [ - 'id' => 59396, - 'title' => 'Threshold-triggered alert rules', + 'children' => ['DeleteEventRuleTargets', 'DeleteEventRules', 'EnableEventRules', 'DisableEventRules', 'DescribeEventRuleAttribute', 'DescribeEventRuleList', 'DescribeEventRuleTargetList', 'PutEventRuleTargets', 'PutEventRule', 'PutCustomEventRule'], 'type' => 'directory', - 'children' => [ - 'DescribeMetricRuleList', - 'CreateGroupMetricRules', - 'CreateMetricRuleResources', - 'DeleteMetricRuleTargets', - 'DeleteMetricRules', - 'DeleteMetricRuleResources', - 'EnableMetricRules', - 'DisableMetricRules', - 'DescribeMetricRuleTargets', - 'DescribeMetricRuleCount', - 'DescribeAlertingMetricRuleResources', - 'PutMetricRuleTargets', - 'PutResourceMetricRule', - 'PutResourceMetricRules', - 'PutGroupMetricRule', - ], - ], - [ - 'id' => 59461, 'title' => 'Event-triggered alert rules', + ], + [ + 'children' => ['CreateMetricRuleBlackList', 'ModifyMetricRuleBlackList', 'DeleteMetricRuleBlackList', 'DescribeMetricRuleBlackList', 'EnableMetricRuleBlackList'], 'type' => 'directory', - 'children' => [ - 'DeleteEventRuleTargets', - 'DeleteEventRules', - 'EnableEventRules', - 'DisableEventRules', - 'DescribeEventRuleAttribute', - 'DescribeEventRuleList', - 'DescribeEventRuleTargetList', - 'PutEventRuleTargets', - 'PutEventRule', - 'PutCustomEventRule', - ], - ], - [ - 'id' => 184863, - 'title' => 'Alert blacklists', - 'type' => 'directory', - 'children' => [ - 'CreateMetricRuleBlackList', - 'ModifyMetricRuleBlackList', - 'DeleteMetricRuleBlackList', - 'DescribeMetricRuleBlackList', - 'EnableMetricRuleBlackList', - ], + 'title' => 'Alert blacklist', ], [ - 'id' => 59428, - 'title' => 'Alert contacts', + 'children' => ['DescribeContactListByContactGroup', 'DescribeContactGroupList', 'DescribeContactList', 'PutContact', 'PutContactGroup'], 'type' => 'directory', - 'children' => [ - 'DeleteContactGroup', - 'DeleteContact', - 'DescribeContactListByContactGroup', - 'DescribeContactGroupList', - 'DescribeContactList', - 'PutContact', - 'PutContactGroup', - ], + 'title' => 'Alert contacts', ], ], + 'type' => 'directory', + 'title' => 'Alert service', ], [ - 'id' => 166246, - 'title' => 'Hybrid cloud monitoring', + 'children' => ['CreateHybridMonitorNamespace', 'ModifyHybridMonitorNamespace', 'DeleteHybridMonitorNamespace', 'DescribeHybridMonitorNamespaceList', 'CreateHybridMonitorTask', 'ModifyHybridMonitorTask', 'DeleteHybridMonitorTask', 'DescribeHybridMonitorTaskList', 'PutHybridMonitorMetricData', 'DescribeHybridMonitorDataList', 'CreateHybridMonitorSLSGroup', 'ModifyHybridMonitorSLSGroup', 'DeleteHybridMonitorSLSGroup', 'DescribeHybridMonitorSLSGroup', 'Cursor', 'BatchExport'], 'type' => 'directory', - 'children' => [ - 'CreateHybridMonitorNamespace', - 'ModifyHybridMonitorNamespace', - 'DeleteHybridMonitorNamespace', - 'DescribeHybridMonitorNamespaceList', - 'CreateHybridMonitorTask', - 'ModifyHybridMonitorTask', - 'DeleteHybridMonitorTask', - 'DescribeHybridMonitorTaskList', - 'PutHybridMonitorMetricData', - 'DescribeHybridMonitorDataList', - 'CreateHybridMonitorSLSGroup', - 'ModifyHybridMonitorSLSGroup', - 'DeleteHybridMonitorSLSGroup', - 'DescribeHybridMonitorSLSGroup', - 'Cursor', - 'BatchExport', - ], + 'title' => 'Hybrid Cloud monitoring', ], [ - 'id' => 313480, - 'title' => null, + 'children' => ['DescribeSyntheticProbeList', 'AddTags', 'BatchCreateOnceSiteMonitor', 'CreateSiteMonitor', 'DeleteContact', 'DeleteContactGroup', 'DescribeMetricLast', 'DescribeMetricList', 'DescribeMetricMetaList', 'DescribeMetricTop', 'DescribeSiteInstantMonitorLog', 'RemoveTags'], 'type' => 'directory', - 'children' => [ - 'DescribeSyntheticProbeList', - ], + 'title' => 'Others', ], ], 'components' => [ @@ -327,199 +121,137 @@ 'Dimension' => [ 'title' => 'Dimension', 'description' => 'The dimension information of the metric.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Label' => [ - 'title' => 'Dimension label', - 'description' => 'The name of the metric dimension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'label', - ], - 'Value' => [ - 'title' => 'Dimension value', - 'description' => 'The value of the metric dimension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'i-dferwret*****', - 'backendName' => 'value', - ], + 'Label' => ['title' => 'Dimension label', 'description' => 'The name of the metric dimension.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'instanceId', 'backendName' => 'label'], + 'Value' => ['title' => 'Dimension value', 'description' => 'The value of the metric dimension.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'i-dferwret*****', 'backendName' => 'value'], ], + 'example' => '', ], 'Matcher' => [ 'title' => 'mathcer', 'description' => 'The dimension of the metric.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => 'value', - 'description' => 'The value of the metric dimension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'value', - ], - 'Label' => [ - 'title' => 'label', - 'description' => 'The name of the metric dimension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'i-fewrewr*****', - 'backendName' => 'label', - ], - 'Operator' => [ - 'title' => 'operator', - 'description' => 'The matching mode of the metric dimension. Only EQUALS is supported. Default value: EQUALS.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'EQUALS', - 'backendName' => 'operator', - ], + 'Value' => ['title' => 'value', 'description' => 'The value of the metric dimension.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'instanceId', 'backendName' => 'value'], + 'Label' => ['title' => 'label', 'description' => 'The name of the metric dimension.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'i-fewrewr*****', 'backendName' => 'label'], + 'Operator' => ['title' => 'operator', 'description' => 'The matching mode of the metric dimension. Only EQUALS is supported. Default value: EQUALS.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'EQUALS', 'backendName' => 'operator'], ], + 'example' => '', ], 'MetricStat' => [ - 'title' => '', + 'title' => '查询数据点', 'description' => 'The data queried by BatchExport.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'title' => 'namespace', - 'description' => 'The namespace of the cloud service.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - 'backendName' => 'namespace', - ], - 'Metric' => [ - 'title' => 'metric', - 'description' => 'The metric that is used to monitor the cloud service.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cpu_idle', - 'backendName' => 'metric', - ], - 'Period' => [ - 'title' => 'period', - 'description' => 'The time interval based on which the metric value is measured.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'backendName' => 'period', - ], - 'Timestamp' => [ - 'title' => 'timestamp', - 'description' => 'The timestamp of the monitoring data. Unit: milliseconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1641454680000', - 'backendName' => 'timestamp', - ], + 'Namespace' => ['title' => 'namespace', 'description' => 'The namespace of the cloud service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'backendName' => 'namespace'], + 'Metric' => ['title' => 'metric', 'description' => 'The metric that is used to monitor the cloud service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cpu_idle', 'backendName' => 'metric'], + 'Period' => ['title' => 'period', 'description' => 'The time interval based on which the metric value is measured.'."\n" + ."\n" + .'Unit: seconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'backendName' => 'period'], + 'Timestamp' => ['title' => 'timestamp', 'description' => 'The timestamp of the monitoring data. Unit: milliseconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1641454680000', 'backendName' => 'timestamp'], 'Dimensions' => [ 'title' => 'dimensions', 'description' => 'The dimension information that is used to identify the monitored object (instance).'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The dimension information that is used to identify the monitored object (instance).'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Dimension', - ], + 'items' => ['description' => 'The dimension information that is used to identify the monitored object (instance).'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/Dimension', 'title' => '', 'example' => ''], 'backendName' => 'dimensions', 'itemName' => 'Dimension', + 'example' => '', ], 'Associated' => [ 'title' => 'associated', 'description' => 'The additional information about the monitored object (instance).'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The additional information about the monitored object (instance).'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '{"group":"test****", "name":"Alice"}', - ], + 'additionalProperties' => ['description' => 'The additional information about the monitored object (instance).'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{"group":"test****", "name":"Alice"}', 'title' => ''], 'backendName' => 'associated', + 'example' => '', ], 'Measurements' => [ 'title' => 'measurements', 'description' => 'The measured value of the metric. The parameter contains multiple values by default.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The measured value of the metric. The parameter contains multiple values by default.'."\n", - 'visibility' => 'public', - 'type' => 'any', - 'example' => '{"Average":60,"Maximum":85}', - ], + 'additionalProperties' => ['description' => 'The measured value of the metric. The parameter contains multiple values by default.'."\n", 'visibility' => 'Public', 'type' => 'any', 'example' => '{"Average":60,"Maximum":85}', 'title' => ''], 'backendName' => 'measurements', + 'example' => '', ], - 'LogTime' => [ - 'title' => 'logTime', - 'description' => 'The recorded time of the monitoring data. Unit: milliseconds. For non-raw data (aggregated data), the value of LogTime is NULL.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683686550073', - 'backendName' => 'logTime', - ], + 'LogTime' => ['title' => 'logTime', 'description' => 'The recorded time of the monitoring data. Unit: milliseconds. For non-raw data (aggregated data), the value of LogTime is NULL.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1683686550073', 'backendName' => 'logTime'], ], + 'example' => '', ], ], ], 'apis' => [ - 'CreateMonitorGroup' => [ - 'summary' => 'Creates an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddTags' => [ + 'summary' => 'The AddTags operation attaches tags to specified application groups.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', + 'description' => 'A list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n" + ."\n" + .'The value of N can be from 1 to 3. The tag key must be 1 to 64 characters in length.'."\n" + ."\n" + .'Enter a new tag key or use an existing tag key from Cloud Monitor. For information about how to obtain tag keys, see [DescribeTagKeyList](~~2513189~~).'."\n" + ."\n" + .'> The tag key cannot start with `aliyun` or `acs:`. The `Tag.N.Key` and `Tag.N.Value` parameters must be specified together.', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n" + ."\n" + .'The value of N can be from 1 to 3. The tag value must be 1 to 64 characters in length.'."\n" + ."\n" + .'Enter a new tag value or use an existing tag value from Cloud Monitor. For information about how to obtain tag values, see [DescribeTagValueList](~~2513188~~).'."\n" + ."\n" + .'> The tag value cannot start with `aliyun` or `acs:`. The `Tag.N.Key` and `Tag.N.Value` parameters must be specified together.', 'type' => 'string', 'required' => true, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'ECS_Group', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ContactGroups', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The alert contact group. The alert notifications of the application group are sent to the alert contacts that belong to the alert contact group.'."\n" + 'description' => 'The IDs of the application groups.'."\n" ."\n" - .'> An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~PutContact~~) and [PutContactGroup](~~PutContactGroup~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Alert_Group', + .'The value of N can be from 1 to 20.'."\n" + ."\n" + .'For information about how to obtain application group IDs, see [DescribeMonitorGroups](~~2513168~~).', + 'type' => 'array', + 'items' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], + 'required' => true, + 'example' => '7301****', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -528,187 +260,146 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83C89BA6-ABD4-4398-A175-83E86C47A001', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DAE4B115-3847-5438-8709-423627F0A3A3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'InvalidClientTokenId', - 'errorMessage' => 'not allow this operation.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t83C89BA6-ABD4-4398-A175-83E86C47A001\\n\\t200\\n\\ttrue\\n\\t1234567\\n\\t","errorExample":""}]', - 'title' => 'CreateMonitorGroup', - 'description' => 'In this example, an application group named `ECS_Group` is created.'."\n", - 'requestParamsDescription' => ' ', + 'title' => 'AddTags', + 'description' => 'This topic provides an example of how to attach a tag to the application group `7301****`. In this example, the tag key is `key1` and the tag value is `value1`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~315526~~).', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyMonitorGroup' => [ - 'summary' => '修改应用分组', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-08-28T10:00:57.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTags'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:AddTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"DAE4B115-3847-5438-8709-423627F0A3A3\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ApplyMetricRuleTemplate' => [ + 'summary' => 'Applies an alert template to an application group to generate alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute for. Unit: seconds. Default value: 86400.'."\n" + ."\n" + .'> When monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute period.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86400', 'title' => ''], + ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'TemplateIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs_group', - ], + 'schema' => ['description' => 'The ID of the alert template.'."\n" + ."\n" + .'For information about how to obtain the alert template ID, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '700****', 'title' => ''], ], [ - 'name' => 'ContactGroups', + 'name' => 'EnableStartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert groups that can receive alert notifications for the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alarm_ecs_group', - ], + 'schema' => ['description' => 'The start time of the alert effective period. Valid values: 00 to 23, which indicates 00:00 to 23:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '00', 'title' => ''], + ], + [ + 'name' => 'EnableEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the alert effective period. Valid values: 00 to 23, which indicates 00:59 to 23:59.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23', 'title' => ''], + ], + [ + 'name' => 'NotifyLevel', + 'in' => 'query', + 'schema' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- 2: phone call + text message + mailbox + TradeManager + DingTalk chatbot.'."\n" + ."\n" + .'- 3: text message + mailbox + TradeManager + DingTalk chatbot.'."\n" + ."\n" + .'- 4: TradeManager + DingTalk chatbot.'."\n" + ."\n\n" + .'4: TradeManager + DingTalk chatbot.'."\n" + ."\n" + .'4: TradeManager + DingTalk chatbot.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''], + ], + [ + 'name' => 'ApplyMode', + 'in' => 'query', + 'schema' => ['description' => 'The mode in which the alert template is applied. Valid values:'."\n" + ."\n" + .'- GROUP_INSTANCE_FIRST: application group instances take priority. When the alert template is applied, instances in the application group take priority. If an instance does not exist in the application group, the rule in the template is ignored.'."\n" + ."\n" + .'- ALARM_TEMPLATE_FIRST: alert template instances take priority. When the alert template is applied, alert rules are created regardless of whether the instances exist in the application group.', 'type' => 'string', 'required' => false, 'example' => 'GROUP_INSTANCE_FIRST', 'title' => ''], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + ], + [ + 'name' => 'AppendMode', + 'in' => 'query', + 'schema' => ['description' => 'The policy for applying the template. Valid values:'."\n" + ."\n" + .'- all: deletes all rules that were created from alert templates for the selected group, and then creates new alert rules based on the template (default value).'."\n" + ."\n" + .'- append: deletes the rules that were created from this alert template for the selected group, and then creates new alert rules based on the current template.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], ], 'responses' => [ @@ -716,840 +407,916 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C85A2870-5DF4-4269-BC50-ECB5E4591A80', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F897F3C-020A-4993-95B4-63ABB84F83E6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'description' => 'The resources affected by the alert rules.', + 'type' => 'object', + 'properties' => [ + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'AlertResults' => [ + 'description' => 'The details of the generated alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the generated alert rules.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'alert rule is creating, please wait a few minutes.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'test123', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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' => 'ModifyMonitorGroup', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Apply an alert template to an application group', + 'description' => 'This topic provides an example on how to apply the alert template `700****` to the application group `123456`. The ID of the generated alert rule is `applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****`, and the name is `test123`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMonitorGroup' => [ - 'summary' => 'Deletes an application group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-02-27T07:25:21.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyMetricRuleTemplate'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:ApplyMetricRuleTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MetricRuleTemplate', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + ], + 'BatchCreateInstantSiteMonitor' => [ + 'summary' => 'You can call the BatchCreateInstantSiteMonitor operation to create a batch of site monitoring tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'TaskList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The list of site monitoring tasks.'."\n" + ."\n" + .'> You must create at least one site monitoring task. The `Address`, `TaskName`, and `TaskType` parameters are required.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of site monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'Address' => ['description' => 'The URL or IP address of the site monitoring task.'."\n" + ."\n" + .'> You must create at least one site monitoring task. The `Address`, `TaskName`, and `TaskType` parameters are required.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + 'IspCities' => ['description' => 'The information about the detection points. If you leave this parameter empty, the system randomly selects three detection points.'."\n" + ."\n" + .'The value must be a `JSONArray`. For example, `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]` corresponds to Beijing, Hangzhou, and Qingdao.'."\n" + ."\n" + .'For more information about how to obtain detection point information, see [DescribeSiteMonitorISPCityList](~~115045~~).', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', 'title' => ''], + 'OptionsJson' => ['description' => 'The advanced extension options for the protocol type of the site monitoring task. Different protocol types correspond to different extension options.', 'type' => 'string', 'required' => false, 'example' => '{"time_out":5000}', 'title' => ''], + 'TaskName' => ['description' => 'The name of the site monitoring task.'."\n" + ."\n" + .''."\n" + ."\n" + .'The value must be 4 to 100 characters in length and can contain English letters, numbers, underscores (\\_), and Chinese characters.'."\n" + ."\n" + .''."\n" + ."\n" + .''."\n" + ."\n" + .'The name of the site monitoring task.'."\n" + ."\n" + .''."\n" + ."\n" + .''."\n" + ."\n" + .'The name must be 4 to 100 characters in length and can contain letters, digits, and underscores (\\_).'."\n" + ."\n" + .''."\n" + ."\n" + .'> You must create at least one site monitoring task. The `Address`, `TaskName`, and `TaskType` parameters are required.', 'type' => 'string', 'required' => false, 'example' => 'HangZhou_ECS1', 'title' => ''], + 'TaskType' => ['description' => 'The protocol type of the monitoring task.'."\n" + ."\n" + .'Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n" + ."\n" + .'> You must create at least one site monitoring task. The `Address`, `TaskName`, and `TaskType` parameters are required.', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '123456', + 'maxItems' => 200, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CA35B3AE-4FFD-4A33-AE67-67EF68711EFA', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Group' => [ - 'description' => 'The deleted application group.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => 'The name of the application group.', - 'type' => 'string', - 'example' => 'ECS_test', - ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'The alert groups that receive alert notifications for the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the alert group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7AE72720-2C96-5446-9F2B-308C7CEDFF1A'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the site monitoring tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the site monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'TaskName' => ['description' => 'The name of the site monitoring task.', 'type' => 'string', 'example' => 'HangZhou_ECS1', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the site monitoring task.', 'type' => 'string', 'example' => '679fbe4f-b80b-4706-91b2-5427b43e****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '[{"taskName": "HangZhou_ECS1", "taskId": "679fbe4f-b80b-4706-91b2-5427b43e****"}]', + 'title' => '', ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 429 => [ + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s', 'description' => ''], + ], + ], + 'title' => 'BatchCreateInstantSiteMonitor', + 'description' => 'This topic provides an example of how to create a site monitoring task named `HangZhou_ECS1`. The task uses the `HTTP` protocol to monitor `https://www.aliyun.com`. The response shows that the task is successfully created with the name `HangZhou_ECS1` and the ID `679fbe4f-b80b-4706-91b2-5427b43e****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-22T08:20:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-21T06:24:11.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateInstantSiteMonitor'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:BatchCreateInstantSiteMonitor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'BatchCreateOnceSiteMonitor' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - [ - '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.', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'parameters' => [ [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', + 'name' => 'TaskList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Address' => ['type' => 'string'], + 'IspCities' => ['type' => 'string'], + 'OptionsJson' => ['type' => 'string'], + 'TaskName' => ['type' => 'string'], + 'TaskType' => ['type' => 'string'], + ], + ], + 'required' => true, + 'maxItems' => 200, + 'minItems' => 1, ], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], + 'Data' => ['type' => 'string'], + 'Code' => ['type' => 'string'], + ], ], ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 429 => [ + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s', 'description' => ''], ], ], - '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":"\\n\\t\\t\\n\\t\\t\\tECS_test\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\tECS_Group\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\tEFB8C3EC-3460-4EC9-8603-A9FE9D0A6C2C\\n\\t\\t200\\n\\t\\ttrue\\n","errorExample":""}]', - 'title' => 'DeleteMonitorGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMonitorGroups' => [ - 'summary' => 'Queries application groups.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-04-15T12:04:08.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\"\\n}","type":"json"}]', + ], + 'BatchExport' => [ + 'summary' => 'Calls the BatchExport operation to export monitoring data defined in the Cursor operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'SelectContactGroups', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include the alert contact groups in the response. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The data namespace of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the data namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> This parameter must be the same as the request parameter `Namespace` in the Cursor operation.', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'Metric', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the metric of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the name of a metric of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> This parameter must be the same as the request parameter `Metric` in the Cursor operation.', 'type' => 'string', 'required' => true, 'example' => 'cpu_idle', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'Cursor', + 'in' => 'formData', + 'schema' => ['description' => 'When you call this operation in a loop to export data, you must specify the value of `Cursor`. You can obtain the value of `Cursor` by using the following methods:'."\n" + ."\n" + .'- When you call this operation for the first time, you must first call the Cursor operation to obtain the value of `Cursor`. For more information, see [Cursor](~~2330730~~).'."\n" + ."\n" + .'- When you call this operation again, you can obtain the value of `Cursor` from the response of the last call.'."\n", 'type' => 'string', 'required' => true, 'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****', 'title' => ''], + ], + [ + 'name' => 'Length', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of data entries to return each time.'."\n" + ."\n" + .'Valid values: 1 to 10000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'Measurements', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" + 'description' => 'The measurements that are used to customize the returned data. By default, all measurements are returned.'."\n" ."\n" - .'Pages start from page 1. Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'For example, the metric `cpu_idle` of the cloud service `acs_ecs_dashboard` has three measurement columns: `Average`, `Maximum`, and `Minimum`. If you only need to return the `Average` and `Maximum` columns, set this parameter to the array `["Average", "Maximum"]`.'."\n" + ."\n" + .'For information about how to obtain the measurements of a metric of a cloud service, see the `statistics` column of [Appendix 1: Metrics](~~163515~~).', + 'type' => 'array', + 'items' => ['description' => 'The column name of the measurement.', 'type' => 'string', 'required' => false, 'example' => 'Maximum', 'title' => ''], 'required' => false, - 'example' => '30', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Keyword', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The keyword that is used for the search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => '', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: successful'."\n" + ."\n" + .'- false: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '251402CD-305C-1617-808E-D8C11FC8138D', 'title' => ''], + 'Cursor' => ['description' => 'The cursor that is used to call this operation again.'."\n" + ."\n" + .'> If the returned result is `null`, the monitoring data has been exported.', 'type' => 'string', 'example' => 'v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***', 'title' => ''], + 'Length' => ['description' => 'The number of data entries returned for this call.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Anchor' => ['description' => 'The timestamp when the backend requested the data. A larger timestamp indicates that the exported data is closer to the current time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1678781819000', 'title' => ''], + 'HasNext' => ['description' => 'Indicates whether the data has been exported. Valid values:'."\n" + ."\n" + .'- true: Some data has not been exported.'."\n" + .'- false: All data has been exported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DataResults' => [ + 'description' => 'The data returned by this call.', + 'type' => 'array', + 'items' => ['description' => 'The exported data. The details are as follows:'."\n" + .'- Namespace: the data namespace of the cloud service. Example: `acs_ecs_dashboard`.'."\n" + .'- Metric: the name of the metric of the cloud service. Example: `cpu_idle`.'."\n" + .'- Timestamp: the timestamp of the monitoring data. Unit: milliseconds. Example: 1641454680000.'."\n" + .'- Period: the statistical period of the monitoring data. Unit: seconds. Example: 60.'."\n" + .'- Dimensions: the Dimension information that is used to identify the monitored object (instance). Example: `[{"Label":"userId", "Value":""20654616023382****"}, {"Label":"InstanceId", "Value":""i-2ze2d6j5uhg20x4****"}]`.'."\n" + .'- Associated: the additional information about the monitored object (instance), such as tag information. The value is a collection of key:value pairs. Example: `{"group":"test****", "name":"Alice"}`.'."\n" + .'- Measurements: the measurements of the metric (multi-value mode by default). Example: `{"Average":60,"Maximum":85}`.'."\n" + .'- LogTime: the record time of the monitoring data. Unit: milliseconds. For non-raw data (aggregated data), `LogTime` is empty (NULL).', '$ref' => '#/components/schemas/MetricStat', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID. This parameter is used to query the application group to which the specified instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-abcdefgh12****', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Exports the monitoring data defined in Cursor', + 'description' => '### Prerequisites'."\n" + .'Make sure that you have called the [Cursor](~~2330730~~) operation to obtain the initial `Cursor`.'."\n" + .'### Usage notes'."\n" + .'This topic provides an example to show how to export the monitoring data of an initial `Cursor` of the metric `cpu_idle` of the cloud service `acs_ecs_dashboard`. A maximum of 1,000 data entries are returned per call.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchExport'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:BatchExport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"acs_ecs_dashboard\\",\\n \\"Metric\\": \\"cpu_idle\\",\\n \\"Period\\": 60,\\n \\"Timestamp\\": 1641454680000,\\n \\"Dimensions\\": [\\n {\\n \\"Label\\": \\"instanceId\\",\\n \\"Value\\": \\"i-dferwret*****\\"\\n }\\n ],\\n \\"Associated\\": {\\n \\"key\\": \\"{\\\\\\"group\\\\\\":\\\\\\"test****\\\\\\", \\\\\\"name\\\\\\":\\\\\\"Alice\\\\\\"}\\"\\n },\\n \\"Measurements\\": {\\n \\"key\\": \\"{\\\\\\"Average\\\\\\":60,\\\\\\"Maximum\\\\\\":85}\\"\\n },\\n \\"LogTime\\": 1683686550073\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateDynamicTagGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testGroup124', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'IncludeTemplateHistory', + 'name' => 'TagKey', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include the historical alert templates that are applied to the application group in the response. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The tag key of the resource.'."\n" + ."\n" + .'For more information about how to query the tag keys of resources, see [DescribeTagKeyList](~~145558~~).', 'type' => 'string', 'required' => true, 'example' => 'ecs_instance', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'ContactGroupList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the application group. Valid values:'."\n" + 'description' => 'The alert contact groups. The value of N can be from 1 to 100. Alert notifications for the application group are sent to the alert contacts in these alert contact groups.'."\n" ."\n" - .'* custom: a self-managed application group'."\n" - .'* ehpc_cluster: an application group that is synchronized from an E-HPC cluster'."\n" - .'* kubernetes: an application group that is synchronized from an ACK cluster'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - 'enum' => [ - 'custom', - 'ehpc_cluster', - 'kubernetes', - 'tag', - 'aone_group', - 'resMgr', - 'ess', - ], + .'An alert contact group can contain one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For more information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).', + 'type' => 'array', + 'items' => ['description' => 'The alert contact groups. The value of N can be from 1 to 100. Alert notifications for the application group are sent to the alert contacts in these alert contact groups.'."\n" + ."\n" + .'An alert contact group can contain one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For more information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ECS_Group', 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'example' => 'ECS_Group', + 'maxItems' => 10, + 'title' => '', ], ], [ - 'name' => 'DynamicTagRuleId', + 'name' => 'MatchExpress', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the tag rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', + 'description' => 'The match expressions that are used to create an application group from tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The match expressions that are used to create an application group from tags. The value of N can be from 1 to 3.', + 'type' => 'object', + 'properties' => [ + 'TagValueMatchFunction' => ['description' => 'The method that is used to match the values of resource tags. The value of N is 1. Valid values:'."\n" + ."\n" + .'- contains: includes.'."\n" + ."\n" + .'- startWith: prefix.'."\n" + ."\n" + .'- endWith: suffix.'."\n" + ."\n" + .'- notContains: does not include.'."\n" + ."\n" + .'- equals: equals.'."\n" + ."\n" + .'- all: all.'."\n" + ."\n" + .'> You must specify both the `MatchExpress.N.TagValueMatchFunction` and `MatchExpress.N.TagValue` parameters.', 'type' => 'string', 'required' => false, 'example' => 'contains', 'title' => ''], + 'TagValue' => ['description' => 'The value of the resource tag. The value of N is 1.'."\n" + ."\n" + .'> You must specify both the `MatchExpress.N.TagValueMatchFunction` and `MatchExpress.N.TagValue` parameters.', 'type' => 'string', 'required' => false, 'example' => 'instance', 'title' => ''], + 'TagName' => ['description' => 'The key of the tag that is used to create the group. If multiple resources have this tag key, the resources that meet the filter conditions are added to the same group based on the same key-value pair.', 'type' => 'string', 'required' => false, 'example' => 'appname', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 4, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'GroupFounderTagKey', + 'name' => 'TagRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key that is created for the application group by using the tag rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GroupKey1', - ], + 'schema' => ['description' => 'The ID of the region to which the tag belongs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GroupFounderTagValue', + 'name' => 'EnableSubscribeEvent', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag value that is created for the application group by using the tag rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GroupValue1', - ], + 'schema' => ['description' => 'Specifies whether to automatically subscribe to event notifications for the application group. When a critical or warning event occurs on a resource in the application group, CloudMonitor sends an alert notification. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false (default): disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EnableInstallAgent', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group. Separate multiple application group IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '92****', - ], + 'schema' => ['description' => 'Specifies whether to automatically install the CloudMonitor agent for the application group. CloudMonitor automatically installs the agent on the hosts in the application group. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false (default): disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'MatchExpressFilterRelation', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags of the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the application group. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey1', - ], - 'Value' => [ - 'description' => 'The tag value of the application group. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagValue1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The relationship between the conditional expressions for the tag values. Valid values:'."\n" + ."\n" + .'- and (default)'."\n" + ."\n" + .'- or', 'type' => 'string', 'required' => false, 'default' => 'and', 'example' => 'and', 'title' => ''], ], [ - 'name' => 'Types', + 'name' => 'TemplateIdList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the application group. Valid values:'."\n" + 'description' => 'The ID of the alert template.'."\n" ."\n" - .'* custom: a self-managed application group'."\n" - .'* ehpc_cluster: an application group that is synchronized from an Elastic High Performance Computing (E-HPC) cluster'."\n" - .'* kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster'."\n" - .'* tag: an application group that is automatically created by using tags'."\n" - .'* resMgr: an application group that is created by using resource groups'."\n" - .'* ess: an application group that is synchronized from Auto Scaling (ESS)'."\n", - 'type' => 'string', + .'For more information about how to query the IDs of alert templates, see [DescribeMetricRuleTemplateList](~~114982~~).', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert template.'."\n" + ."\n" + .'For more information about how to query the IDs of alert templates, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => false, 'example' => '70****', 'title' => ''], 'required' => false, - 'example' => 'custom', + 'example' => '85****', + 'maxItems' => 10, + 'title' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => 'The results returned.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F02B299A-D374-4595-9F55-7534D604F132', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The resources that are associated with the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resources that are associated with the application group.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the application group. Valid values:'."\n" - ."\n" - .'* custom: a self-managed application group'."\n" - .'* ehpc_cluster: an application group that is synchronized from an E-HPC cluster'."\n" - .'* kubernetes: an application group that is synchronized from an ACK cluster'."\n", - 'type' => 'string', - 'example' => 'custom', - ], - 'GroupFounderTagValue' => [ - 'description' => 'The tag value that is created for the application group by using the tag rule.'."\n", - 'type' => 'string', - 'example' => 'GroupValue1', - ], - 'BindUrl' => [ - 'description' => 'The URL of the ACK cluster from which the application group is synchronized.'."\n", - 'type' => 'string', - 'example' => 'https://aliyun.com', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'example' => 'test123', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'ServiceId' => [ - 'description' => 'The ID of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => '49****', - ], - 'DynamicTagRuleId' => [ - 'description' => 'The ID of the tag rule.'."\n", - 'type' => 'string', - 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', - ], - 'GmtCreate' => [ - 'description' => 'The timestamp when the application group was created. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1603181891000', - ], - 'GroupFounderTagKey' => [ - 'description' => 'The tag key that is created for the application group by using the tag rule.'."\n", - 'type' => 'string', - 'example' => 'GroupKey1', - ], - 'GmtModified' => [ - 'description' => 'The timestamp when the application group was modified. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1603181891000', - ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'The alert contact groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - ], - ], - ], - ], - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => 'The tags that are attached to the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the application group.'."\n", - 'type' => 'string', - 'example' => 'tagKey1', - ], - 'Value' => [ - 'description' => 'The tag value of the application group.'."\n", - 'type' => 'string', - 'example' => 'tagValue1', - ], - ], - ], - ], - ], - ], - 'TemplateIds' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TemplateId' => [ - 'description' => 'The ID of the template.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert templates that are applied to the application group.'."\n", - 'type' => 'string', - 'example' => '92****', - ], - ], - ], - ], - 'ResourceGroupId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2hopjh*******', - ], - 'TemplateInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TemplateInfo' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EffectTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'TemplateId' => [ - 'type' => 'string', - ], - 'Ver' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The ID of the tag matching rule.', 'type' => 'string', 'example' => '2534dc0a-e3e5-4ae1-a2fc-75ef166c****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n F02B299A-D374-4595-9F55-7534D604F132\\n 30\\n 1\\n 2\\n \\n \\n testGroup124\\n \\n \\n CloudMonitor\\n \\n \\n custom\\n 1603181891000\\n 1603181891000\\n 1204\\n 001\\n \\n 92****\\n \\n \\n \\n tagKey1\\n tagValue1\\n \\n \\n 7301****\\n \\n \\n test123\\n \\n \\n CloudMonitor\\n \\n \\n tag\\n 1603181891000\\n 6b882d9a-5117-42e2-9d0c-4749a0c6****\\n 1603181891000\\n GroupKey1\\n GroupValue1\\n \\n \\n \\n \\n 92****\\n \\n \\n 200\\n true\\n","errorExample":""}]', - 'title' => 'DescribeMonitorGroups', - 'description' => 'This topic provides an example of how to query the application groups of the current account. The response shows that the current account has two application groups: `testGroup124` and `test123`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'CreateDynamicTagGroup', + 'summary' => 'You can call the CreateDynamicTagGroup operation to automatically create application groups using tags.', + 'description' => 'This operation supports the following Alibaba Cloud services: Elastic Compute Service (ECS), ApsaraDB RDS, and Server Load Balancer (SLB).'."\n" + ."\n" + .'This topic provides an example of how to automatically create an application group for resources that have the `ecs_instance` tag key. The alert contact group for the application group is `ECS_Group`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMonitorGroupInstances' => [ - 'summary' => 'Adds resources to an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-03-15T03:17:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-13T10:09:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-24T08:25:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-24T08:25:15.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDynamicTagGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateDynamicTagGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateGroupMetricRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3607****', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'Instances', + 'name' => 'GroupMetricRules', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The instances that you want to add to the application group.'."\n", + 'description' => 'The list of metric-based alert rules for the application group.', 'type' => 'array', 'items' => [ - 'description' => 'None.'."\n", + 'description' => 'The metric-based alert rule for the application group.', 'type' => 'object', 'properties' => [ - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-instance-ecs', - ], - 'Category' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n" - ."\n" - .'To obtain the abbreviation of an Alibaba Cloud service name, call the [DescribeProjectMeta](~~114916~~) operation. The `metricCategory` tag in the `Labels` response parameter indicates the abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-2ze26xj5wwy12****', - ], - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => ' cn-hangzhou', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 2000, + 'Escalations.Info.Threshold' => ['description' => 'The threshold for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the metric name, see [DescribeMetricMetaList](~~98846~~) or [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + 'Escalations.Warn.Threshold' => ['description' => 'The threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The effective period of the alert rule. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => '05:31-23:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time period during which the alert rule is ineffective. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => '00:00-05:30', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => true, 'example' => '456789', 'title' => ''], + 'Escalations.Critical.Times' => ['description' => 'The number of times that the monitoring metric must reach the alert threshold before a Critical-level alert notification is sent.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Dimensions' => ['description' => 'The monitoring dimensions of the specified resource.'."\n" + ."\n" + .'The value is a collection of `key:value` pairs, such as `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', 'title' => ''], + 'Escalations.Critical.Threshold' => ['description' => 'The threshold that triggers Critical-level alert notifications.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'Escalations.Critical.Statistics' => ['description' => 'The statistical method for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see [Cloud service monitoring](~~163515~~).'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.ComparisonOperator' => ['description' => 'The comparison operator for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold. '."\n" + .'- GreaterThanThreshold: greater than the threshold. '."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold. '."\n" + .'- LessThanThreshold: less than the threshold. '."\n" + .'- NotEqualToThreshold: not equal to the threshold. '."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday. '."\n" + .'- LessThanYesterday: less than the value at the same time yesterday. '."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week. '."\n" + .'- LessThanLastWeek: less than the value at the same time last week. '."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period. '."\n" + .'- LessThanLastPeriod: less than the value in the last period. '."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Info.Times' => ['description' => 'The number of times that the monitoring metric must reach the alert threshold before an Info-level alert notification is sent.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'SilenceTime' => ['description' => 'The mute period of the alert notification. Valid values of N: 1 to 200.'."\n" + ."\n" + .'Unit: seconds. Default value: 86400. Minimum value: 3600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL to which an alert notification is sent. Valid values of N: 1 to 200.'."\n" + ."\n" + .'Specify a publicly accessible URL. CloudMonitor sends a POST request to push alert information to this URL. Only the HTTP protocol is supported.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the namespace of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~) or [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'EmailSubject' => ['description' => 'The subject of the alert notification email.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance', 'title' => ''], + 'Period' => ['description' => 'The reporting period of monitoring data.'."\n" + ."\n" + .'Valid values of N: 1 to 200. '."\n" + ."\n" + .'The value of `Period` must be 60 or a multiple of 60. Unit: seconds. Default value: 300.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => true, 'example' => 'ECS_Rule1', 'title' => ''], + 'Escalations.Info.Statistics' => ['description' => 'The statistical method for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see [Cloud service monitoring](~~163515~~).'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.Times' => ['description' => 'The number of times that the monitoring metric must reach the alert threshold before a Warn-level alert notification is sent.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Escalations.Info.ComparisonOperator' => ['description' => 'The comparison operator for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold. '."\n" + .'- GreaterThanThreshold: greater than the threshold. '."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold. '."\n" + .'- LessThanThreshold: less than the threshold. '."\n" + .'- NotEqualToThreshold: not equal to the threshold. '."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday. '."\n" + .'- LessThanYesterday: less than the value at the same time yesterday. '."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week. '."\n" + .'- LessThanLastWeek: less than the value at the same time last week. '."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period. '."\n" + .'- LessThanLastPeriod: less than the value in the last period. '."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Interval' => ['description' => 'The detection period of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'Unit: seconds. The default value is the minimum reporting frequency of the metric.'."\n" + ."\n" + .'> Keep the detection period of the alert rule consistent with the data reporting period. If the detection period is shorter than the data reporting period, alerts may not be triggered due to insufficient data.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the Alibaba Cloud service name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the abbreviation, see the `metricCategory` tag in the `Labels` response parameter of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ECS', 'title' => ''], + 'Escalations.Critical.ComparisonOperator' => ['description' => 'The comparison operator for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold. '."\n" + .'- GreaterThanThreshold: greater than the threshold. '."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold. '."\n" + .'- LessThanThreshold: less than the threshold. '."\n" + .'- NotEqualToThreshold: not equal to the threshold. '."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday. '."\n" + .'- LessThanYesterday: less than the value at the same time yesterday. '."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week. '."\n" + .'- LessThanLastWeek: less than the value at the same time last week. '."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period. '."\n" + .'- LessThanLastPeriod: less than the value in the last period. '."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Warn.Statistics' => ['description' => 'The statistical method for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see [Cloud service monitoring](~~163515~~).'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'NoDataPolicy' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + .'- KEEP_LAST_STATE (default): No action is performed.'."\n" + .'- INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'KEEP_LAST_STATE', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the alert contact group, see [DescribeContactGroupList](~~114922~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + 'Labels' => [ + 'description' => 'The tag keys of the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag keys of the alert rule.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the alert rule. The tag is included in alert notifications.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value of the alert rule. The tag is included in alert notifications.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', + ], + 'Options' => ['description' => 'The advanced settings.'."\n" + ."\n" + .'Format: {"key1":"value1","key2":"value2"}. For example, {"NotSendOK":true} specifies whether to send an alert recovery notification. The key is NotSendOK, and the value is true (do not send) or false (send, which is the default).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "NotSendOK": true'."\n" + .'}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], ], @@ -1558,1744 +1325,1464 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1BC69FEB-56CD-4555-A0E2-02536A24A946', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: The operation is successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertResult' => [ + 'description' => 'The list of alert rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code of the newly created alert rule.'."\n" + .'>A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message of the newly created alert rule.', 'type' => 'string', 'example' => 'Metric not found.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the alert rule is created. Valid values:'."\n" + ."\n" + .'- true: The alert rule is created.'."\n" + ."\n" + .'- false: The alert rule failed to be created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RuleName' => ['description' => 'The name of the newly created alert rule.', 'type' => 'string', 'example' => 'ECS_Rule1', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the newly created alert rule.', 'type' => 'string', 'example' => '456789', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'InvalidClientTokenId', - 'errorMessage' => 'not allow this operation.', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => '%s', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 412 => [ - [ - 'errorCode' => 'ResourcesOverLimit', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => '500', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n 1BC69FEB-56CD-4555-A0E2-02536A24A946\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'CreateMonitorGroupInstances', - 'description' => 'You can add a maximum of 1,000 instances to an application group at a time. You can add a maximum of 3,000 instances of an Alibaba Cloud service to an application group. The total number of instances that you can add to an application group is unlimited.'."\n" - ."\n" - .'In this example, an Elastic Compute Service (ECS) instance in the `China (Hangzhou)` region is added to the `3607****` application group. The instance ID is `i-2ze26xj5wwy12****` and the instance name is `test-instance-ecs`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Create alert rules in batches for a specified application group', + 'summary' => 'Creates alert rules in batches for a specified application group by calling the CreateGroupMetricRules operation.', + 'description' => 'This topic provides an example on how to create an alert rule for the monitoring metric `cpu_total` of Elastic Computing Service (ECS) in the application group `123456`. The alert rule ID is `456789`, the alert rule name is `ECS_Rule1`, the alert severity is `Critical`, the statistical method is `Average`, the comparison operator is `GreaterThanOrEqualToThreshold`, the threshold is `90`, and the retry count is `3`. The response shows that the alert rule `ECS_Rule1` is created.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyMonitorGroupInstances' => [ - 'summary' => '修改应用分组中的资源', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-12-13T07:02:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateGroupMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'GroupMetricRule', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateGroupMonitoringAgentProcess' => [ + 'summary' => 'Creates a process monitoring task for an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For more information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => true, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'Instances', + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => ['description' => 'The process name.', 'type' => 'string', 'required' => true, 'example' => 'Process_Java', 'title' => ''], + ], + [ + 'name' => 'MatchExpressFilterRelation', + 'in' => 'query', + 'schema' => ['description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" + ."\n" + .'- all'."\n" + ."\n" + .'- and'."\n" + ."\n" + .'- or', 'type' => 'string', 'required' => false, 'example' => 'and', 'title' => ''], + ], + [ + 'name' => 'MatchExpress', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The expressions used to match instances.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'array', 'items' => [ + 'description' => 'The expression used to match instances.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'object', 'properties' => [ - 'InstanceName' => [ - 'description' => 'The name of the instance. Valid values of N: 1 to 2000.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HostName', - ], - 'Category' => [ - 'description' => 'The abbreviation of the name of the service to which the instances to be added to the application group belong. Valid values:'."\n" - ."\n" - .'* ECS: Elastic Compute Service (ECS) instances provided by Alibaba Cloud and hosts not provided by Alibaba Cloud'."\n" - ."\n" - .'* RDS: ApsaraDB for RDS'."\n" - ."\n" - .'* ADS: AnalyticDB'."\n" - ."\n" - .'* SLB: Server Load Balancer (SLB)'."\n" - ."\n" - .'* VPC: Virtual Private Cloud (VPC)'."\n" - ."\n" - .'* APIGATEWAY: API Gateway'."\n" - ."\n" - .'* CDN: Alibaba Cloud Content Delivery Network (CDN)'."\n" - ."\n" - .'* CS: Container Service for Swarm'."\n" - ."\n" - .'* DCDN: Dynamic Route for CDN'."\n" - ."\n" - .'* DDoS: Anti-DDoS Pro'."\n" - ."\n" - .'* EIP: Elastic IP Address (EIP)'."\n" - ."\n" - .'* ELASTICSEARCH: Elasticsearch'."\n" - ."\n" - .'* EMR: E-MapReduce'."\n" - ."\n" - .'* ESS: Auto Scaling'."\n" - ."\n" - .'* HBASE: ApsaraDB for Hbase'."\n" - ."\n" - .'* IOT_EDGE: IoT Edge'."\n" - ."\n" - .'* K8S_POD: pods in Container Service for Kubernetes'."\n" - ."\n" - .'* KVSTORE_SHARDING: ApsaraDB for Redis of the cluster architecture'."\n" - ."\n" - .'* KVSTORE_SPLITRW: ApsaraDB for Redis of the read/write splitting architecture'."\n" - ."\n" - .'* KVSTORE_STANDARD: ApsaraDB for Redis of the standard architecture'."\n" - ."\n" - .'* MEMCACHE: ApsaraDB for Memcache'."\n" - ."\n" - .'* MNS: Message Service (MNS)'."\n" - ."\n" - .'* MONGODB: ApsaraDB for MongoDB of the replica set architecture'."\n" - ."\n" - .'* MONGODB_CLUSTER: ApsaraDB for MongoDB of the cluster architecture'."\n" - ."\n" - .'* MONGODB_SHARDING: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" - ."\n" - .'* MQ_TOPIC: MNS topics'."\n" - ."\n" - .'* OCS: ApsaraDB for Memcache of earlier versions'."\n" - ."\n" - .'* OPENSEARCH: Open Search'."\n" - ."\n" - .'* OSS: Object Storage Service (OSS)'."\n" - ."\n" - .'* POLARDB: PolarDB'."\n" - ."\n" - .'* PETADATA: HybridDB for MySQL'."\n" - ."\n" - .'* SCDN: Secure Content Delivery Network (SCDN)'."\n" - ."\n" - .'* SHAREBANDWIDTHPACKAGES: EIP Bandwidth Plan'."\n" - ."\n" - .'* SLS: Log Service'."\n" - ."\n" - .'* VPN: VPN Gateway'."\n" - ."\n" - .' Valid values of N: 1 to 2000.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance. Valid values of N: 1 to 2000.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-a2d5q7pm12****', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the instance resides. Valid values of N: 1 to 2000.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'Value' => ['description' => 'The keyword used to match the instance name.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => false, 'example' => 'portalHost', 'title' => ''], + 'Name' => ['description' => 'The criteria based on which the instances are matched.'."\n" + ."\n" + .'Valid values of N: 1 to 3.'."\n" + ."\n" + .'> Set the value to name. The value name indicates that the instances are matched based on the instance name.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], + 'Function' => ['description' => 'The matching condition. Valid values:'."\n" + ."\n" + .'- all (default value): matches all'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- notContains: does not contain'."\n" + ."\n" + .'- equals: equals'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => false, 'example' => 'startWith', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - 'maxItems' => 2000, + 'required' => false, + 'maxItems' => 3, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'AlertConfig', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" + 'description' => 'The alert rule configurations.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert rule configuration.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - '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.', + .'Valid values of N: 1 to 3.'."\n" + ."\n" + .'> Only one alert notification is sent during a mute period even if the metric value exceeds the alert threshold during consecutive checks.', 'type' => 'string', 'required' => false, 'default' => '86400', 'example' => '86400', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => true, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + 'Times' => ['description' => 'The number of times for which the threshold can be consecutively exceeded. Default value: 3.'."\n" + ."\n" + .'Valid values of N: 1 to 3.'."\n" + ."\n" + .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'EscalationsLevel' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- critical (default)'."\n" + ."\n" + .'- warn'."\n" + ."\n" + .'- info'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => true, 'example' => 'warn', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The period of time during which the alert rule is effective.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => false, 'example' => '07:00-22:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '00:00-05:30', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => true, 'example' => '5', 'title' => ''], + 'Statistics' => ['description' => 'The statistical aggregation method that is used to calculate the metric values.'."\n" + ."\n" + .'Valid values of N: 1 to 3.'."\n" + ."\n" + .'> Set the value to Average.', 'type' => 'string', 'required' => true, 'example' => 'Average', 'title' => ''], + 'TargetList' => [ + 'description' => 'The alert triggers.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert trigger.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the resource for which alerts are triggered.'."\n" + ."\n" + .'For more information about how to obtain the ID of a resource for which alerts are triggered, see [DescribeMetricRuleTargets](~~121592~~).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" + ."\n" + .'For more information about how to query the ARN of a resource, see [DescribeMetricRuleTargets](~~121592~~).'."\n" + ."\n" + .'Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" + ."\n" + .'- {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" + ."\n" + .'- {userId}: the ID of the Alibaba Cloud account.'."\n" + ."\n" + .'- {regionId}: the region ID of the SMQ queue or topic.'."\n" + ."\n" + .'- {Resource type}: the type of the resource that triggers the alert. Valid values:'."\n" + ."\n" + .' - **queues**'."\n" + ."\n" + .' - **topics**'."\n" + ."\n" + .'- {Resource name}: the resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + ."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- CRITICAL', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The parameters of the alert callback. The parameters are in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 3, + 'title' => '', + 'example' => '', ], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '718FEA81-64C3-4F23-8F90-0531F7489FC1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'description' => 'The group process information.', + 'type' => 'object', + 'properties' => [ + 'GroupProcessId' => ['description' => 'The ID of the group process.', 'type' => 'string', 'example' => '7F2B0024-4F21-48B9-A764-211CEC48****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => '%s', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 412 => [ - [ - 'errorCode' => 'ResourcesOverLimit', - 'errorMessage' => '%s', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n 02977C39-9E74-430A-B35B-04CFBF0E7F64\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'ModifyMonitorGroupInstances', + 'title' => 'CreateGroupMonitoringAgentProcess', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupInstances' => [ - 'summary' => 'Queries the resources in an application group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-03-20T02:25:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateGroupMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'GroupMonitoringAgentProcess', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateHostAvailability' => [ + 'summary' => 'Creates an availability monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The application group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the availability monitoring task. The name must be 4 to 100 characters in length and can contain letters, digits, underscores (_), and Chinese characters.', 'type' => 'string', 'required' => true, 'example' => 'task1', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'TaskScope', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The detection scope of the availability monitoring task. Valid values:'."\n" + ."\n" + .'- GROUP: uses all ECS instances in the current application group as detection probes.'."\n" + .'- GROUP_SPEC_INSTANCE: uses specified ECS instances in the current application group as detection probes. If you set this parameter to GROUP_SPEC_INSTANCE, you must also set InstanceList to specify the ECS instances that initiate detection.', 'type' => 'string', 'required' => false, 'default' => 'GROUP', 'example' => 'GROUP', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the cloud service name. Valid values of N: 1 to 200.'."\n" - ."\n" - .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The detection type of the availability monitoring task. Valid values:'."\n" + ."\n" + .'- PING'."\n" + .'- TELNET'."\n" + .'- HTTP', 'type' => 'string', 'required' => true, 'example' => 'HTTP', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'TaskOption.HttpURI', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword used to search for instances. Fuzzy search based on instance names is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's1', - ], + 'schema' => ['description' => 'The URI for HTTP or Telnet detection.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com'."\n" + .'telnet://127.0.0.1:80', 'title' => ''], ], [ - 'name' => 'InstanceIds', + 'name' => 'TaskOption.TelnetOrPingHost', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID. You can query multiple instances by specifying multiple IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-x1234568', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '97F2A410-9412-499C-9AD1-76EF7EC02DF2', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The information about the resources in the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'i-2ze3w55tr2r****', - ], - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'hostIP', - ], - 'Id' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 'schema' => ['description' => 'The domain name or address to detect.'."\n" + .'>If the detection type is PING, set this parameter.', 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''], ], - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + [ + 'name' => 'TaskOption.HttpResponseCharset', + 'in' => 'query', + 'schema' => ['description' => 'The response character set for HTTP detection.'."\n" + ."\n" + .'> Only UTF-8 is supported.', 'type' => 'string', 'required' => false, 'example' => 'UTF-8', 'title' => ''], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + 'name' => 'TaskOption.HttpPostContent', + 'in' => 'query', + 'schema' => ['description' => 'The POST content of the HTTP detection request.', 'type' => 'string', 'required' => false, 'example' => 'params1=paramsValue1', 'title' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 'name' => 'TaskOption.HttpResponseMatchContent', + 'in' => 'query', + 'schema' => ['description' => 'The content to match in the response.', 'type' => 'string', 'required' => false, 'example' => 'ok', 'title' => ''], ], [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + 'name' => 'TaskOption.HttpMethod', + 'in' => 'query', + 'schema' => ['description' => 'The method for the detection type. Valid values:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD'."\n" + ."\n" + .'>If the detection type is HTTP, set this parameter.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 'name' => 'TaskOption.HttpNegative', + 'in' => 'query', + 'schema' => ['description' => 'The alert rule for matching HTTP response content. Valid values:'."\n" + .'- true: An alert is triggered if the HTTP response content contains the specified alert rule content.'."\n" + .'- false: An alert is triggered if the HTTP response content does not contain the specified alert rule content.'."\n" + ."\n" + .'>This parameter takes effect only when the detection type is HTTP.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'TaskOption.HttpHeader', + 'in' => 'query', + 'schema' => ['description' => 'The header of the HTTP request. The format is `Parameter name:Parameter value`. Separate multiple parameters with line breaks. Example:'."\n" + .'```'."\n" + .'params1:value1'."\n" + .'params2:value2'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'token:testTokenValue', 'title' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'TaskOption.Interval', + 'in' => 'query', + 'schema' => ['description' => 'The detection frequency. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.'."\n" + ."\n" + .'> Only CloudMonitor agent 3.5.1 or later supports this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + [ + 'name' => 'AlertConfig.NotifyType', + 'in' => 'query', + 'schema' => ['description' => 'The alert notification type. Valid values:'."\n" + ."\n" + .'- 2: phone call + text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 1: text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 0: email + DingTalk chatbot.'."\n" + ."\n\n" + .'0: email + DingTalk chatbot.'."\n" + ."\n" + .'0: email + DingTalk chatbot.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'AlertConfig.StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time when the alert takes effect. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if `AlertConfig.StartTime` is set to 0 and `AlertConfig.EndTime` is set to 22, the alert is effective from 00:00:00 to 22:00:00.'."\n" + ."\n" + .'>If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'AlertConfig.EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time when the alert takes effect. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if `AlertConfig.StartTime` is set to 0 and `AlertConfig.EndTime` is set to 22, the alert is effective from 00:00:00 to 22:00:00.'."\n" + ."\n" + .'>If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', 'title' => ''], ], - ], - '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":"1\\n30\\n7670220A-0725-42EE-9252-8200C4F810D9\\ntrue\\n200\\n1\\n\\n \\n ECS\\n i-2ze3w55tr2rcpejp****\\n cn-beijing\\n dynamic_group_1\\n \\n","errorExample":""}]', - 'title' => 'DescribeMonitorGroupInstances', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupDynamicRules' => [ - 'summary' => 'Queries the dynamic rules of an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AlertConfig.SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute period. Unit: seconds. Default value: 86400 (1 day).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'AlertConfig.WebHook', + 'in' => 'query', + 'schema' => ['description' => 'The webhook address.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com/webhook.json', 'title' => ''], + ], + [ + 'name' => 'AlertConfigEscalationList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric for the alert. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- HttpStatus: HTTP status code.'."\n" + .'- HttpLatency: HTTP latency.'."\n" + .'- TelnetStatus: Telnet status code.'."\n" + .'- TelnetLatency: Telnet latency.'."\n" + .'- PingLostRate: Ping packet loss rate.', 'type' => 'string', 'required' => true, 'example' => 'HttpStatus', 'title' => ''], + 'Value' => ['description' => 'The alert threshold. Valid values of N: 1 to 21.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'Times' => ['description' => 'The number of alert retries. Valid values of N: 1 to 21.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Operator' => ['description' => 'The comparison operator for the alert rule. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Aggregate' => ['description' => 'The statistical method for the alert. Valid values of N: 1 to 21. The valid values vary based on the metric:'."\n" + ."\n" + .'- HttpStatus: Value.'."\n" + .'- HttpLatency: Average.'."\n" + .'- TelnetStatus: Value.'."\n" + .'- TelnetLatency: Average.'."\n" + .'- PingLostRate: Average.'."\n" + ."\n" + .'>The statistical method for status codes is the original value (Value). The statistical method for latency or packet loss rate is the average value (Average).', 'type' => 'string', 'required' => false, 'example' => 'Value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'docRequired' => true, - 'example' => '123456', + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of ECS instances that initiate detection. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> Set this parameter when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.', + 'type' => 'array', + 'items' => ['description' => 'The list of ECS instances that initiate detection. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> Set this parameter when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'required' => false, + 'example' => 'i-absdfkwl321****', + 'maxItems' => 1000, + 'title' => '', + ], + ], + [ + 'name' => 'AlertConfigTargetList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The alert trigger targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert trigger targets.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert trigger target.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The resource ARN. Format: `acs:{AbbreviatedCloudServiceName}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The following list describes the parameters:'."\n" + ."\n" + .'- {AbbreviatedCloudServiceName}: Only Simple Message Queue (formerly MNS) is supported.'."\n" + ."\n" + .'- {userId}: The Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: The region where the Simple Message Queue (formerly MNS) queue or topic resides.'."\n" + ."\n" + .'- {ResourceType}: The type of the resource that accepts alerts. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {ResourceName}: The resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2170B94A-1576-4D65-900E-2093037CDAF3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The resources that are associated with the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => 'The type of the cloud service to which the dynamic rule belongs. Valid values:'."\n" - ."\n" - .'* ecs: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'FilterRelation' => [ - 'description' => 'The filter condition. Valid values:'."\n" - ."\n" - .'* and: queries the instances that meet all alert rules.'."\n" - .'* or: queries the instances that meet any alert rule.'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'Filters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Filter' => [ - 'description' => 'The dynamic rules of the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The value of the dynamic rule.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Function' => [ - 'description' => 'The method that is used to filter the instances. Valid values:'."\n" - ."\n" - .'* contains: contains'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n", - 'type' => 'string', - 'example' => 'contains', - ], - 'Name' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'hostName', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'>200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => 'The parameter is invalid.'], ], - [ - [ - '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.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + 412 => [ + ['errorCode' => 'ResouceOverLimit', 'errorMessage' => 'The task over limit', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t38D0A8B4-7231-4E3E-A39F-D8CE3E242AC7\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tand\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tcontains\\r\\n\\t\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\t\\thostName\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tecs\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeMonitorGroupDynamicRules', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create an availability monitoring task', + 'description' => 'This topic provides an example on how to create an availability monitoring task named `task1` with the detection type `HTTP` in the application group `123456`. Alert notifications are sent by email and DingTalk chatbot.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupInstanceAttribute' => [ - 'summary' => 'Queries the details of the resources in an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-22T08:53:07.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'HostAvailability', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + ], + 'CreateHybridMonitorNamespace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The name of the metric repository.'."\n" + ."\n" + .'Format: consists of lowercase letters, digits, and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Valid values: 1 to 1000000000.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The description of the metric repository.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Alibaba Cloud product metric repository.', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Spec', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page.'."\n" + 'description' => 'The data storage duration. Valid values:'."\n" ."\n" - .'Valid values: 1 to 1000000000.'."\n" + .'- cms.s1.large: storage duration of 15 days.'."\n" + .'- cms.s1.xlarge: storage duration of 32 days.'."\n" + .'- cms.s1.2xlarge: storage duration of 63 days.'."\n" + .'- cms.s1.3xlarge (default): storage duration of 93 days.'."\n" + .'- cms.s1.6xlarge: storage duration of 185 days.'."\n" + .'- cms.s1.12xlarge: storage duration of 376 days.'."\n" ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'For the pricing of different storage duration specifications, see the **Pricing** section in [monitoring dashboard](~~223532~~).', + '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'], + 'type' => 'string', 'required' => false, - 'example' => '10', + 'docRequired' => false, + 'enum' => [], + 'example' => 'cms.s1.3xlarge', + 'title' => '', ], ], [ - 'name' => 'Total', + 'name' => 'NamespaceType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the total number of resources in the specified application group. Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The storage solution for monitoring data. Valid values:'."\n" + ."\n" + .'- aliyun_prometheus: monitoring data is stored in Managed Service for Prometheus.'."\n" + ."\n" + .'> For more information about storage solutions for monitoring data, see [Storage solutions for Hybrid Cloud Monitoring data](~~2594921~~).', 'type' => 'string', 'required' => false, 'example' => 'aliyun_prometheus', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'NamespaceRegion', 'in' => 'query', + 'schema' => ['description' => 'The region in which monitoring data is stored.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~2513265~~) operation.', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Namespace.Existed', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Create a metric repository', + 'summary' => 'Calls the CreateHybridMonitorNamespace operation to create a metric repository.', + 'description' => '## Before you begin'."\n" + .'Make sure that you have activated Hybrid Cloud Monitoring. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" + ."\n" + .'## Operation description'."\n" + .'This topic provides an example on how to create a metric repository named `aliyun` with a data storage duration of `cms.s1.3xlarge`. The response indicates that the metric repository is created.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2023-11-21T10:00:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-03-29T07:11:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorNamespace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateCustomNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Namespace.Existed\\",\\n \\"RequestId\\": \\"3843D23A-FB9E-5DC8-BCCC-458768B79296\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'CreateHybridMonitorSLSGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Keyword', + 'name' => 'SLSGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to search for resources.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'portal', - ], + 'schema' => ['description' => 'The name of the Logstore group.'."\n" + ."\n" + .'The name must be 2 to 32 characters in length and can contain uppercase letters, lowercase letters, digits, and underscores (_). The name must start with a letter.', 'type' => 'string', 'required' => true, 'example' => 'Logstore_test', 'title' => ''], ], [ - 'name' => 'InstanceIds', + 'name' => 'SLSGroupDescription', 'in' => 'query', + 'schema' => ['description' => 'The description of the Logstore group.', 'type' => 'string', 'required' => false, 'example' => 'Logstore group of Alibaba Cloud products.', 'title' => ''], + ], + [ + 'name' => 'SLSGroupConfig', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The resource ID. Separate multiple resource IDs with commas (,). You can query the details about a maximum of 20 resources at a time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-m5e0k0bexac8tykr****', + 'description' => 'The configurations of the Logstore group.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => ['description' => 'The region.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The project.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-project', 'title' => ''], + 'SLSLogstore' => ['description' => 'The Logstore.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'Logstore-ECS', 'title' => ''], + 'SLSUserId' => ['description' => 'The member ID.'."\n" + ."\n" + .'Valid values of N: 1 to 25.'."\n" + ."\n" + .'If you invoke this operation by using a management account, you can associate the Alibaba Cloud services of any member in the resource folder with Hybrid Cloud Monitoring through cloud native mode. You can use the resource folder to monitor the Alibaba Cloud services of multiple accounts.'."\n" + ."\n" + .'> If a member uses CloudMonitor for the first time, make sure that the member has been granted the authorization for the CloudMonitor service-linked role (AliyunServiceRoleForCloudMonitor). For more information, see [CloudMonitor service-linked role](~~170423~~).', 'type' => 'string', 'required' => false, 'example' => '120886317861****', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 30, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9FB8EA79-7279-4482-8D6D-3D28EEDD871A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The resources that are associated with the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'hostName', - ], - 'Dimension' => [ - 'description' => 'The dimensions of the resource that is associated with the application group.'."\n", - 'type' => 'string', - 'example' => '{"instanceId":"i-m5e0k0bexac8tykr****"}', - ], - 'Category' => [ - 'description' => 'The name of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'i-m5e0k0bexac8tykr****', - ], - 'NetworkType' => [ - 'description' => 'The network type.'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'Desc' => [ - 'description' => 'The resource description.'."\n", - 'type' => 'string', - 'example' => 'desc_test', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => 'The tag of the resource.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'instanceNetworkType', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'VPC', - ], - ], - ], - ], - ], - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'object', - 'properties' => [ - 'AvailabilityZone' => [ - 'description' => 'The zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-f', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - 'Vpc' => [ - 'description' => 'The VPC description.'."\n", - 'type' => 'object', - 'properties' => [ - 'VswitchInstanceId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-2ze36seq79n992****', - ], - 'VpcInstanceId' => [ - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-2zew7etgiceg21****', - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Duplicate.SLSGroup', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'Create a logstore group for SLS log metrics', + 'summary' => 'Creates a Logstore group for Hybrid Cloud Monitoring.', + 'description' => '### Before you begin'."\n" + .'Make sure that you have activated Simple Log Service (SLS) and created a project and a Logstore. For more information, see [Quick Start](~~54604~~).'."\n" + ."\n" + .'### Operation description'."\n" + .'This topic provides an example on how to create a Logstore group named `Logstore_test`. The region is `ap-southeast-1`, the project is `aliyun-project`, and the Logstore is `Logstore-ECS`. The response shows that the Logstore group is created.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-08-04T08:55:46.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorSLSGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateHybridMonitorSLSGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t1\\r\\n\\t30\\r\\n\\t7DB8DA3D-EDA6-46F8-9222-70C52416AE7D\\r\\n\\ttrue\\r\\n\\t200\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tvsw-2ze36seq79n992****\\r\\n\\t\\t\\t\\tvpc-2zew7etgiceg21****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t12345\\r\\n\\t\\t\\t\\t\\taliUid\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t26842\\r\\n\\t\\t\\t\\t\\tbid\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tVPC\\r\\n\\t\\t\\tRDS\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\tcn-hangzhou-MAZ8(f,g)\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t127067667954****\\r\\n\\t\\t\\ti-m5e0k0bexac8tykr****\\r\\n\\t\\t\\t{\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"rm-bp179a8xfaz4i****\\\\\\"}\\r\\n\\t\\t\\ttest_name\\r\\n\\t\\t\\ttest_name\\r\\n\\t\\t\\r\\n\\t\\r\\n","errorExample":""}]', - 'title' => 'DescribeMonitorGroupInstanceAttribute', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Duplicate.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'DeleteMonitorGroupDynamicRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateHybridMonitorTask' => [ + 'summary' => 'Creates a monitoring task for Alibaba Cloud services or Simple Log Service (SLS) logs in Hybrid Cloud Monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'For information about how to obtain the namespace name, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the monitoring task.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '阿里云产品数据接入任务。', 'title' => ''], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring task.'."\n" + ."\n" + .'- If `TaskType` is set to `aliyun_fc`, enter the name of the data import task for the Alibaba Cloud service.'."\n" + .'- If `TaskType` is set to `aliyun_sls`, enter the metric name for SLS logs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aliyun_task', 'title' => ''], + ], + [ + 'name' => 'TaskType', 'in' => 'query', 'schema' => [ - 'description' => 'The service to which the rule applies. Valid values: ecs, rds, and slb.'."\n", + 'description' => 'The type of the monitoring task. Valid values:'."\n" + ."\n" + .'- aliyun_fc: a data import task for Alibaba Cloud services.'."\n" + .'- aliyun_sls: a metric for SLS logs.', + 'enumValueTitles' => ['aliyun_fc' => 'aliyun_fc', 'aliyun_sls' => 'aliyun_sls'], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'ecs', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '56B4516A-EB44-4C66-8854-0393B35F636B', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', + 'example' => 'aliyun_fc', + 'title' => '', ], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + 'name' => 'CollectTargetType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the collection target for monitoring data.'."\n" + .'- If `TaskType` is set to `aliyun_fc`, enter `aliyun_fc`.'."\n" + .'- If `TaskType` is set to `aliyun_sls`, enter the name of the Logstore group for SLS logs.', 'type' => 'string', 'required' => true, 'example' => 'aliyun_fc', 'title' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', + 'name' => 'CollectInterval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The collection period of the metric. Valid values:'."\n" + ."\n" + .'- 15'."\n" + .'- 60 (default)'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'> This parameter is required only when `TaskType` is set to `aliyun_sls`.', + 'enumValueTitles' => [15 => '15', 60 => '60'], + 'type' => 'string', + 'required' => false, + 'example' => '60', + 'title' => '', ], ], [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The application group ID.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).'."\n" + ."\n" + .'> This parameter is required only when `TaskType` is set to `aliyun_sls`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '3607****', 'title' => ''], ], [ - [ - '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', - ], + 'name' => 'YARMConfig', + 'in' => 'query', + 'schema' => ['description' => 'The configuration file of the Alibaba Cloud service that is connected to Hybrid Cloud Monitoring.'."\n" + ."\n" + .'- namespace: the namespace of the Alibaba Cloud service. For information about how to query the namespace of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~).'."\n" + .'- metric_list: the metrics of the Alibaba Cloud service. For information about how to query the metrics of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~).'."\n" + ."\n" + .'The following example shows the configuration file:'."\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" + .'> This parameter is required only when `TaskType` is set to `aliyun_fc`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', 'title' => ''], ], - ], - '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":"\\n 56B4516A-EB44-4C66-8854-0393B35F636B\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'DeleteMonitorGroupDynamicRule', - 'summary' => 'Deletes a rule that is used to dynamically add the instances of a service to an application group.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMonitorGroupInstances' => [ - 'summary' => 'Removes instances from an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'TargetUserId', + 'in' => 'query', + 'schema' => ['description' => 'The member ID.'."\n" + ."\n" + .'When you invoke this operation by using a management account, you can use cloud native mode to connect Alibaba Cloud services of any member in the resource folder to Hybrid Cloud Monitoring. This allows you to implement cross-account unified monitoring of Alibaba Cloud services through the resource folder. Go to **Settings** to configure this feature in the CloudMonitor console.'."\n" + ."\n" + .'> This parameter is required only when `TaskType` is set to `aliyun_fc`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '120886317861****', 'title' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'AttachLabels', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', + 'description' => 'The labels of the metric.'."\n" + ."\n" + .'> This parameter is required only when `TaskType` is set to `aliyun_sls`.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The label value of the metric.', 'type' => 'string', 'required' => false, 'example' => 'testValue', 'title' => ''], + 'Name' => ['description' => 'The label key of the metric.', 'type' => 'string', 'required' => false, 'example' => 'app_service', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InstanceIdList', + 'name' => 'TargetUserIdList', 'in' => 'query', - 'schema' => [ - 'description' => 'The instances to be removed from the application group. Separate multiple instances with commas (,). You can remove a maximum of 20 instances from an application group at a time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-a2d5q7pm3f912****,i-a2d5q7pm3f222****', - ], + 'schema' => ['description' => 'The member IDs. Separate multiple member IDs with commas (,).'."\n" + ."\n" + .'> This parameter is required only when you call this operation by using a management account.', 'type' => 'string', 'required' => false, 'example' => '120886317861****', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'SLSProcessConfig', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" + 'description' => 'The SLS log configuration.'."\n" ."\n" - .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + .'> This parameter is required only when `TaskType` is set to `aliyun_sls`.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5351B0F2-26A9-4BC9-87FF-1B74034D12C3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - '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":"\\n C5C6924C-237E-40B2-9510-41BF8F671102\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'DeleteMonitorGroupInstances', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupCategories' => [ - 'summary' => 'Queries the cloud services to which the resources in an application group belong and the number of resources that belong to each cloud service in the application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'Filter' => [ + 'description' => 'The filter conditions for parameters in SLS logs.', + 'type' => 'object', + 'properties' => [ + 'Relation' => [ + 'description' => 'The relationship between multiple filter conditions. Valid values:'."\n" + ."\n" + .'- and (default): Logs are processed only when all filter conditions are met.'."\n" + .'- or: Logs are processed when any filter condition is met.', + 'enumValueTitles' => ['or' => 'or', 'and' => 'and'], + 'type' => 'string', + 'required' => false, + 'example' => 'and', + 'title' => '', + ], + 'Filters' => [ + 'description' => 'The list of filter conditions for parameters in SLS logs.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter to filter in SLS logs.', 'type' => 'string', 'required' => false, 'example' => 'code', 'title' => ''], + 'Operator' => [ + 'description' => 'The filter method for parameter values in SLS logs. Valid values:'."\n" + .'- `contain`: contains.'."\n" + .'- `notContain`: does not contain.'."\n" + .'- `>`: greater than.'."\n" + .'- `<`: less than.'."\n" + .'- `=`: equal to.'."\n" + .'- `!=`: not equal to.'."\n" + .'- `>=`: greater than or equal to.'."\n" + .'- `<=`: less than or equal to.', + 'type' => 'string', + 'enum' => ['>', '>=', '=', '<=', '<', '!=', 'contain', 'notContain'], + 'required' => false, + 'example' => '=', + 'title' => '', + ], + 'Value' => ['description' => 'The filter value of the parameter in SLS logs.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Statistics' => [ + 'description' => 'The statistical method for SLS logs.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter for SLS log statistics.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'Aggregates log data within the statistical period based on the selected statistical method. Valid values:'."\n" + .'- count: counts the number of occurrences.'."\n" + .'- sum: calculates the sum.'."\n" + .'- avg: calculates the average.'."\n" + .'- max: returns the maximum value.'."\n" + .'- min: returns the minimum value.'."\n" + .'- value: samples within the period.'."\n" + .'- countps: calculates the per-second average of the count for the specified field within the statistical period.'."\n" + .'- sumps: calculates the per-second average of the sum for the specified field within the statistical period.'."\n" + .'- distinct: calculates the number of occurrences of the specified field after deduplication within the statistical period.'."\n" + .'- distribution: calculates the number of occurrences of field values within a specified range.'."\n" + .'- percentile: calculates the distribution value of field values, such as P50.', 'type' => 'string', 'required' => false, 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the SLS log statistical result.', 'type' => 'string', 'minLength' => 0, 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'level_count', 'title' => ''], + 'Parameter1' => ['description' => 'The statistical value of SLS logs.'."\n" + ."\n" + .'- If `Function` is set to `distribution`, this parameter specifies the lower limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 200.'."\n" + ."\n" + .'- If `Function` is set to `percentile`, this parameter specifies the percentile of the statistical distribution. For example, 0.5 indicates P50.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + 'Parameter2' => ['description' => 'The statistical value of SLS logs.'."\n" + ."\n" + .'> This parameter is required only when `Function` is set to `distribution`. This parameter specifies the upper limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 299.', 'type' => 'string', 'required' => false, 'example' => '299', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'GroupBy' => [ + 'description' => 'Aggregates data by spatial dimension, which is equivalent to Group By in SQL.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter for SLS log statistics.', 'type' => 'string', 'required' => false, 'example' => 'code', 'title' => ''], + 'Alias' => ['description' => 'The alias of the SLS log statistical result.', 'type' => 'string', 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'ApiResult', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Express' => [ + 'description' => 'The arithmetic operation result of the extended field for SLS log statistical results.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Express' => ['description' => 'The arithmetic operation result of the extended field for SLS log statistical results.', 'type' => 'string', 'required' => false, 'example' => 'success_count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the arithmetic operation result of the extended field for SLS log statistical results.', 'type' => 'string', 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'SuccRate', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'CloudAccessId', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', + 'description' => 'The list of primary account IDs of other cloud providers that are connected to CloudMonitor.', + 'type' => 'array', + 'items' => ['description' => 'The primary account ID of another cloud provider that is connected to CloudMonitor.', 'type' => 'string', 'required' => false, 'example' => 'n5n9ik1b****', 'title' => ''], + 'required' => false, + 'maxItems' => 50, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9E0347B0-EBC3-4769-A78D-D96F21C6BB52', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MonitorGroupCategories' => [ - 'description' => 'The cloud services to which the resources in the application group belong and the number of resources that belong to the cloud service.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'MonitorGroupCategory' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CategoryItem' => [ - 'description' => 'The cloud services to which the resources in the application group belong and the number of resources that belong to the cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The number of resources that belong to the cloud service.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Category' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'yamlConfigFail', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '28CEA2E0-3E90-51B2-A7E8-B1ED75534E49', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'TaskId' => ['description' => 'The monitoring task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '36****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"yamlConfigFail\\",\\n \\"RequestId\\": \\"28CEA2E0-3E90-51B2-A7E8-B1ED75534E49\\",\\n \\"Success\\": \\"true\\",\\n \\"TaskId\\": 0\\n}","type":"json"}]', + 'title' => 'Create a monitoring task', + 'description' => '## Operation description'."\n" + .'- Before calling this operation, make sure that Hybrid Cloud Monitoring is activated.'."\n" + .'- To create a metric for SLS logs, make sure that SLS is activated and that a project and a Logstore are created.'."\n" + .'- Depending on the value of `TaskType`, some parameters are required. For example, if `TaskType` is set to `aliyun_fc`, you must configure `YARMConfig`. If `TaskType` is set to `aliyun_sls`, you must configure parameters such as `CollectInterval`.'."\n" + .'- For cross-account operations, specify `TargetUserId` or `TargetUserIdList` to connect resources of other members to Hybrid Cloud Monitoring.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2023-12-21T08:28:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-27T07:31:04.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-09T09:38:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-09T02:41:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-09T02:41:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorTask'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateHybridMonitorTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\tB7C9F725-E743-4F2E-81A2-4CC19783DC42\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tECS\\r\\n\\t\\t\\t\\t39\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t123456\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeMonitorGroupCategories', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'PutMonitorGroupDynamicRule' => [ - 'summary' => 'Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateInstantSiteMonitor' => [ + 'summary' => 'Creates a one-time site monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The URL or IP address of the monitoring node.', 'type' => 'string', 'required' => true, 'example' => 'http://www.aliyun.com', 'title' => ''], ], [ - 'name' => 'GroupRules', + 'name' => 'TaskType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'FilterRelation' => [ - 'description' => 'The logical operator used between conditional expressions in the alert rule. Valid values of N: 1 to 3. Valid values:'."\n" - ."\n" - .'* and: The instances that meet all the conditional expressions are automatically added to the application group.'."\n" - .'* or: The instances that meet one of the conditional expressions are automatically added to the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'and', - ], - 'Filters' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The value to be matched with the specified field. Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'nginx', - ], - 'Name' => [ - 'description' => 'The name of the field based on which instances are filtered. Valid values of N: 1 to 3.'."\n" - ."\n" - .'Only hostnames are supported. Example: hostName.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hostName', - ], - 'Function' => [ - 'description' => 'The method that is used to filter instances. Valid values of N: 1 to 3. Valid values:'."\n" - ."\n" - .'* contains: contains'."\n" - .'* notContains: does not contain'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'contains', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], - 'Category' => [ - 'description' => 'The cloud service to which the alert rule is applied. Valid values of N: 1 to 3. Valid values:'."\n" - ."\n" - .'* ecs: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The type of the monitoring node.'."\n" + .'Valid values: HTTP, PING, TCP, UDP, and DNS.', 'type' => 'string', 'required' => true, 'example' => 'HTTP', 'title' => ''], ], [ - 'name' => 'IsAsync', + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring node.'."\n" + ."\n" + .'The name must be 4 to 100 characters in length and can contain letters, digits, underscores (_), and Chinese characters.'."\n" + ."\n\n" + .'The name must be 4 to 100 characters in length and can contain letters, digits, and underscores (_).'."\n" + ."\n" + .'The name must be 4 to 100 characters in length and can contain letters, digits, and underscores (_).', 'type' => 'string', 'required' => true, 'example' => 'task1', 'title' => ''], + ], + [ + 'name' => 'IspCities', + 'in' => 'query', + 'schema' => ['description' => 'The detection point information. If this parameter is left empty, the system randomly selects three detection points.'."\n" + ."\n" + .'The value is in `JSONArray` format. Example: [{"city":"546","isp":"465", "type":"IDC"},{"city":"572","isp":"465", "type":"LASTMILE"},{"city":"738","isp":"465"}], which correspond to Beijing, Hangzhou, and Qingdao respectively.'."\n" + ."\n" + .'The type parameter specifies the detection point type. When AgentGroup is set to PC, valid values are IDC and LASTMILE. IDC indicates detection points with deployment in data centers. LASTMILE indicates detection points with deployment in end-user homes that use fixed-line networks. The type parameter is an optional options. Default value: IDC. When AgentGroup is set to MOBILE, this parameter does not need to be specified.'."\n" + ."\n" + .'For information about how to obtain detection point information, see [DescribeSiteMonitorISPCityList](~~115045~~).'."\n" + ."\n" + .'> You must specify either `IspCities` or `RandomIspCity`.', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', 'title' => ''], + ], + [ + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => ['description' => 'The advanced extension options for the protocol type of the monitoring node. Different protocol types correspond to different extension options.', 'type' => 'string', 'required' => false, 'example' => '{"time_out":5000}', 'title' => ''], + ], + [ + 'name' => 'RandomIspCity', + 'in' => 'query', + 'schema' => ['description' => 'The number of detection points.'."\n" + ."\n" + .'> - You must specify either `IspCities` or `RandomIspCity`.- If you configure the Settings for the `RandomIspCity` parameter, the `IspCities` parameter automatically becomes invalid.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AgentGroup', 'in' => 'query', 'schema' => [ - 'description' => 'The mode for creating the alert rule. Valid values:'."\n" - ."\n" - .'* true: creates asynchronously'."\n" - .'* false (default): creates synchronously'."\n", - 'type' => 'boolean', + 'description' => 'The type of detection point. Valid values: PC and MOBILE. PC indicates fixed-line network detection points. MOBILE indicates mobile terminal detection points. Default value: PC.', + 'type' => 'string', + 'enum' => ['PC', 'MOBILE'], 'required' => false, - 'example' => 'false', + 'example' => 'PC', + 'title' => '', ], ], ], @@ -3304,805 +2791,763 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - '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' => '3E73F1AB-D195-438A-BCA7-2F4355789C58', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + .'* true: Successful.'."\n" + .'* false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'CreateResultList' => [ + 'description' => 'The result list of the one-time site monitoring node.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result list of the one-time site monitoring node.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The monitoring node ID.', 'type' => 'string', 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', 'title' => ''], + 'TaskName' => ['description' => 'The monitoring node name.', 'type' => 'string', 'example' => 'task1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address', 'description' => ''], + ['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed', 'description' => ''], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist', 'description' => ''], + ['errorCode' => 'OperatorInvalid', 'errorMessage' => 'Operator invalid', 'description' => ''], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid', 'description' => ''], + ['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat', 'description' => ''], + ['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error', 'description' => ''], + ['errorCode' => 'NameNotExists', 'errorMessage' => 'Task name not exists', 'description' => ''], + ['errorCode' => 'Illegal Task Name', 'errorMessage' => 'The task name of the sitemonitor task is illegal.', 'description' => 'Site monitoring task name is illegal.'], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'Forbidden', 'errorMessage' => '%s', 'description' => ''], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], ], 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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t3E73F1AB-D195-438A-BCA7-2F4355789C58\\n\\ttrue\\n\\t200\\n\\t","errorExample":""}]', - 'title' => 'PutMonitorGroupDynamicRule', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Create a one-time site monitoring task', + 'description' => 'Only Alibaba Cloud accounts that have activated Network Analysis and Monitoring can create one-time site monitoring tasks.'."\n" + ."\n" + .'This topic provides an example of how to create a one-time site monitoring task. The task name is `task1`, the monitored address is `http://www.China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China.', + 'requestParamsDescription' => '## Advanced metric description for TaskType'."\n" + ."\n" + .'The following tables describe how to configure the Settings for the advanced parameters for HTTP, PING, TCP, UDP, and DNS in `TaskType`.'."\n" + ."\n" + .'- HTTP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|http_method |String |The HTTP request method. Valid values: GET, POST, and HEAD. Default value: GET. |'."\n" + .'|header |String |Custom HTTP headers separated by line breaks (\\n).
Each header line must conform to the HTTP protocol (key-value pairs separated by a colon). |'."\n" + .'|cookie |String |The cookie, which follows the standard HTTP request format. |'."\n" + .'|request_content |String |The request content. Two formats are supported: JSON and form. If this parameter is not specified, the request does not contain a body. |'."\n" + .'|response_content |String |The expected response content. During monitoring, the first 64 bytes returned by the HTTP server are checked. |'."\n" + .'|match_rule |String |0: The monitoring succeeds if the response does not contain response_content.
1: The monitoring succeeds if the response contains response_content. |'."\n" + .'|username |String |If a username is provided, a BasicAuth header is included in the HTTP request. |'."\n" + .'|password |String |The HTTP request authentication password. |'."\n" + .'|time_out |int |The timeout period. Unit: milliseconds. Default value: 30000. |'."\n" + .'|max_redirect |int |The maximum number of redirects. The default value is 5 for ECS probes and 2 for carrier detection points.
To disable redirects, set this parameter to 0.
Valid values: 0 to 50. |'."\n" + ."\n" + .' '."\n" + .'- PING'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|failure_rate |int |If the PING failure rate exceeds this value, the monitoring is failed and returns 610 (PingAllFail) or 615 (PingPartialFail).
Default value: 0.1. |'."\n" + .'|ping_num |int |The number of PING attempts. Default value: 20.
Valid values: 1 to 100. |'."\n" + ."\n" + .'- TCP or UDP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |The port of the TCP or UDP server. |'."\n" + .'|request_content |string |The request content. When request_format is set to hex, the request_content value is in hexadecimal compact format. |'."\n" + .'|request_format |string |When request_format is set to other values, request_content is sent to the TCP or UDP server as a plain character string. |'."\n" + .'|response_content |string |The response content. If the content returned by the TCP or UDP server does not contain response_content, the monitoring is failed.
When response_format is set to hex, the response_content value is in hexadecimal compact format.
When response_content is set to other values, response_content is a plain character string. |'."\n" + ."\n" + .'- DNS'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|dns_server |string |The DNS server address, which can be a domain name or IP address. |'."\n" + .'|dns_type |string |The DNS query type. Valid values: A, NS, CNAME, MX, TXT, and ANY. |'."\n" + .'|expect_value |string |The list of expected values separated by whitespace. |'."\n" + .'|match_rule |string |The relationship between the expected value list and the DNS list. If the specified relationship is not met, the monitoring is failed.
Empty string or IN_DNS: The expected value list is a subset of the DNS list.
DNS_IN: The DNS list is a subset of the expected value list.
EQUAL: The DNS list is equal to the expected value list.
ANY: The DNS list and the expected value list have a non-empty intersection. |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateGroupMonitoringAgentProcess' => [ - 'summary' => 'Creates a process monitoring task for an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-08-22T03:53:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-07T12:32:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-07T08:50:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-29T08:05:31.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-22T09:29:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-12-01T09:58:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstantSiteMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateInstantSiteMonitor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateMetricRuleBlackList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For more information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The name of the blacklist policy.', 'type' => 'string', 'required' => true, 'example' => 'Blacklist-01', 'title' => ''], ], [ - 'name' => 'ProcessName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'MatchExpressFilterRelation', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" - ."\n" - .'* all'."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'and', - ], + 'schema' => ['description' => 'The category of the cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'MatchExpress', + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => ['description' => 'The effective scope of the blacklist policy. Valid values:'."\n" + ."\n" + .'- USER (default): The blacklist policy takes effect only for the current Alibaba Cloud account.'."\n" + ."\n" + .'- GROUP: The blacklist policy takes effect only for the specified application group. For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], + ], + [ + 'name' => 'ScopeValue', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group. The value of this parameter is a JSON array.'."\n" + ."\n" + .'> This parameter must be specified when `ScopeType` is set to `GROUP`.', 'type' => 'string', 'required' => false, 'example' => '["67****","78****"]', 'title' => ''], + ], + [ + 'name' => 'EnableStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp when the blacklist policy starts to take effect.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640237400000', 'title' => ''], + ], + [ + 'name' => 'EnableEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp when the blacklist policy expires.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640608200000', 'title' => ''], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => ['description' => 'The time range within which the blacklist policy is effective.'."\n" + ."\n" + .'- If you do not configure this parameter, the blacklist policy is permanently effective.'."\n" + ."\n" + .'- If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples:'."\n" + ."\n" + .' - `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded.'."\n" + ."\n" + .' - `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.', 'type' => 'string', 'required' => false, 'example' => '03:00-04:59', 'title' => ''], + ], + [ + 'name' => 'Instances', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The expressions used to match instances.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", + 'description' => 'The IDs of the instances that belong to the specified cloud service.', 'type' => 'array', - 'items' => [ - 'description' => 'The expression used to match instances.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The keyword used to match the instance name.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'portalHost', - ], - 'Name' => [ - 'description' => 'The criteria based on which the instances are matched.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n" - ."\n" - .'> Set the value to name. The value name indicates that the instances are matched based on the instance name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name1', - ], - 'Function' => [ - 'description' => 'The matching condition. Valid values:'."\n" - ."\n" - .'* all (default value): matches all'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* contains: contains'."\n" - .'* notContains: does not contain'."\n" - .'* equals: equals'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'startWith', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 3, + 'items' => ['description' => 'The IDs of the instances that belong to the specified cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 100.', 'type' => 'string', 'required' => false, 'example' => '{"instanceId":"i-bp1ew0zfkjblsuwx****"}', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AlertConfig', + 'name' => 'Metrics', 'in' => 'query', - 'style' => 'flat', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The alert rule configurations.'."\n" + 'description' => 'The metrics of the instance.'."\n" + ."\n" + .'- If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service.'."\n" ."\n" - .'Valid values of N: 1 to 3.'."\n", + .'- If you configure this parameter, the blacklist policy applies only to the current metric.', 'type' => 'array', 'items' => [ - 'description' => 'The alert rule configuration.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n" - ."\n" - .'> Only one alert notification is sent during a mute period even if the metric value exceeds the alert threshold during consecutive checks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86400', - 'default' => '86400', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], - 'Times' => [ - 'description' => 'The number of times for which the threshold can be consecutively exceeded. Default value: 3.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n" - ."\n" - .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'EscalationsLevel' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* critical (default)'."\n" - .'* warn'."\n" - .'* info'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'warn', - ], - 'EffectiveInterval' => [ - 'description' => 'The period of time during which the alert rule is effective.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5', - ], - 'Statistics' => [ - 'description' => 'The statistical aggregation method that is used to calculate the metric values.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n" - ."\n" - .'> Set the value to Average.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Average', - ], - 'TargetList' => [ - 'description' => 'The alert triggers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert trigger.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n" - ."\n" - .'For more information about how to obtain the ID of a resource for which alerts are triggered, see [DescribeMetricRuleTargets](~~121592~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" - ."\n" - .'For more information about how to query the ARN of a resource, see [DescribeMetricRuleTargets](~~121592~~).'."\n" - ."\n" - .'Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource that triggers the alert. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'MetricName' => ['description' => 'The metric name.'."\n" + ."\n" + .'Valid values of N: 1 to 10.', 'type' => 'string', 'required' => true, 'example' => 'disk_utilization', 'title' => ''], + 'Resource' => ['description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n" + ."\n" + .'Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => '{"device":"C:"}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - 'maxItems' => 3, + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3F6150F9-45C7-43F9-9578-A58B2E726C90', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'description' => 'The group process information.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupProcessId' => [ - 'description' => 'The ID of the group process.'."\n", - 'type' => 'string', - 'example' => '7F2B0024-4F21-48B9-A764-211CEC48****', - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5C637FA3-3959-3352-8BE6-78CE2ED2D33D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The ID of the blacklist policy.', 'type' => 'string', 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'CreateMetricRuleBlackList', + 'summary' => 'Creates a blacklist policy.', + 'description' => '### Background information'."\n" + ."\n" + .'- CloudMonitor blocks alert notifications based on the blacklist policies that take effect. To block alert notifications when the value of a metric that belongs to a cloud service reaches the threshold that you specified, add the metric to a blacklist policy.'."\n" + ."\n" + .'- CloudMonitor allows you to create blacklist policies only based on threshold metrics. You cannot create blacklist policies based on system events. For more information about the cloud services and the thresholds of the metrics that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2023-04-23T03:09:37.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleBlackList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n 200\\n 718FEA81-64C3-4F23-8F90-0531F7489FC1\\n true\\n \\n 7F2B0024-4F21-48B9-A764-211CEC48****\\n \\n","errorExample":""}]', - 'title' => 'CreateGroupMonitoringAgentProcess', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'ModifyGroupMonitoringAgentProcess' => [ - 'summary' => '修改应用分组内的进程监控', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateMetricRuleResources' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the process monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '92E3065F-0980-4E31-9AA0-BA6****', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'i-2ze3w55tr2rcpejpcfap_59c96b85-0339-4f35-ba66-ae4e34d3****', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Overwrite', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6780****', - ], + 'schema' => ['description' => 'Specifies whether to overwrite. Valid values:'."\n" + ."\n" + .'- true: overwrites. The resources submitted this time overwrite the previously associated resources. That is, full modification is performed.'."\n" + ."\n" + .'- false: does not overwrite. The resources submitted this time do not overwrite the previously associated resources (the associated resources are the historical associated resources plus the resources submitted this time). That is, incremental modification is performed.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'MatchExpressFilterRelation', + 'name' => 'Resources', 'in' => 'query', + 'schema' => ['description' => 'The associated resources. The value is in the JSON array format.'."\n" + .'> A maximum of 100 resource instances can be added at a time, and an alert rule can be associated with a maximum of 3,000 instances.'."\n" + .'>', 'type' => 'string', 'required' => true, 'example' => '[{"instanceId":"i-a2d5q7pm3f9yr29e****"}]', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" - ."\n" - .'* all'."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'and', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'> The value 200 indicates success.'."\n" + .'>', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0671A721-0D7A-4F11-BB77-2416325D65AB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. The value true indicates success, and the value false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], [ - 'name' => 'AlertConfig', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The alert rule configurations.', - 'type' => 'array', - 'items' => [ - 'description' => 'The alert rule configurations.', - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" - ."\n" - .'> Only one alert notification is sent during a mute period even if the metric value exceeds the alert threshold during consecutive checks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86400', - ], - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold.'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday.'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Webhook' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], - 'Times' => [ - 'description' => 'The number of times for which the threshold can be consecutively exceeded. Valid values of N: 1 to 200. Default value: 3.'."\n" - ."\n" - .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'EscalationsLevel' => [ - 'description' => 'The level of the alert. Valid values of N: 1 to 200. Valid values:'."\n" - ."\n" - .'* critical (default value): critical'."\n" - .'* warn: warning'."\n" - .'* info: information'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'warn', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-22:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '23:00-23:59', - ], - 'Threshold' => [ - 'description' => 'The alert threshold. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5', - ], - 'Statistics' => [ - 'description' => 'The statistical aggregation method that is used to calculate the metric values. Valid values of N: 1 to 200.'."\n" - ."\n" - .'> Set the value to Average.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'TargetList' => [ - 'description' => 'The alert trigger.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert trigger.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n" - ."\n" - .'For information about how to obtain the ID of a resource for which alerts are triggered, see [DescribeMetricRuleTargets](~~121592~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" - ."\n" - .'For information about how to obtain the ARN of a resource, see [DescribeMetricRuleTargets](~~121592~~).'."\n" - ."\n" - .'Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'- {Service name abbreviation}: the abbreviation of the service name. Valid value: mns.'."\n" - .'- {userId}: the ID of the Alibaba Cloud account.'."\n" - .'- {regionId}: the region ID of the message queue or topic.'."\n" - .'- {Resource type}: the type of the resource for which alerts are triggered. Valid values: '."\n" - .' - **queues** '."\n" - .' - **topics** '."\n" - .'- {Resourcename}: the name of the resource. '."\n" - .' - If the resource type is set to **queues**, the resource name is the name of the message queue. '."\n" - .' - If the resource type is set to **topics**, the resource name is the name of the topic.`', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* INFO: information'."\n" - .'* WARN: warning'."\n" - .'* CRITICAL: critical'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Create a resource associated with an alert rule', + 'summary' => 'Calls the CreateMetricRuleResources operation to create a resource associated with an alert rule.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleResources'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMetricRuleResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0671A721-0D7A-4F11-BB77-2416325D65AB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateMetricRuleTemplate' => [ + 'summary' => 'Creates an alert template.', + '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' => 'The name of the alert template.', 'type' => 'string', 'required' => true, 'example' => 'Template1', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the alert template.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Template1', 'title' => ''], + ], + [ + 'name' => 'AlertTemplates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details of the alert template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert template.', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => ['description' => 'The threshold for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.', 'type' => 'string', 'required' => false, 'example' => 'http://ww.aliyun.com', 'title' => ''], + 'Escalations.Warn.Threshold' => ['description' => 'The threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of monitoring data. Unit: seconds.'."\n" + ."\n" + .'The default value is the minimum aggregation period. Generally, you do not need to specify the minimum aggregation period.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => true, 'example' => 'ECS_Rule1', 'title' => ''], + 'Escalations.Critical.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Selector' => ['description' => 'The dimension of the alert. It is an extended field.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied.'."\n" + ."\n" + .'> For more information about the values of extended fields, see [DescribeMetricRuleTemplateAttribute](~~114979~~).', 'type' => 'string', 'required' => false, 'example' => '{"disk":"/"}', 'title' => ''], + 'Escalations.Info.Statistics' => ['description' => 'The statistical method for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Escalations.Info.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + 'Escalations.Critical.Threshold' => ['description' => 'The threshold for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'Escalations.Critical.Statistics' => ['description' => 'The statistical method for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Critical.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Warn.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Info.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Escalations.Warn.Statistics' => ['description' => 'The statistical method for the Warn-level alert.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - 'maxItems' => 3, + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'N/A.', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9763ED1A-4D09-41BF-851E-310421750204', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The ID of the alert template.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'not allow this operation.', 'description' => 'No permission'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => 'Resources over limit.', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalFailure', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t\\t7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'ModifyGroupMonitoringAgentProcess', + 'title' => 'CreateMetricRuleTemplate', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteGroupMonitoringAgentProcess' => [ - 'summary' => 'Deletes a process monitoring task for an application group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleTemplate'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMetricRuleTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateMonitorAgentProcess' => [ + 'summary' => 'Creates a task to monitor a process.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The process name.', 'type' => 'string', 'required' => true, 'example' => 'AliYunDun', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the process monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '48F83746-C817-478C-9B06-7158F56B****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-2ze2d6j5uhg20x47****', 'title' => ''], + ], + [ + 'name' => 'ProcessUser', + 'in' => 'query', + 'schema' => ['description' => 'The user who launches the process.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], ], 'responses' => [ @@ -4110,502 +3555,249 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3F6150F9-45C7-43F9-9578-A58B2E726C90', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The process ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t\\t7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'DeleteGroupMonitoringAgentProcess', + 'title' => 'CreateMonitorAgentProcess', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeGroupMonitoringAgentProcess' => [ - 'summary' => 'Queries the process monitoring tasks for an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateMonitorGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'example' => 'ECS_Group', 'title' => ''], ], [ - 'name' => 'ProcessName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sshd', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '30', - ], + 'schema' => ['description' => 'The alert contact group. The alert notifications of the application group are sent to the alert contacts that belong to the alert contact group.'."\n" + ."\n" + .'> An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~PutContact~~) and [PutContactGroup](~~PutContactGroup~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Alert_Group', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status codes.'."\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 Request is not authorization.', - ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: 1'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'string', - 'example' => '28', - ], - 'Processes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Process' => [ - 'description' => 'The process monitoring tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The process monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProcessName' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'example' => 'sshd', - ], - 'MatchExpressFilterRelation' => [ - 'description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" - ."\n" - .'* all'."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'Id' => [ - 'description' => 'The ID of the process monitoring task.'."\n", - 'type' => 'string', - 'example' => '3F6150F9-45C7-43F9-9578-A58B2E72****', - ], - 'MatchExpress' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MatchExpress' => [ - 'description' => 'The matching conditions.'."\n" - ."\n" - .'> Only the instances that meet the conditional expressions are monitored by the process monitoring task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The keyword used to match the instance name.'."\n", - 'type' => 'string', - 'example' => 'portalHost', - ], - 'Name' => [ - 'description' => 'The criteria based on which the instances are matched.'."\n" - ."\n" - .'> Set the value to `name`. The value name indicates that the instances are matched based on the instance name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The matching condition. Valid values:'."\n" - ."\n" - .'* all (default): matches all'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* contains: contains'."\n" - .'* notContains: excludes'."\n" - .'* equals: equals'."\n" - ."\n" - .'> The matched instances are monitored by the process monitoring task.'."\n", - 'type' => 'string', - 'example' => 'all', - ], - ], - ], - ], - ], - ], - 'AlertConfig' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AlertConfig' => [ - 'description' => 'The alert rule configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert rule configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday.'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" - ."\n" - .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'Webhook' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'Times' => [ - 'description' => 'The number of times for which the threshold can be consecutively exceeded.'."\n" - ."\n" - .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'EscalationsLevel' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* critical'."\n" - .'* warn'."\n" - .'* Info'."\n", - 'type' => 'string', - 'example' => 'warn', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n", - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '5', - ], - 'Statistics' => [ - 'description' => 'The method used to calculate metric values that trigger alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'TargetList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Target' => [ - 'description' => 'The resources for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource for which alerts are triggered.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message. Example: acs:mns:cn-hangzhou:120886317861\\*\\*\\*\\*:/queues/test123/message. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'CRITICAL', - ], - 'JsonParmas' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '83C89BA6-ABD4-4398-A175-83E86C47A001', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'not allow this operation.', 'description' => 'No permission'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => 'Resources over limit.', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t\\t7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\r\\n\\t\\t10\\r\\n\\t\\t1\\r\\n\\t\\t28\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tsshd\\r\\n\\t\\t\\t\\tand\\r\\n\\t\\t\\t\\t3F6150F9-45C7-43F9-9578-A58B2E72****\\r\\n\\t\\t\\t\\t12345\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tall\\r\\n\\t\\t\\t\\t\\t\\tportalHost\\r\\n\\t\\t\\t\\t\\t\\tname\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\t00:00-23:59\\r\\n\\t\\t\\t\\t\\t\\t86400\\r\\n\\t\\t\\t\\t\\t\\tGreaterThanOrEqualToThreshold\\r\\n\\t\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\t\\thttp://www.aliyun.com\\r\\n\\t\\t\\t\\t\\t\\t00:00-23:59\\r\\n\\t\\t\\t\\t\\t\\twarn\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tall\\r\\n\\t\\t\\t\\t\\t\\tportalHost\\r\\n\\t\\t\\t\\t\\t\\tname\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\t00:00-23:59\\r\\n\\t\\t\\t\\t\\t\\t86400\\r\\n\\t\\t\\t\\t\\t\\tGreaterThanOrEqualToThreshold\\r\\n\\t\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\t\\thttp://www.aliyun.com\\r\\n\\t\\t\\t\\t\\t\\t00:00-23:59\\r\\n\\t\\t\\t\\t\\t\\twarn\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n\\r\\n","errorExample":""}]', - 'title' => 'DescribeGroupMonitoringAgentProcess', - 'description' => 'You can create a process monitoring task to monitor all or the specified Elastic Compute Service (ECS) instances in an application group and configure alert rules for the process monitoring task.'."\n", + 'title' => 'CreateMonitorGroup', + 'summary' => 'Creates an application group.', + 'description' => 'In this example, an application group named `ECS_Group` is created.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMonitorGroupNotifyPolicy' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateMonitorGroupByResourceGroupId' => [ + 'summary' => 'Creates an application group by using a resource group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PolicyType', + 'name' => 'EnableSubscribeEvent', 'in' => 'query', - 'schema' => [ - 'description' => 'The policy type. Valid value: PauseNotify.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PauseNotify', - 'enum' => [ - 'PauseNotify', - ], - ], + 'schema' => ['description' => 'Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values:'."\n" + ."\n" + .'- true: The application group automatically subscribes to event notifications.'."\n" + ."\n" + .'- false (default): The application group does not automatically subscribe to event notifications.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EnableInstallAgent', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7301****', - ], + 'schema' => ['description' => 'Specifies whether the CloudMonitor agent is automatically installed for the application group. CloudMonitor determines whether to automatically install the CloudMonitor agent for the hosts in an application group based on the value of this parameter. Valid values:'."\n" + ."\n" + .'- true: The CloudMonitor agent is automatically installed.'."\n" + ."\n" + .'- false (default): The CloudMonitor agent is not automatically installed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the validity period for the policy.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1622949300000', - ], + 'schema' => ['description' => 'The ID of the region where the resource group resides.'."\n" + ."\n" + .'For information about how to obtain the ID of the region where a resource group resides, see [GetResourceGroup](~~158866~~).', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group.'."\n" + ."\n" + .'For information about how to obtain the ID of a resource group, see [ListResourceGroups](~~158855~~).', 'type' => 'string', 'required' => true, 'example' => 'rg-acfmw3ty5y7****', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'For information about how to obtain the name of a resource group, see [ListResourceGroups](~~158855~~).', 'type' => 'string', 'required' => true, 'example' => 'CloudMonitor', 'title' => ''], + ], + [ + 'name' => 'ContactGroupList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end time of the validity period for the policy.'."\n" + 'description' => 'The alert contact groups. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" + ."\n" + .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).', + 'type' => 'array', + 'items' => ['description' => 'The alert contact group. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', + .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], 'required' => true, - 'example' => '1623208500000', + 'example' => 'ECS_Group', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -4614,572 +3806,359 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '13356BCA-3EC3-4748-A771-2064DA69AEF1', - ], - 'Result' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '784CAB3C-F613-5BCE-8469-6DCB29B18A20', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '3607****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 4092 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'ResourceGroupId already create group', 'description' => ''], ], ], - '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":"\\n\\t\\t13356BCA-3EC3-4748-A771-2064DA69AEF1\\n\\t\\t1\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'CreateMonitorGroupNotifyPolicy', - 'summary' => 'Creates a policy to pause alert notifications for an application group.', - 'description' => 'If the policy is valid, no alert notifications are sent for the application group.'."\n" - ."\n" - .'This topic describes how to create a `PauseNotify` policy to pause alert notifications for the `7301****` application group. The StartTime parameter is set to `1622949300000` and the EndTime parameter is set to `1623208500000`. This indicates that the policy is valid from `2021-06-06 11:15:00 UTC+8` to `2021-06-09 11:15:00 UTC+8`.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'CreateMonitorGroupByResourceGroupId', + 'description' => 'This topic provides an example on how to create an application group by using the resource group `CloudMonitor` and the alert contact group `ECS_Group`. The region ID of the resource group is `cn-hangzhou`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMonitorGroupNotifyPolicy' => [ - 'summary' => 'Deletes a policy that is used to pause alert notifications for an application group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-10-25T07:45:36.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupByResourceGroupId'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'security' => [ + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorGroupByResourceGroupId', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateMonitorGroupInstances' => [ + 'summary' => 'Adds resources to an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PolicyType', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the policy.'."\n" - ."\n" - .'Valid value: PauseNotify.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PauseNotify', - 'enum' => [ - 'PauseNotify', - ], - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Instances', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6780****', + 'description' => 'The instances that you want to add to the application group.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'test-instance-ecs', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the Alibaba Cloud service name.'."\n" + ."\n" + .'To obtain the abbreviation of an Alibaba Cloud service name, call the [DescribeProjectMeta](~~114916~~) operation. The `metricCategory` tag in the `Labels` response parameter indicates the abbreviation of the Alibaba Cloud service name.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-2ze26xj5wwy12****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => ' cn-hangzhou', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 2000, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7AF834D-D38B-4A46-920B-FE974EB7E135', - ], - 'Result' => [ - 'description' => 'The number of affected rows.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1BC69FEB-56CD-4555-A0E2-02536A24A946', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'not allow this operation.', 'description' => 'No permission'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s', 'description' => ''], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n 1\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'DeleteMonitorGroupNotifyPolicy', - 'requestParamsDescription' => ' ', + 'title' => 'CreateMonitorGroupInstances', + 'description' => 'You can add a maximum of 1,000 instances to an application group at a time. You can add a maximum of 3,000 instances of an Alibaba Cloud service to an application group. The total number of instances that you can add to an application group is unlimited.'."\n" + ."\n" + .'In this example, an Elastic Compute Service (ECS) instance in the `China (Hangzhou)` region is added to the `3607****` application group. The instance ID is `i-2ze26xj5wwy12****` and the instance name is `test-instance-ecs`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupNotifyPolicyList' => [ - 'summary' => 'Queries the policies that are used to pause alert notifications for an application group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorGroupInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"1BC69FEB-56CD-4555-A0E2-02536A24A946\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateMonitorGroupNotifyPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'PolicyType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the policy.'."\n" - ."\n" - .'Valid value: PauseNotify.'."\n", + 'description' => 'The type of the pause notification. Currently, only PauseNotify is supported.', 'type' => 'string', 'required' => true, + 'enum' => ['PauseNotify'], 'example' => 'PauseNotify', - 'enum' => [ - 'PauseNotify', - ], + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The application group ID.', 'type' => 'string', 'required' => true, 'example' => '7301****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The start timestamp for pausing notifications.'."\n" + ."\n" + .'The value is a UNIX timestamp, which represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1622949300000', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6780****', - ], + 'schema' => ['description' => 'The end timestamp for pausing notifications.'."\n" + ."\n" + .'The value is a UNIX timestamp, which represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1623208500000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6072F026-C441-41A6-B114-35A1E8F8FDD3', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'NotifyPolicyList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NotifyPolicy' => [ - 'description' => 'The returned policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1551761781273', - ], - 'Type' => [ - 'description' => 'The policy type.'."\n", - 'type' => 'string', - 'example' => 'PauseNotify', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1551761781273', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '6780****', - ], - 'Id' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'example' => '123****', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '13356BCA-3EC3-4748-A771-2064DA69AEF1', 'title' => ''], + 'Result' => ['description' => 'The number of entries returned for the creation result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n \\n \\n PauseNotify\\n 1551763581273\\n 123****\\n 1551761781273\\n 6780****\\n \\n \\n true\\n 200\\n 1\\n","errorExample":""}]', - 'title' => 'DescribeMonitorGroupNotifyPolicyList', + 'title' => 'Create a pause alert notification policy for an application group', + 'summary' => 'Calls the CreateMonitorGroupNotifyPolicy operation to create a pause alert notification policy for an application group.', + 'description' => 'During the effective period of the policy, no alert notifications are sent for any alerts triggered within the application group.'."\n" + .' '."\n" + .'This topic provides an example on how to create a pause alert notification policy named `PauseNotify` for the application group `7301****`. The application group pauses alert notifications during the period from `1622949300000` to `1623208500000` (UTC+8 `2021-06-06 11:15:00` to `2021-06-09 11:15:00`).', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'extraInfo' => ' ', - ], - 'AddTags' => [ - 'summary' => 'Adds tags to an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupNotifyPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorGroupNotifyPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateMonitoringAgentProcess' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'ProcessName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'Valid values of N: 1 to 3. A tag key can be 1 to 64 characters in length.'."\n" - ."\n" - .'You can create a tag key or specify an existing tag key. For more information about how to obtain a tag key, see [DescribeTagKeyList](~~2513189~~).'."\n" - ."\n" - .'> The tag key cannot start with `aliyun` or `acs:`. The tag key (`Tag.N.Key`) and tag value (`Tag.N.Value`) must be specified at the same time.', - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'Valid values of N: 1 to 3. A tag value can be 1 to 64 characters in length.'."\n" - ."\n" - .'You can create a tag value or specify an existing tag value. For more information about how to obtain a tag value, see [DescribeTagValueList](~~2513188~~).'."\n" - ."\n" - .'> The tag value cannot start with `aliyun` or `acs:`. The tag key (`Tag.N.Key`) and tag value (`Tag.N.Value`) must be specified at the same time.', - 'type' => 'string', - 'required' => true, - 'example' => 'value1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The name of the process.', 'type' => 'string', 'required' => false, 'example' => 'java', 'title' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'Valid values of N: 1 to 20.'."\n" - ."\n" - .'For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~2513168~~).', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - ], - 'required' => true, - 'example' => '7301****', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => ' i-2ze51wjtwox01r8g****', 'title' => ''], + ], + [ + 'name' => 'ProcessUser', + 'in' => 'query', + 'schema' => ['description' => 'The user who launches the process.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], ], 'responses' => [ @@ -5187,492 +4166,610 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'DAE4B115-3847-5438-8709-423627F0A3A3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0DFCB47D-E7E1-4CBE-A381-8339F7B300EF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The process ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\tDAE4B115-3847-5438-8709-423627F0A3A3\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'AddTags', - 'description' => 'This topic provides an example on how to add a tag to an application group whose ID is `7301****`. In this example, the key of the tag is `key1` and the value of the tag is `value1`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~315526~~).', + 'title' => 'CreateMonitoringAgentProcess', + 'summary' => 'Creates a task to monitor a process.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDynamicTagGroup' => [ - 'summary' => 'Creates an application group based on the tags of cloud resources.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateSiteMonitor' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'TagKey', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag keys of the cloud resources.'."\n" - ."\n" - .'For more information about how to obtain tag keys, see [DescribeTagKeyList](~~145558~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs_instance', - ], + 'schema' => ['description' => 'The URL or IP address to monitor.', 'type' => 'string', 'required' => true, 'example' => 'https://www.aliyun.com', 'title' => ''], ], [ - 'name' => 'ContactGroupList', + 'name' => 'TaskType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact groups. Valid values of N: 1 to 100. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" - ."\n" - .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ECS_Group', - ], - 'required' => true, - 'docRequired' => true, - 'example' => 'ECS_Group', - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The type of monitoring task.'."\n" + ."\n" + .'Valid protocols include HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, FTP, and WEBSOCKET.', 'type' => 'string', 'required' => true, 'example' => 'HTTP', 'title' => ''], ], [ - 'name' => 'MatchExpress', + 'name' => 'TaskName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The conditional expressions used to create an application group based on the tag.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The conditional expressions used to create an application group based on the tag. Valid values of N: 1 to 3.'."\n", - 'type' => 'object', - 'properties' => [ - 'TagValueMatchFunction' => [ - 'description' => 'The method that is used to match the tag values of the cloud resources. Set the value of N to 1. Valid values:'."\n" - ."\n" - .'* contains: contains'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* notContains: does not contain'."\n" - .'* equals: equals'."\n" - .'* all: matches all'."\n" - ."\n" - .'> If you set the `MatchExpress.N.TagValueMatchFunction` parameter, you must also set the `MatchExpress.N.TagValue` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'contains', - ], - 'TagValue' => [ - 'description' => 'The tag values of the cloud resources. Set the value of N to 1.'."\n" - ."\n" - .'> If you set the `MatchExpress.N.TagValueMatchFunction` parameter, you must also set the `MatchExpress.N.TagValue` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'instance', - ], - 'TagName' => [ - 'description' => 'The keys of the tags that are used to create the application group. If a specified key is attached to multiple resources, the resources that have the same key-value pair are added to the same group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'appname', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 3, - ], + 'schema' => ['description' => 'The name of the monitoring task.'."\n" + ."\n" + .'The name must be 4 to 100 characters long and can contain letters, digits, underscores (\\_), and Chinese characters.', 'type' => 'string', 'required' => true, 'example' => 'HanZhou_ECS1', 'title' => ''], ], [ - 'name' => 'TagRegionId', + 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region to which the tags belong.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The monitoring frequency in minutes.'."\n" + ."\n" + .'Valid values: 1, 5, 15, 30, and 60.'."\n" + ."\n" + .'Default: 1.', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'EnableSubscribeEvent', + 'name' => 'IspCities', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values:'."\n" - ."\n" - .'* true: The application group automatically subscribes to event notifications.'."\n" - .'* false (default value): The application group does not automatically subscribe to event notifications.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The detection points. If you do not specify this parameter, the system randomly selects three detection points from different Internet Service Providers (ISPs).'."\n" + ."\n" + .'The value must be a JSON array. Example: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. The values correspond to Beijing, Hangzhou, and Qingdao.'."\n" + ."\n" + .'For more information, see [DescribeSiteMonitorISPCityList](~~115045~~).', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', 'title' => ''], ], [ - 'name' => 'EnableInstallAgent', + 'name' => 'OptionsJson', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the CloudMonitor agent is automatically installed for the application group. CloudMonitor determines whether to automatically install the CloudMonitor agent for the hosts in an application group based on the value of this parameter. Valid values:'."\n" - ."\n" - .'* true: The CloudMonitor agent is automatically installed.'."\n" - .'* false (default value): The CloudMonitor agent is not automatically installed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The advanced options for the specified protocol. The available options vary based on the protocol type.', 'type' => 'string', 'required' => false, 'example' => '{"time_out":5000}', 'title' => ''], ], [ - 'name' => 'MatchExpressFilterRelation', + 'name' => 'AlertIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The relationship between the conditional expressions for the tag values of the cloud resources. Valid values:'."\n" - ."\n" - .'* and (default)'."\n" - .'* or'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'and', - 'default' => 'and', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For more information, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', 'title' => ''], ], [ - 'name' => 'TemplateIdList', + 'name' => 'AgentGroup', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the alert templates.'."\n" - ."\n" - .'For more information about how to query alert template IDs, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '70****', - ], - 'required' => false, - 'example' => '85****', - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The group of detection points for the network probe task. \\`PC\\` indicates detection points on PCs. \\`MOBILE\\` indicates detection points on mobile devices. \\`FC\\` indicates detection points in a VPC. The default value is \\`PC\\`.', 'type' => 'string', 'required' => false, 'example' => 'PC', 'title' => ''], + ], + [ + 'name' => 'CustomSchedule', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The custom detection schedule. Specify a time period and the days of the week for detection.', 'type' => 'string', 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'VpcConfig', + 'in' => 'query', + 'schema' => ['description' => 'The network information required to create a network probe task in a VPC. This must be a JSON object that contains the \\`vpcId\\`, \\`vswitchId\\`, \\`securityGroupId\\`, and \\`region\\` fields.', 'type' => 'string', 'required' => false, 'example' => '{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code of the operation.'."\n" + ."\n" + .'> A value of \\`200\\` indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The results of the monitoring task.', + 'type' => 'object', + 'properties' => [ + 'AttachAlertResult' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => 'The results of associating the alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result for a single alert rule association.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code for the association operation.'."\n" + ."\n" + .'> A value of \\`200\\` indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned for the association operation.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID for the association operation.', 'type' => 'string', 'example' => '5dd33455-4f65-4b0c-9200-33d66f3f340b', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the alert rule was successfully associated. Valid values:'."\n" + ."\n" + .'- true: The association was successful.'."\n" + ."\n" + .'- false: The association failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The ID of the tag matching rule.'."\n", - 'type' => 'string', - 'example' => '2534dc0a-e3e5-4ae1-a2fc-75ef166c****', + 'CreateResultList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CreateResultList' => [ + 'description' => 'A list of results for each created task.'."\n" + ."\n" + .'This is returned only if the task creation is successful.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result for a single created task.'."\n" + ."\n" + .'This is returned only if the task creation is successful.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the created monitoring task.', 'type' => 'string', 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', 'title' => ''], + 'TaskName' => ['description' => 'The name of the created monitoring task.', 'type' => 'string', 'example' => 'HanZhou_ECS1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => 'N/A.', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address', 'description' => ''], + ['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed', 'description' => ''], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist', 'description' => ''], + ['errorCode' => 'OperatorInvalid', 'errorMessage' => 'Operator invalid', 'description' => ''], + ['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat', 'description' => ''], + ['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error', 'description' => ''], + ['errorCode' => 'NameNotExists', 'errorMessage' => 'Task name not exists', 'description' => ''], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Invalid Isp.', 'description' => 'Invalid Isp'], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'ResourceOverLimit', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'RestrictedUser', 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code', 'description' => ''], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t84AC6F0B-7945-466A-AA44-99BB5A561F86\\r\\n\\t2534dc0a-e3e5-4ae1-a2fc-75ef166c****\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'CreateDynamicTagGroup', - 'description' => 'This operation is available for Elastic Compute Service (ECS), ApsaraDB RDS, and Server Load Balancer (SLB).'."\n" + 'title' => 'CreateSiteMonitor', + 'summary' => 'Creates a site monitoring task.', + 'description' => 'This topic describes how to create a site monitoring task. The example creates a task named `HanZhou_ECS1` to monitor the URL `https://www.aliyun.com` over `HTTPS`.', + 'requestParamsDescription' => 'The following tables describe the advanced parameters for the HTTP(S), PING, TCP, UDP, DNS, WEBSOCKET, SMTP, POP3, and FTP task types.'."\n" ."\n" - .'This topic provides an example to show how to create an application group for resources whose tag key is `ecs_instance`. In this example, the alert contact group of the application group is `ECS_Group`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteDynamicTagGroup' => [ - 'summary' => 'Deletes a tag rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + .'- HTTP(S)'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ---------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| http_method | String | The HTTP or HTTPS request method. Valid values: GET, POST, and HEAD. Default: GET. |'."\n" + .'| header | String | The custom HTTP header. Separate multiple headers with line feeds (\\n).
Each header must be in `key:value` format and follow the HTTP protocol. |'."\n" + .'| cookie | String | The cookie, formatted as a standard HTTP request cookie. |'."\n" + .'| request_content | String | The request content, in JSON or form format. If you do not specify this parameter, the request body is empty. |'."\n" + .'| response_content | String | The expected response content. The system checks the first 64 bytes of the server\'s response. |'."\n" + .'| match_rule | String | 0: The probe is successful if the response does not contain the response_content value.
1: The probe is successful if the response contains the response_content value. |'."\n" + .'| username | String | The username for Basic authentication. If specified, a `BasicAuth` header is included in the HTTP request. |'."\n" + .'| password | String | The password for Basic authentication. |'."\n" + .'| time_out | int | The timeout period in milliseconds. Default: 5000. |'."\n" + .'| max_redirect | int | The maximum number of redirects. Default: 5 for ECS detection points and 2 for carrier detection points.
Set to 0 to disable redirects.
Valid values: 0 to 50. |'."\n" + ."\n" + .'- PING'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------ | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| failure_rate | Text | The failure rate threshold. If the ping failure rate exceeds this value, the probe fails and returns error code 610 (PingAllFail) or 615 (PingPartialFail).
Default: 0.1. |'."\n" + .'| ping_num | int | The number of ping packets to send. Default: 10.
Valid values: 1 to 100. |'."\n" + ."\n" + .'- DNS'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| dns_server | string | The address of the DNS server. This can be a domain name or an IP address. |'."\n" + .'| dns_type | string | The DNS query type. Valid values: A, NS, CNAME, MX, TXT, ANY, and AAAA. |'."\n" + .'| expect_value | string | A space-separated list of expected values. |'."\n" + .'| match_rule | string | The matching rule between the expected values and the DNS query results. The probe fails if this rule is not met.
\\`IN_DNS` or empty string: The expected values must be a subset of the DNS results.
\\`DNS_IN`: The DNS results must be a subset of the expected values.
\\`EQUAL`: The DNS results must be identical to the expected values.
\\`ANY`: The DNS results and the expected values must have at least one value in common. |'."\n" + ."\n" + .'- FTP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------ | ---------------------------------------------------------------------- |'."\n" + .'| port | int | The FTP server port. Default: 21 for FTP and 990 for FTPS. |'."\n" + .'| username | string | The username for FTP login. If not specified, anonymous login is used. |'."\n" + .'| password | string | The password for FTP login. |'."\n" + ."\n" + .'- POP3 or SMTP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------ | ----------------------------------------------------------------------------- |'."\n" + .'| port | int | The server port. Default: 110 for POP3, 995 for POP3S, and 25 for SMTP. |'."\n" + .'| username | string | The username for POP3 or SMTP login. Both username and password are required. |'."\n" + .'| password | string | The password for POP3 or SMTP login. Both username and password are required. |'."\n" + ."\n" + .'- TCP or UDP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ---------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| port | int | The TCP or UDP server port. |'."\n" + .'| request_content | string | The request content. If `request_format` is `hex`, this value must be in compact hexadecimal format. |'."\n" + .'| request_format | string | The format of the request content. If this is not `hex`, the `request_content` is sent as a regular string. |'."\n" + .'| response_content | string | The expected response content. The probe fails if the server response does not contain this value.
If `request_format` is `hex`, this value must be in compact hexadecimal format.
Otherwise, it is treated as a regular string. |'."\n" + ."\n" + .'- WEBSOCKET'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------------- | ------- | ----------------------------------------------------------------------------------------- |'."\n" + .'| request_content | string | The message content to send. |'."\n" + .'| empty_message | boolean | Specifies whether an empty message or no message from the server is considered a success. |', + 'changeSet' => [ + ['createdAt' => '2025-09-11T05:58:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-13T09:00:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-09T12:32:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-04T02:58:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-19T07:10:45.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-22T09:29:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-11-02T03:20:17.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSiteMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateSiteMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'extraInfo' => "\n" + ."\n\n", + ], + 'Cursor' => [ + 'summary' => 'Calls the Cursor operation to define the scope of monitoring data to be exported, and returns the Cursor value used for the initial call to the BatchExport operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'DynamicTagRuleId', - 'in' => 'query', + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The data namespace of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the data namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'Metric', + 'in' => 'formData', + 'schema' => ['description' => 'The metric name of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the metric name of a cloud service, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_idle', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'formData', + 'schema' => ['description' => 'The statistical period of the metric.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'> The statistical period of a metric is typically 60 seconds. For special values, see the `Period` parameter in [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The value is in the YYYY-MM-DDThh:mm:ssZ format. For example, 2023-01-01T00:00:00Z indicates 00:00:00 on January 1, 2023 (GMT).'."\n" + ."\n" + .'> The time to live (TTL) of monitoring data varies based on the statistical granularity in CloudMonitor. Configure a proper time range based on the TTL of the data that corresponds to the `Period` parameter.', 'type' => 'string', 'required' => true, 'example' => '1641627000000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'> - Unix timestamp: the number of milliseconds that have elapsed since 00:00:00 on January 1, 1970. The value is in the YYYY-MM-DDThh:mm:ssZ format. For example, 2023-01-01T00:00:00Z indicates 00:00:00 on January 1, 2023 (GMT).'."\n" + .'- If you do not specify an end time, the end time is unlimited. You do not need to specify this parameter when you export data in real time.'."\n" + .'- The time to live (TTL) of monitoring data varies based on the statistical granularity in CloudMonitor. Configure a proper time range based on the TTL of the data that corresponds to the `Period` parameter.', 'type' => 'string', 'required' => false, 'example' => '1641645000000', 'title' => ''], + ], + [ + 'name' => 'Matchers', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the tag rule.'."\n" - ."\n" - .'For information about how to obtain the ID of a tag rule, see [DescribeDynamicTagRuleList](~~150126~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', + 'description' => 'The dimension information of the metric.', + 'type' => 'array', + 'items' => ['description' => 'The dimension information of the metric.', '$ref' => '#/components/schemas/Matcher', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '08AAE67E-77B5-485B-9C79-D7C8C059150A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Cursor' => ['description' => 'The Cursor that is used as an input parameter to export data in the [BatchExport](~~2329847~~) operation.'."\n" + ."\n", 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '915C2D7A-E6A4-17C3-8E13-4DBDD61E7919', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Defines the scope of monitoring data to be exported', + 'description' => '### Prerequisites'."\n" + .'Make sure that Enterprise CloudMonitor is activated. For more information, see [Activate Enterprise CloudMonitor](~~250773~~).'."\n" + ."\n" + .'### Background information'."\n" + .'First, call this operation to obtain the initial Cursor. Then, call the [BatchExport](~~2329847~~) operation to export monitoring data.'."\n" + .'### Usage notes'."\n" + .'This topic provides an example to describe how to define the scope to export data of the `cpu_idle` metric of the `acs_ecs_dashboard` cloud service every 60 seconds in the time range from `1641627000000` (2022-01-08 15:30:00) to `1641645000000` (2022-01-08 20:30:00). The returned result shows the `Cursor` information.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Cursor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:Cursor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n 08AAE67E-77B5-485B-9C79-D7C8C059150A\\n 200\\n true\\n","errorExample":""}]', - 'title' => 'DeleteDynamicTagGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"915C2D7A-E6A4-17C3-8E13-4DBDD61E7919\\"\\n}","type":"json"}]', ], - 'DescribeTagValueList' => [ - 'summary' => 'Queries the tag values corresponding to a specified tag key.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteContact' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'ContactName', 'in' => 'query', + 'schema' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'John Doe', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Valid values: 1 to 100. Default value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], + ], + [ + ['errorCode' => 'ContactNotExists', 'errorMessage' => 'ContactName does not exist.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Delete an alert contact', + 'summary' => 'Deletes an alert contact.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContact'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteContact', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"50D4CFE1-01E5-4543-939C-18BC01E3EC1C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteContactGroup' => [ + 'summary' => 'Calls the DeleteContactGroup operation to delete an alert contact group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TagKey', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'For more information about how to obtain a tag key, see [DescribeTagKeyList](~~145558~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tagKey1', - ], + 'schema' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'My alert group', 'title' => ''], ], ], 'responses' => [ @@ -5680,133 +4777,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'B04B8CF3-4489-432D-83BA-6F128E4F2295', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TagValues' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagValue' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The queried tag values.'."\n", - 'type' => 'string', - 'example' => '["tagValue1", "tagValue2"]', - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F722BE59-2400-4A64-9C1A-AD886AED9A69', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ContactNotExists', 'errorMessage' => 'ContactGroupName Not Exists', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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' => 'DescribeTagValueList', - 'description' => 'This topic provides an example of how to query the tag values corresponding to `tagKey1`. The return results are `tagValue1` and `tagValue2`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Delete an alert contact group', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeTagKeyList' => [ - 'summary' => 'Queries tag keys.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteContactGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F722BE59-2400-4A64-9C1A-AD886AED9A69\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteCustomMetric' => [ + 'summary' => 'Deletes the reported monitoring data of a metric.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'The name of the metric.', 'type' => 'string', 'required' => true, 'example' => 'AdvanceCredit', 'title' => ''], + ], + [ + 'name' => 'Md5', + 'in' => 'query', + 'schema' => ['description' => 'The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.'."\n" + ."\n" + .'> `Md5` is returned when you query the reported monitoring data of a metric.', 'type' => 'string', 'required' => false, 'example' => '38796C8CFFEB8F89BB2A626C7BD7****', 'title' => ''], + ], + [ + 'name' => 'UUID', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the request for reporting monitoring data.'."\n" + ."\n" + .'> `UUID` is returned when you query the reported monitoring data of a metric. We recommend that you specify the `Md5` parameter.', 'type' => 'string', 'required' => false, 'example' => '5497633c-66c5-4eae-abaa-89db5adb****', 'title' => ''], ], ], 'responses' => [ @@ -5814,115 +4875,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'Specified parameter PageSize is not valid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B04B8CF3-4489-432D-83BA-6F128E5F2293', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TagKeys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagKey' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The queried tag keys.'."\n", - 'type' => 'string', - 'example' => 'tagKey1', - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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' => 'DescribeTagKeyList', + 'title' => 'DeleteCustomMetric', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeProductResourceTagKeyList' => [ - 'summary' => 'Queries the keys of all tags that are attached to cloud resources in a region.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-04-23T06:11:10.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomMetric'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteCustomMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\"\\n}","type":"json"}]', + ], + 'DeleteDynamicTagGroup' => [ + 'summary' => 'Deletes a tag rule.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'DynamicTagRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dbc2826f237e****', - ], + 'schema' => ['description' => 'The ID of the tag rule.'."\n" + ."\n" + .'For information about how to obtain the ID of a tag rule, see [DescribeDynamicTagRuleList](~~150126~~).', 'type' => 'string', 'required' => true, 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', 'title' => ''], ], ], 'responses' => [ @@ -5930,952 +4955,418 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 request processing has failed due to some unknown error.', - ], - 'NextToken' => [ - 'description' => 'The pagination token. If more entries are to be returned on the next page, a pagination token is returned.'."\n" - ."\n" - .'> If the value of this parameter is not null, more entries are to be returned on the next page. You can use the returned pagination token as a request parameter to retrieve a new page of results. If the value of this parameter is null, all the entries have been returned.'."\n", - 'type' => 'string', - 'example' => 'dbc2826f237e****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '945ACAA9-89F2-4A62-8913-076FDEDAA8DB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TagKeys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagKey' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'tagKey1', - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '08AAE67E-77B5-485B-9C79-D7C8C059150A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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' => 'DescribeProductResourceTagKeyList', - 'description' => '> If a tag is attached to multiple cloud resources in the region, the key of the tag is returned only once.'."\n", + 'title' => 'DeleteDynamicTagGroup', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDynamicTagRuleList' => [ - 'summary' => 'Queries tag rules.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDynamicTagGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteDynamicTagGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"08AAE67E-77B5-485B-9C79-D7C8C059150A\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteEventRuleTargets' => [ + 'summary' => 'Deletes the push channels of an event-triggered alert rule.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TagRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region to which the tags belong.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'TagKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'For more information about how to obtain a tag key, see [DescribeTagKeyList](~~145558~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagkey1', - ], - ], - [ - 'name' => 'TagValue', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'For more information about how to obtain a tag value, see [DescribeTagKeyList](~~145557~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], + 'schema' => ['description' => 'The name of the event-triggered alert rule.'."\n" + ."\n" + .'For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).', 'type' => 'string', 'required' => true, 'example' => 'testRule', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Ids', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, + 'description' => 'The IDs of event-triggered alert rules.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the event-triggered alert rule.', 'type' => 'string', 'required' => false, 'example' => 'testRuleId', 'title' => ''], + 'required' => true, + 'maxItems' => 20, 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Minimum value: 1. Default value: 30.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - ], - [ - 'name' => 'DynamicTagRuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the tag rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '004155fa-15ba-466d-b61a-***********', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0D50523D-8D59-4A61-B58E-E2286ECFB3A9', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TagGroupList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagGroup' => [ - 'description' => 'The tag rules of application groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of adding instances that meet the tag rule to the application group. Valid values:'."\n" - ."\n" - .'* `RUNNING`'."\n" - .'* `FINISH`'."\n", - 'type' => 'string', - 'example' => 'FINISH', - ], - 'MatchExpressFilterRelation' => [ - 'description' => 'The logical operator that is used between conditional expressions. Valid values:'."\n" - ."\n" - .'* `and`'."\n" - .'* `or`'."\n" - ."\n" - .'> Only one logical operator can be used in a request.'."\n", - 'type' => 'string', - 'example' => 'or', - ], - 'RegionId' => [ - 'description' => 'The ID of the region to which the tags belong.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'tagkey1', - ], - 'DynamicTagRuleId' => [ - 'description' => 'The ID of the tag rule.'."\n", - 'type' => 'string', - 'example' => '1536df65-a719-429d-8813-73cc40d7****', - ], - 'MatchExpress' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MatchExpress' => [ - 'description' => 'The conditional expressions used to create an application group based on the tag.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TagValue' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'The `TagValue` and `TagValueMatchFunction` parameters must be used in pairs.'."\n", - 'type' => 'string', - 'example' => '*', - ], - 'TagValueMatchFunction' => [ - 'description' => 'The method that is used to match tag values. Valid values:'."\n" - ."\n" - .'* all: includes all'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* contains: contains'."\n" - .'* notContains: does not contain'."\n" - .'* equals: equals'."\n", - 'type' => 'string', - 'example' => 'all', - ], - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'azone-version', - ], - ], - ], - ], - ], - ], - 'TemplateIdList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TemplateIdList' => [ - 'description' => 'The IDs of the alert templates.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '71****', - ], - ], - ], - ], - 'ContactGroupList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroupList' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - ], - ], - ], - 'TagValueBlacklist' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagValueBlacklist' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successfull', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '142989D9-CC52-54D0-928D-2C9B1D9F051C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`'."\n" + ."\n" + .'- `false`', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteEventRuleTargets', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRuleTargets'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteEventRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t30\\r\\n\\t1\\r\\n\\t2\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tFINISH\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCloudMonitor\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tor\\r\\n\\t\\t\\t1536df65-a719-429d-8813-73cc40d7****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t71****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\ttagkey1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t*\\r\\n\\t\\t\\t\\t\\tall\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tFINISH\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCloudMonitor\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tor\\r\\n\\t\\t\\t56e8cebb-b3d7-4a91-9880-78a8c84f****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t71****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\ttagkey1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t*\\r\\n\\t\\t\\t\\t\\tall\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeDynamicTagRuleList', - 'description' => 'This topic provides an example to show how to query tag rules that are related to `tagkey1`. The sample responses indicate that two tag rules are found. The rule IDs are `1536df65-a719-429d-8813-73cc40d7****` and `56e8cebb-b3d7-4a91-9880-78a8c84f****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successfull\\",\\n \\"RequestId\\": \\"142989D9-CC52-54D0-928D-2C9B1D9F051C\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'RemoveTags' => [ - 'summary' => 'Deletes tags.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteEventRules' => [ + 'summary' => 'Deletes one or more event-triggered alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'RuleNames', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The names of the event-triggered alert rules to delete.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'> The tag key (`Tag.N.Key`) and tag value (`Tag.N.Value`) must be specified at the same time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'> The tag key (`Tag.N.Key`) and tag value (`Tag.N.Value`) must be specified at the same time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Value1', - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'The name of an event-triggered alert rule to delete.', 'type' => 'string', 'required' => false, 'example' => 'lq-test', 'title' => ''], 'required' => true, - 'maxItems' => 10, + 'example' => 'rule1', + 'maxItems' => 20, + 'title' => '', ], ], - [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The IDs of the application groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use this ID to query logs.', 'type' => 'string', 'example' => '45231A42-5A09-5AFF-953C-A5B3D4ED8925', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteEventRules', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteEventRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => true, - 'example' => '12345', - 'maxItems' => 20, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"45231A42-5A09-5AFF-953C-A5B3D4ED8925\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'extraInfo' => ' ', + ], + 'DeleteExporterOutput' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DestName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the destination configuration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testName', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'Illegal parameters.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '195390D2-69D0-4D9E-81AA-A7F5BC1B91EB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tag' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tags' => [ - 'description' => 'The deleted tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tag1', - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates success. Other values indicate failure.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2DECF751-7AFA-43BB-8C63-2B6B07E51AE1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: '."\n" + .'- `true`: success'."\n" + .'- `false`: failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t\\tE15C718E-067E-49D0-86F7-BC7242230091\\n\\t\\t200\\n\\t\\ttrue\\n","errorExample":""}]', - 'title' => 'RemoveTags', + 'title' => 'Delete a monitoring data export configuration', + 'summary' => 'Calls the DeleteExporterOutput operation to delete a monitoring data export configuration.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateHostAvailability' => [ - 'summary' => 'Creates an availability monitoring task.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-21T02:01:45.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExporterOutput'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteExporterOutput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"2DECF751-7AFA-43BB-8C63-2B6B07E51AE1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteExporterRule' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'RuleName', 'in' => 'query', + 'schema' => ['description' => 'The name of the export rules.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'myRuleName', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success. Any other value indicates failure.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D023', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: '."\n" + .'- `true`: Successful.'."\n" + .'- `false`: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the availability monitoring task. The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task1', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Delete export rules', + 'summary' => 'Invokes the DeleteExporterRule operation to delete export rules.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:14:43.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-10T10:46:10.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExporterRule'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'TaskScope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The range of instances that are monitored by the availability monitoring task. Valid values:'."\n" - ."\n" - .'* GROUP: All ECS instances in the application group are monitored.'."\n" - .'* GROUP_SPEC_INSTANCE: Specified ECS instances in the application group are monitored. The TaskScope parameter must be used in combination with the InstanceList parameter. The InstanceList parameter specifies the ECS instances to be monitored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GROUP', - 'default' => 'GROUP', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The monitoring type of the availability monitoring task. Valid values:'."\n" - ."\n" - .'* PING'."\n" - .'* TELNET'."\n" - .'* HTTP'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HTTP', - ], - ], - [ - 'name' => 'TaskOption.HttpURI', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URI that you want to monitor. This parameter is required if the TaskType parameter is set to HTTP or Telnet.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - ], - [ - 'name' => 'TaskOption.TelnetOrPingHost', - 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name or IP address that you want to monitor.'."\n" - ."\n" - .'> This parameter is required if the TaskType parameter is set to PING.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com', - ], - ], - [ - 'name' => 'TaskOption.HttpResponseCharset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The character set that is used in the HTTP response.'."\n" - ."\n" - .'> Only UTF-8 is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UTF-8', - ], - ], - [ - 'name' => 'TaskOption.HttpPostContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the HTTP POST request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'params1=paramsValue1', - ], - ], - [ - 'name' => 'TaskOption.HttpResponseMatchContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'The response to the HTTP request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ok', - ], - ], - [ - 'name' => 'TaskOption.HttpMethod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* GET'."\n" - .'* POST'."\n" - .'* HEAD'."\n" - ."\n" - .'> This parameter must be specified when TaskType is set to HTTP.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - ], - [ - 'name' => 'TaskOption.HttpNegative', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method to trigger an alert. The alert can be triggered based on whether the specified alert rule is included in the response body. Valid values:'."\n" - ."\n" - .'* true: If the HTTP response body includes the alert rule, an alert is triggered.'."\n" - .'* false: If the HTTP response does not include the alert rule, an alert is triggered.'."\n" - ."\n" - .'> This parameter must be specified when TaskType is set to HTTP.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'TaskOption.HttpHeader', - 'in' => 'query', - 'schema' => [ - 'description' => 'The header of the HTTP request. Format: `Parameter name:Parameter value`. Separate multiple parameters with carriage return characters. Example:'."\n" - ."\n" - .' params1:value1'."\n" - .' params2:value2'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'token:testTokenValue', - ], - ], - [ - 'name' => 'TaskOption.Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which detection requests are sent. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.'."\n" - ."\n" - .'> This parameter is available only for the CloudMonitor agent V3.5.1 or later.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - ], - [ - 'name' => 'AlertConfig.NotifyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'0: Alert notifications are sent by using emails and DingTalk chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AlertConfig.StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'AlertConfig.EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22', - ], - ], - [ - 'name' => 'AlertConfig.SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400. The default value indicates one day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], - ], - [ - 'name' => 'AlertConfig.WebHook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com/webhook.json', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteExporterRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D023\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteGroupMonitoringAgentProcess' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AlertConfigEscalationList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'None'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric for which the alert feature is enabled. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* HttpStatus: HTTP status code'."\n" - .'* HttpLatency: HTTP response time'."\n" - .'* TelnetStatus: Telnet status code'."\n" - .'* TelnetLatency: Telnet response time'."\n" - .'* PingLostRate: Ping packet loss rate'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HttpStatus', - ], - 'Value' => [ - 'description' => 'The alert threshold. Valid values of N: 1 to 21.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered. Valid values of N: 1 to 21.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Operator' => [ - 'description' => 'The comparison operator that is used in the alert rule. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* `>`'."\n" - .'* `>=`'."\n" - .'* `<`'."\n" - .'* `<=`'."\n" - .'* `=`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Aggregate' => [ - 'description' => 'The method used to calculate the metric values that trigger alerts. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* HttpStatus: Value'."\n" - .'* HttpLatency: Average'."\n" - .'* TelnetStatus: Value'."\n" - .'* TelnetLatency: Average'."\n" - .'* PingLostRate: Average'."\n" - ."\n" - .'> The value Value indicates the original value and is used for metrics such as status codes. The value Average indicates the average value and is used for metrics such as the latency and packet loss rate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Value', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'InstanceList', + 'name' => 'GroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ECS instances that are monitored. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ECS instances that are monitored. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'required' => false, - 'example' => 'i-absdfkwl321****', - 'maxItems' => 1000, - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'AlertConfigTargetList', + 'name' => 'Id', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The resources for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource for which alerts are triggered.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the group process.', 'type' => 'string', 'required' => true, 'example' => '48F83746-C817-478C-9B06-7158F56B****', 'title' => ''], ], ], 'responses' => [ @@ -6883,129 +5374,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', - ], - 'TaskId' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F6150F9-45C7-43F9-9578-A58B2E726C90', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t12345\\n\\tCDA78493-F10F-485F-98AD-B4C0B40AB225\\n\\t200\\n\\ttrue\\n","errorExample":""}]', - 'title' => 'CreateHostAvailability', - 'description' => 'This topic provides an example on how to create an availability monitoring task named `task1` in an application group named `123456`. The TaskType parameter of the task is set to `HTTP`. After you start the task, the system sends alerts by using the specified email address and DingTalk chatbot.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Delete a group process monitoring task', + 'summary' => 'Deletes a group process monitoring task by calling the DeleteGroupMonitoringAgentProcess operation.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteGroupMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"3F6150F9-45C7-43F9-9578-A58B2E726C90\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteHostAvailability' => [ - 'summary' => 'Deletes availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The task ID. Valid values of N: 1 to 20.'."\n", + 'description' => 'The IDs of the tasks.', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'example' => '1191346', - ], + 'items' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12456', 'title' => ''], 'required' => true, 'example' => '12456', 'maxItems' => 20, + 'title' => '', ], ], ], @@ -7014,816 +5463,612 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '57C782E6-B235-4842-AD2B-DB94961761EB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '57C782E6-B235-4842-AD2B-DB94961761EB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. \\`true\\`: The operation was successful. \\`false\\`: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteHostAvailability', + 'summary' => 'Deletes one or more availability monitoring jobs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'HostAvailability', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], ], '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' => 'DeleteHostAvailability', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], - 'EnableHostAvailability' => [ - 'summary' => 'Enables availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteHybridMonitorNamespace' => [ + 'summary' => 'Deletes a namespace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Namespace', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'required' => true, - 'example' => '123456', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'example' => 'aliyun', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Namespace.NotFound', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DeleteHybridMonitorNamespace', + 'description' => '> If a metric import task is created for metrics in a namespace, you cannot delete the namespace unless you delete the task first.'."\n" + ."\n" + .'This topic provides an example on how to delete a namespace named `aliyun`. The response shows that the namespace is deleted.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-03-29T07:11:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorNamespace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteCustomNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'EnableHostAvailability', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Namespace.NotFound\\",\\n \\"RequestId\\": \\"3843D23A-FB9E-5DC8-BCCC-458768B79296\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'DisableHostAvailability' => [ - 'summary' => 'Disables availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteHybridMonitorSLSGroup' => [ + 'summary' => 'Deletes a Logstore group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'SLSGroupName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'required' => true, - 'example' => '12345', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The name of the Logstore group.'."\n" + ."\n" + .'For information about how to obtain the name of a Logstore group, see [DescribeHybridMonitorSLSGroup](~~429526~~).', 'type' => 'string', 'required' => true, 'example' => 'Logstore_test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'RESOURCE_NOT_FOUND', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '85198BFF-1DE6-556E-B6A4-C77C51C62B8D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DeleteHybridMonitorSLSGroup', + 'description' => 'This topic provides an example on how to delete a Logstore group named `Logstore_test`. The response shows that the Logstore group is deleted.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorSLSGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteHybridMonitorSLSGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"RESOURCE_NOT_FOUND\\",\\n \\"RequestId\\": \\"85198BFF-1DE6-556E-B6A4-C77C51C62B8D\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'ModifyHostAvailability' => [ - 'summary' => 'Modifies an availability monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteHybridMonitorTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The ID of the metric import task.'."\n" + ."\n" + .'For information about how to obtain the ID of a metric import task, see [DescribeHybridMonitorTaskList](~~428624~~).'."\n" + ."\n" + .'> This parameter is required only if you call this operation to delete metrics for the logs that are imported from Log Service. In this case, the `TaskType` parameter is set to `aliyun_sls`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '36****', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'The name can contain uppercase letters, lowercase letters, digits, and hyphens (-).'."\n" + ."\n" + .'> This parameter is required only if you call this operation to delete metric import tasks for Alibaba Cloud services. In this case, the `TaskType` parameter is set to `aliyun_fc`.', 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'TargetUserId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the member account.'."\n" + ."\n" + .'> This parameter is required only if you use a management account to call this operation to query metric import tasks that belong to a member in a resource directory. In this case, the `TaskType` parameter is set to `aliyun_fc`.', 'type' => 'string', 'required' => false, 'example' => '120886317861****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the availability monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task2', + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6B8103F-7BAD-5FEB-945F-71D991AB8834', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], [ - 'name' => 'TaskScope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The range of instances that are monitored by the availability monitoring task. Valid values:'."\n" - ."\n" - .'* GROUP: All ECS instances in the application group are monitored.'."\n" - .'* GROUP_SPEC_INSTANCE: Specified ECS instances in the application group are monitored. The TaskScope parameter must be used in combination with the InstanceList parameter. The InstanceList parameter specifies the ECS instances to be monitored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GROUP', - 'default' => 'GROUP', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DeleteHybridMonitorTask', + 'summary' => 'Deletes a metric import task for Alibaba Cloud services or a metric for the logs that are imported from Log Service.', + 'description' => 'This topic provides an example on how to delete a metric import task whose ID is `36****`. The returned result indicates that the metric import task is deleted.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-08-09T02:57:10.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorTask'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteHybridMonitorTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"D6B8103F-7BAD-5FEB-945F-71D991AB8834\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'DeleteLogMonitor' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TaskOption.HttpURI', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URI that you want to monitor. This parameter is required if the TaskType parameter is set to HTTP or Telnet.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'delete', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'TaskOption.TelnetOrPingHost', + 'name' => 'LogId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the log monitoring metric.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The domain name or IP address that you want to monitor.'."\n" - ."\n" - .'> This parameter is required if the TaskType parameter is set to PING. For more information about how to set the TaskType parameter, see [CreateHostAvailability](~~115317~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'metric not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'TaskOption.HttpResponseCharset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The character set that is used in the HTTP response.'."\n" - ."\n" - .'> Only UTF-8 is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UTF-8', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteLogMonitor', + 'summary' => 'Deletes a log monitoring metric.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteLogMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"metric not exist.\\",\\n \\"RequestId\\": \\"42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteMetricRuleBlackList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TaskOption.HttpPostContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the HTTP POST request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'params1=value1', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'TaskOption.HttpResponseMatchContent', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert blacklist policy. Separate multiple IDs with commas (,). You can specify up to 50 IDs.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n" + ."\n" + .'> This parameter also supports JSON Array format, for example: `["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`.', 'type' => 'string', 'required' => true, 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The response to the HTTP request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ok', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B88D233C-A004-3AB8-AD9C-30CBDD4440C5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Count' => ['description' => 'The number of alert blacklist policies that were successfully deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'TaskOption.HttpMethod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* GET'."\n" - .'* POST'."\n" - .'* HEAD'."\n" - ."\n" - .'> This parameter must be specified when TaskType is set to HTTP. For more information about how to configure the TaskType parameter, see [CreateHostAvailability](~~115317~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Delete alert blacklist policies', + 'summary' => 'Calls the DeleteMetricRuleBlackList operation to delete alert blacklist policies.', + 'requestParamsDescription' => 'For information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleBlackList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'TaskOption.HttpNegative', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method to trigger an alert. The alert can be triggered based on whether the specified alert rule is included in the response body. Valid values:'."\n" - ."\n" - .'* true: If the HTTP response body includes the alert rule, an alert is triggered.'."\n" - .'* false: If the HTTP response does not include the alert rule, an alert is triggered.'."\n" - ."\n" - .'> This parameter must be specified when TaskType is set to HTTP. For more information about how to configure the TaskType parameter, see [CreateHostAvailability](~~115317~~).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'TaskOption.HttpHeader', - 'in' => 'query', - 'schema' => [ - 'description' => 'The header of the HTTP request. Format: `Parameter name:Parameter value`. Separate multiple parameters with carriage return characters. Example:'."\n" - ."\n" - .' params1:value1'."\n" - .' params2:value2'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'params1:value1', - ], - ], - [ - 'name' => 'TaskOption.Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which detection requests are sent. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.'."\n" - ."\n" - .'> This parameter is available only for the CloudMonitor agent V3.5.1 or later.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - ], - [ - 'name' => 'AlertConfig.NotifyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'0: Alert notifications are sent by using emails and DingTalk chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AlertConfig.StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'AlertConfig.EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22', - ], - ], - [ - 'name' => 'AlertConfig.SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400. The default value indicates one day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], - ], - [ - 'name' => 'AlertConfig.WebHook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com/webhook.json', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DeleteMetricRuleResources' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AlertConfigEscalationList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The alert configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric for which the alert feature is enabled. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* HttpStatus: HTTP status code'."\n" - .'* HttpLatency: HTTP response time'."\n" - .'* TelnetStatus: Telnet status code'."\n" - .'* TelnetLatency: Telnet response time'."\n" - .'* PingLostRate: Ping packet loss rate'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HttpStatus', - ], - 'Value' => [ - 'description' => 'The alert threshold. Valid values of N: 1 to 21.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered. Valid values of N: 1 to 21.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Operator' => [ - 'description' => 'The comparison operator that is used in the alert rule. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* `>`'."\n" - .'* `>=`'."\n" - .'* `<`'."\n" - .'* `<=`'."\n" - .'* `=`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Aggregate' => [ - 'description' => 'The method used to calculate the metric values that trigger alerts. Valid values of N: 1 to 21. The value of this parameter varies based on the metric. The following items show the correspondence between metrics and calculation methods:'."\n" - ."\n" - .'* HttpStatus: Value'."\n" - .'* HttpLatency: Average'."\n" - .'* TelnetStatus: Value'."\n" - .'* TelnetLatency: Average'."\n" - .'* PingLostRate: Average'."\n" - ."\n" - .'> The value Value indicates the original value and is used for metrics such as status codes. The value Average indicates the average value and is used for metrics such as the latency and packet loss rate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Value', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'InstanceList', + 'name' => 'RuleId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ECS instances that are monitored. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ECS instances that are monitored. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'required' => false, - 'example' => 'i-absdfkwl321****', - 'maxItems' => 1000, - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rr-bp18017n6iolv****', 'title' => ''], ], [ - 'name' => 'AlertConfigTargetList', + 'name' => 'Resources', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The information about the resources for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the resource for which alerts are triggered.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" - ."\n" - .'Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The resources that are associated with the alert rule.', 'type' => 'string', 'required' => true, 'example' => '[{"instanceId":"i-uf6hm9lnlzsarrc7****"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => '16E815A3-47E1-4290-87F9-D5C99471FF45', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The alert does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D8A35882-90C6-4F03-BBEB-153C180398EA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t\\t16E815A3-47E1-4290-87F9-D5C99471FF45\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'ModifyHostAvailability', - 'description' => 'This topic provides an example on how to change the name of an availability monitoring task named `12345` in an application group named `123456` to `task2`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DeleteMetricRuleResources', + 'summary' => 'Disassociates resources from an alert rule.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeUnhealthyHostAvailability' => [ - 'summary' => 'Queries unhealthy instances detected by availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleResources'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRuleResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The alert does not exist.\\",\\n \\"RequestId\\": \\"D8A35882-90C6-4F03-BBEB-153C180398EA\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteMetricRuleTargets' => [ + 'summary' => 'Delete the push channels of an alert rule.', + 'methods' => ['post', 'get', 'delete', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ruleId-xxxxxx', 'title' => ''], + ], + [ + 'name' => 'TargetIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the availability monitoring task. Valid values of N: 1 to 20.'."\n", + 'description' => 'The resource IDs.', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], + 'items' => ['description' => 'The resource ID. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], 'required' => true, - 'example' => '123456', - 'maxItems' => 20, + 'example' => '12345', + 'maxItems' => 5, + 'title' => '', ], ], ], @@ -7832,195 +6077,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UnhealthyList' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'\\*\\*'."\n" + ."\n" + .'**Description** The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailIds' => [ + 'description' => 'The IDs of the resources that failed to be deleted.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'NodeTaskInstance' => [ - 'description' => 'The unhealthy instances that are detected by the specified availability monitoring tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'InstanceList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'String' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The unhealthy instances that are detected by the availability monitoring task.'."\n", - 'type' => 'string', - 'example' => 'i-a34b581****', - ], - ], - ], - ], + 'TargetIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TargetId' => [ + 'description' => 'The IDs of the resources that failed to be deleted.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource that failed to be deleted.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'description' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed because of an unknown error, exception or failure.', 'description' => ''], ], ], - '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' => 'DescribeUnhealthyHostAvailability', + 'title' => 'DeleteMetricRuleTargets', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeHostAvailabilityList' => [ - 'summary' => 'Queries availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleTargets'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DeleteMetricRuleTemplate' => [ + 'summary' => 'Deletes an alert rule template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456', - ], - ], - [ - 'name' => 'Ids', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the availability monitoring tasks. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456,345678', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the availability monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs_instance', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Minimum value: 1. Default value: 10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the alert rule template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123****', 'title' => ''], ], ], 'responses' => [ @@ -8028,436 +6178,96 @@ 'schema' => [ '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' => '4A288E86-45C3-4858-9DB0-6D85B10BD92A', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TaskList' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7B63F8CF-D48D-4608-A402-04FB5B2B4B6A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'description' => 'The template information.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'NodeTaskConfig' => [ - 'description' => 'The details of the availability monitoring tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskType' => [ - 'description' => 'The task type. Valid values:'."\n" - ."\n" - .'* PING'."\n" - .'* TELNET'."\n" - .'* HTTP'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'example' => 'Group_ECS', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'TaskName' => [ - 'description' => 'The name of the availability monitoring task.'."\n", - 'type' => 'string', - 'example' => 'ecs_instance', - ], - 'Disabled' => [ - 'description' => 'Indicates whether the availability monitoring task is disabled. Valid values:'."\n" - ."\n" - .'* true: The availability monitoring task is disabled.'."\n" - .'* false: The availability monitoring task is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'TaskScope' => [ - 'description' => 'The range of instances that are monitored by the availability monitoring task. Valid values:'."\n" - ."\n" - .'* GROUP: All ECS instances in the application group are monitored.'."\n" - .'* GROUP_SPEC_INSTANCE: Specified ECS instances in the application group are monitored.'."\n", - 'type' => 'string', - 'example' => 'GROUP', - ], - 'Id' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'Instances' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Instance' => [ - 'description' => 'The ECS instances that are monitored.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'i-abcdefgh12****', - ], - ], - ], - ], - 'TaskOption' => [ - 'description' => 'The optional parameters of the availability monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpMethod' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* GET'."\n" - .'* POST'."\n" - .'* HEAD'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'Interval' => [ - 'description' => 'The interval at which detection requests are sent. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'HttpURI' => [ - 'description' => 'The URI that you want to monitor. If the TaskType parameter is set to HTTP, this parameter is required.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'TelnetOrPingHost' => [ - 'description' => 'The domain name or IP address that you want to monitor.'."\n", - 'type' => 'string', - 'example' => 'ssh.aliyun.com', - ], - 'HttpResponseCharset' => [ - 'description' => 'The character set that is used in the HTTP response.'."\n", - 'type' => 'string', - 'example' => 'UTF-8', - ], - 'HttpPostContent' => [ - 'description' => 'The content of the HTTP POST request.'."\n", - 'type' => 'string', - 'example' => 'params1=paramsValue1', - ], - 'HttpNegative' => [ - 'description' => 'The method to trigger an alert. The alert can be triggered based on whether the specified alert rule is included in the response body. Valid values:'."\n" - ."\n" - .'* true: If the HTTP response body includes the alert rule, an alert is triggered.'."\n" - .'* false: If the HTTP response does not include the alert rule, an alert is triggered.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpKeyword' => [ - 'description' => 'The response to the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - ], - ], - 'AlertConfig' => [ - 'description' => 'The configurations of the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'EndTime' => [ - 'description' => 'The end of the time period during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time period during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WebHook' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'NotifyType' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'* 2: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* 1: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* 0: Alert notifications are sent by using emails and DingTalk chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'EscalationList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'escalationList' => [ - 'description' => 'The trigger conditions of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'MetricName' => [ - 'description' => 'The name of the metric. Valid values:'."\n" - ."\n" - .'* HttpStatus'."\n" - .'* HttpLatency'."\n" - .'* TelnetStatus'."\n" - .'* TelnetLatency'."\n" - .'* PingLostRate'."\n", - 'type' => 'string', - 'example' => 'HttpStatus', - ], - 'Operator' => [ - 'description' => 'The comparison operator that is used in the alert rule. Valid values:'."\n" - ."\n" - .'* `>`'."\n" - .'* `>=`'."\n" - .'* `<`'."\n" - .'* `<=`'."\n" - .'* `=`'."\n", - 'type' => 'string', - 'example' => '=', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value is measured before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Aggregate' => [ - 'description' => 'The method used to calculate metric values that trigger alerts. Valid values:'."\n" - ."\n" - .'* Value: the value of the HTTP status code'."\n" - .'* Average: the average HTTP response time'."\n" - .'* Value: the value of the Telnet status code'."\n" - .'* TelnetLatency: the average Telnet response time'."\n" - .'* Average: the average Ping packet loss rate'."\n", - 'type' => 'string', - 'example' => 'Value', - ], - ], - ], - ], - ], - ], - 'TargetList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Target' => [ - 'description' => 'The monitored resources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource that triggers the alert.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the function.'."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:'."\n" - ."\n" - .'* Service: the service code'."\n" - .'* Region: the region ID'."\n" - .'* Account: the ID of the Alibaba Cloud account'."\n" - .'* ResourceType: the resource type'."\n" - .'* ResourceId: the resource ID.'."\n", - 'type' => 'string', - 'example' => 'acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'INFO', - ], - 'JsonParams' => [ - 'description' => 'The JSON-formatted parameters of the alert callback.'."\n", - 'type' => 'string', - 'example' => '{"key1":"value1"}', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '123****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t4A288E86-45C3-4858-9DB0-6D85B10BD92A\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tGroup_ECS\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\thttps://aliyun.com\\r\\n\\t\\t\\t\\tGET\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\t86400\\r\\n\\t\\t\\t\\t22\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\t=\\r\\n\\t\\t\\t\\t\\t\\tHttpStatus\\r\\n\\t\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\t\\t400\\r\\n\\t\\t\\t\\t\\t\\tValue\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\t=\\r\\n\\t\\t\\t\\t\\t\\tHttpLatency\\r\\n\\t\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\t\\t500\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tecs_instance\\r\\n\\t\\t\\tGROUP\\r\\n\\t\\t\\tHTTP\\r\\n\\t\\t\\t123456\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\t12345\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeHostAvailabilityList', - 'description' => 'This topic provides an example to show how to query all the availability monitoring tasks of your Alibaba Cloud account. The sample responses indicate that the account has one availability monitoring task named `ecs_instance`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Delete an alert rule template', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'InstallMonitoringAgent' => [ - 'summary' => 'InstallMonitoringAgent', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleTemplate'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRuleTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"7B63F8CF-D48D-4608-A402-04FB5B2B4B6A\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"TemplateId\\": \\"123****\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteMetricRules' => [ + 'summary' => 'The DeleteMetricRules operation deletes one or more alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Force', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to install the CloudMonitor agent. Valid values:'."\n" - ."\n" - .'* true (default value): yes'."\n" - .'* false: no'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'InstanceIds', + 'name' => 'Id', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The IDs of the alert rules to delete.', 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the ECS instances.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n" - ."\n" - .'> You must specify either the `InstallCommand` or the `InstanceIds` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-m5e0k0bexac8tykr****', - ], - 'required' => false, - 'example' => 'i-m5e0k0bexac8tykr****', - 'maxItems' => 10, - ], - ], - [ - 'name' => 'InstallCommand', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to install the CloudMonitor agent on all ECS instances that belong to the current Alibaba Cloud account. Valid values:'."\n" - ."\n" - .'* `onlyInstallNotHasAgent`: installs the latest version of the CloudMonitor agent only on ECS instances on which the agent is not installed.'."\n" - .'* `onlyUpgradeAgent`: upgrades the CloudMonitor agent to the latest version only for ECS instances on which an earlier version of the agent is installed.'."\n" - .'* `installAndUpgrade`: installs the latest version of the CloudMonitor agent on ECS instances on which the agent is not installed, and upgrades the CloudMonitor agent to the latest version for ECS instances on which an earlier version of the agent is installed.'."\n" - ."\n" - .'> If you set the InstallCommand parameter, the `InstanceIds` parameter does not take effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'onlyInstallNotHasAgent', + 'items' => ['description' => 'The ID of the alert rule to delete.', 'type' => 'string', 'required' => false, 'example' => 'c3b2804a297444d0aa7bfd4fb0e4a01b', 'title' => ''], + 'required' => true, + 'example' => 'ab05733c97b7ce239fb1b53393dc1697c7e12****', + 'maxItems' => 100, + 'title' => '', ], ], ], @@ -8466,868 +6276,531 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call 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 ID of the request.'."\n", - 'type' => 'string', - 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C41945', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '09B3A484-1A2B-5743-BB6B-D796416F2677', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternetServerError', 'errorMessage' => 'InternetServerError', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteMetricRules', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t0BDAF8A8-04DC-5F0C-90E4-724D42C41945\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'InstallMonitoringAgent', - 'description' => '## Prerequisites'."\n" - ."\n" - .'The Cloud Assistant client is installed on an ECS instance. For more information about how to install the Cloud Assistant client, see [Overview](~~64601~~).'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"09B3A484-1A2B-5743-BB6B-D796416F2677\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'DescribeMonitoringAgentHosts' => [ - 'summary' => 'Queries all hosts within the current Alibaba Cloud account, including hosts on which the CloudMonitor agent is installed and uninstalled.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteMonitorGroup' => [ + 'summary' => 'Deletes an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'KeyWord', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used in fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'host1', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], - [ - 'name' => 'HostName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the host.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hostNam1', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CA35B3AE-4FFD-4A33-AE67-67EF68711EFA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Group' => [ + 'description' => 'The deleted application group.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'ECS_test', 'title' => ''], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'The alert groups that receive alert notifications for the application group.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the alert group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'InstanceIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-a3d1q1pm2f9yr29e****', - ], + ], + 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 400 => [ + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], [ - 'name' => 'SerialNumbers', - 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the host.'."\n" - ."\n" - .'After the CloudMonitor agent is installed on a host, a globally unique serial number is generated. A host that is not provided by Alibaba Cloud has a serial number instead of an instance ID.'."\n" - ."\n" - .'> This parameter can be used to accurately search for a monitored host.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a1ab31a3-1234-40f2-9e95-c8caa8f0****', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values:'."\n" - ."\n" - .'* 10'."\n" - .'* 20'."\n" - .'* 50'."\n" - .'* 100'."\n" - ."\n" - .'> Although Alibaba Cloud does not limit the maximum value of this parameter, we recommend that you do not set it to an excessively large value. If you set it to an excessively large value, a timeout error may occur.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], ], [ - 'name' => 'InstanceRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DeleteMonitorGroup', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DeleteMonitorGroupDynamicRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AliyunHost', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query Elastic Compute Service (ECS) instances that are provided by Alibaba Cloud or to query hosts that are not provided by Alibaba Cloud. Valid values:'."\n" - ."\n" - .'* true (default value): queries all the ECS instances that are provided by Alibaba Cloud.'."\n" - .'* false: queries all the hosts that are not provided by Alibaba Cloud.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'delete', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the hosts that you want to query. Valid values:'."\n" - ."\n" - .'* Running: queries the hosts that are running.'."\n" - .'* Stopped: queries the hosts that are stopped, are not installed, or fail to be installed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'SysomStatus', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - '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', - 'required' => false, - 'example' => 'running', - ], + 'schema' => ['description' => 'The service to which the rule applies. Valid values: ecs, rds, and slb.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The result of the request.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageTotal' => [ - 'description' => 'The total number of returned pages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Hosts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Host' => [ - 'description' => 'The information about the hosts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The host.'."\n", - 'type' => 'object', - 'properties' => [ - 'SerialNumber' => [ - 'description' => 'The serial number of the host. A host that is not provided by Alibaba Cloud has a serial number instead of an instance ID.'."\n" - ."\n" - .'> This parameter can be used to accurately search for a monitored host.'."\n", - 'type' => 'string', - 'example' => 'x12335-6cc8-4a22-9f21-1a00a719****', - ], - 'NatIp' => [ - 'description' => 'The IP address of the Network Address Translation (NAT) gateway.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'HostName' => [ - 'description' => 'The name of the host.'."\n", - 'type' => 'string', - 'example' => 'hostIP', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103201326074****', - ], - 'NetworkType' => [ - 'description' => 'The network type.'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-a2d5q7pm3f9yr212****', - ], - 'isAliyunHost' => [ - 'description' => 'Indicates whether the host is provided by Alibaba Cloud. Valid values:'."\n" - ."\n" - .'* true: The host is provided by Alibaba Cloud.'."\n" - .'* false: The host is not provided by Alibaba Cloud.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EipAddress' => [ - 'description' => 'The elastic IP address (EIP) of the host.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'AgentVersion' => [ - 'description' => 'The version of the CloudMonitor agent.'."\n", - 'type' => 'string', - 'example' => '3.4.6', - ], - 'IpGroup' => [ - 'description' => 'The IP address of the host.'."\n" - ."\n" - .'> Multiple IP addresses are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'EipId' => [ - 'description' => 'The ID of the EIP.'."\n", - 'type' => 'string', - 'example' => 'eip-bp16i16k9gcezyfrp****', - ], - 'Region' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'InstanceTypeFamily' => [ - 'description' => 'The type of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'ecs.n4', - ], - 'OperatingSystem' => [ - 'description' => 'The operating system.'."\n", - 'type' => 'string', - 'example' => 'Linux', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '56B4516A-EB44-4C66-8854-0393B35F636B', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tWindows\\r\\n\\t\\t\\t\\tf0a434f2-632b-4588-95e6-202d4396****\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\ti-uf6hm9lnlzsarrc7****\\r\\n\\t\\t\\t\\t3.4.6\\r\\n\\t\\t\\t\\tvpc\\r\\n\\t\\t\\t\\tecs.g6\\r\\n\\t\\t\\t\\tcn-shanghai\\r\\n\\t\\t\\t\\t192.168.XX.XX,192.168.XX.XX\\r\\n\\t\\t\\t\\tiZlzsarrc78****\\r\\n\\t\\t\\t\\t103201326074****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tLinux\\r\\n\\t\\t\\t\\t9c336dc5-1802-4db0-b7a0-2d46ad4f****\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\ti-uf6hn19s56zumk9w****\\r\\n\\t\\t\\t\\t3.4.4\\r\\n\\t\\t\\t\\tvpc\\r\\n\\t\\t\\t\\tecs.g5\\r\\n\\t\\t\\t\\tcn-shanghai\\r\\n\\t\\t\\t\\t192.168.XX.XX,192.168.XX.XX\\r\\n\\t\\t\\t\\tlaunch-advisor-2019****\\r\\n\\t\\t\\t\\t103201326074****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t100\\r\\n\\t\\t1\\r\\n\\t\\t1\\r\\n\\t\\t5\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeMonitoringAgentHosts', + 'title' => 'DeleteMonitorGroupDynamicRule', + 'summary' => 'Deletes a rule that is used to dynamically add the instances of a service to an application group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitoringAgentAccessKey' => [ - 'summary' => 'Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a third-party host.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupDynamicRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitorGroupDynamicRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"56B4516A-EB44-4C66-8854-0393B35F636B\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteMonitorGroupInstances' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'query', + 'schema' => ['description' => 'The instances to be removed from the application group. Separate multiple instances with commas (,). You can remove a maximum of 20 instances from an application group at a time.', 'type' => 'string', 'required' => true, 'example' => 'i-a2d5q7pm3f912****,i-a2d5q7pm3f222****', 'title' => ''], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessKey' => [ - 'description' => 'The AccessKey ID that is required to install the agent.'."\n", - 'type' => 'string', - 'example' => 'E7A27f9****', - ], - 'SecretKey' => [ - 'description' => 'The AccessKey secret that is required to install the agent.'."\n", - 'type' => 'string', - 'example' => 'sBjNOUhLylrxMX-Xv1****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C0F655E9-D793-51E6-BD78-CABBCCFC1047', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5351B0F2-26A9-4BC9-87FF-1B74034D12C3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n sBjNOUhLylrxMX-Xv1****\\n C0F655E9-D793-51E6-BD78-CABBCCFC1047\\n E7A27f9****\\n 200\\n true\\n","errorExample":""}]', - 'title' => 'DescribeMonitoringAgentAccessKey', + 'title' => 'DeleteMonitorGroupInstances', + 'summary' => 'Removes instances from an application group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitoringAgentConfig' => [ - 'summary' => 'Queries the configurations of the CloudMonitor agent.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitorGroupInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroupInstances', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EnableActiveAlert' => [ - 'description' => 'The cloud services for which proactive alerting is enabled.'."\n", - 'type' => 'string', - 'example' => 'redis,rds,ecs', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D', - ], - 'AutoInstall' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableInstallAgentNewECS' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed on newly purchased ECS instances. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - ], - 'description' => '', - ], - ], - ], - '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":"\\r\\n\\ttrue\\r\\n\\t\\r\\n\\ttrue\\r\\n\\tB4EB0F95-3181-4E8F-B32E-8C3734E8F88E\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeMonitoringAgentConfig', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5351B0F2-26A9-4BC9-87FF-1B74034D12C3\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DescribeMonitoringAgentStatuses' => [ - 'summary' => 'Queries the status of the CloudMonitor agent.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteMonitorGroupNotifyPolicy' => [ + 'summary' => 'Deletes a policy that is used to pause alert notifications for an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceIds', + 'name' => 'PolicyType', 'in' => 'query', 'schema' => [ - 'description' => 'The instance IDs. Separate multiple instance IDs with commas (,).'."\n", + 'description' => 'The type of the policy.'."\n" + ."\n" + .'Valid value: PauseNotify.', 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'i-hp3dunahluwajv6f****', + 'required' => true, + 'enum' => ['PauseNotify'], + 'example' => 'PauseNotify', + 'title' => '', ], ], [ - 'name' => 'HostAvailabilityTaskId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '126****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '6780****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The results returned.'."\n", + 'description' => 'None', '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' => [ - 'description' => '', - '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" - ."\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.'."\n", - 'type' => 'string', - ], - 'LoongCollectorVersion' => [ - 'type' => 'string', - ], - 'LoongCollectorStatus' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B7AF834D-D38B-4A46-920B-FE974EB7E135', 'title' => ''], + 'Result' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F\\n\\t\\n\\t\\t\\n\\t\\t\\trunning\\n\\t\\t\\ttrue\\n\\t\\t\\ti-hp3dunahluwajv6f****\\n\\t\\t\\n\\t\\n\\t200\\n\\ttrue\\n\\t","errorExample":""}]', - 'title' => 'DescribeMonitoringAgentStatuses', - '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", + 'title' => 'DeleteMonitorGroupNotifyPolicy', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyHostInfo' => [ - 'summary' => '修改非阿里云的主机显示信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupNotifyPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitorGroupNotifyPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DeleteMonitoringAgentProcess' => [ + 'summary' => 'Calls the DeleteMonitoringAgentProcess operation to delete the specified process monitoring from a specified host.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance. Only hosts not on Alibaba Cloud are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'host-R_NSWNV****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-KpVny6l****', 'title' => ''], ], [ - 'name' => 'HostName', + 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the host.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'portalHost', - ], + 'schema' => ['description' => 'The process name.'."\n" + ."\n" + .'> You must specify either ProcessId or ProcessName.', 'type' => 'string', 'required' => false, 'example' => 'http', 'title' => ''], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => ['description' => 'The process ID.'."\n" + ."\n" + .'> You must specify either ProcessId or ProcessName.', 'type' => 'string', 'required' => false, 'example' => '123****', 'title' => ''], ], ], 'responses' => [ @@ -9335,560 +6808,984 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call 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 ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EBB5215C-44AB-4000-A2D7-48634FDC4F04', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t\\tEBB5215C-44AB-4000-A2D7-48634FDC4F04\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'ModifyHostInfo', - 'description' => '****', + 'title' => 'Delete process monitoring from a specified host', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitoringConfig' => [ - 'summary' => 'Queries the global configurations of the CloudMonitor agent.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"971CC023-5A96-452A-BB7C-2483F948BCFD\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteSiteMonitors' => [ + 'summary' => 'Deletes site monitoring tasks by calling the DeleteSiteMonitors operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the tasks to be deleted. Separate multiple task IDs with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '01adacc2-ece5-41b6-afa2-3143ab5d****,43bd1ead-514f-4524-813e-228ce091****', 'title' => ''], + ], + [ + 'name' => 'IsDeleteAlarms', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to delete the alert rules associated with the tasks. Valid values:'."\n" + ."\n" + .'- true (default): Deletes the alert rules.'."\n" + ."\n" + .'- false: Does not delete the alert rules.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F35654DB-0C9D-4FB3-903F-479BA7663061', - ], - 'AutoInstall' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableInstallAgentNewECS' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed on new ECS instances. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request is successful, a success message is returned. If the request fails, the failure reason is returned, such as `TaskId not found`.', 'type' => 'string', 'example' => 'Request succeeded.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '123BCC5D-8B63-48EA-B747-9A8995BE7AA6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. The value true indicates success. The value false indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The number of affected rows.', + 'type' => 'object', + 'properties' => [ + 'count' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'UnauthorizedTasks', 'errorMessage' => 'You are not permitted to operate the specified tasks.', 'description' => 'You are not permitted to operate the specified tasks.'], + ], + [ + ['errorCode' => '%s', 'errorMessage' => 'TaskId not found', 'description' => ''], + ['errorCode' => 'TaskNotExist', 'errorMessage' => 'The specified task does not exist.', 'description' => 'The specified task does not exist.'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\tfalse\\r\\n\\ttrue\\r\\n\\tBA76F154-DE3F-442C-94D3-895E7ABC1BDE\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeMonitoringConfig', + 'staticInfo' => [], + 'title' => 'Delete site monitoring tasks', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutMonitoringConfig' => [ - 'summary' => 'Configures global settings for the CloudMonitor agent.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:22:22.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSiteMonitors'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteSiteMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Request succeeded.\\",\\n \\"RequestId\\": \\"123BCC5D-8B63-48EA-B747-9A8995BE7AA6\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","type":"json"}]', + ], + 'DescribeActiveMetricRuleList' => [ + 'summary' => 'Queries initiative alert rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AutoInstall', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EnableInstallAgentNewECS', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to automatically install the CloudMonitor agent on new ECS instances. Valid values:'."\n" - ."\n" - .'* true (default): The CloudMonitor agent is automatically installed on new ECS instances.'."\n" - .'* false: The CloudMonitor agent is not automatically installed on new ECS instances.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The abbreviation of the cloud service that supports initiative alert rules.'."\n" + ."\n" + .'For more information about how to obtain the name of a cloud service, see [DescribeProductsOfActiveMetricRule](~~114930~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Specified parameter EnableInstallAgentNewECS is not valid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => 'The details of the alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'EvaluationCount' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'State' => ['description' => 'Indicates whether the alert rule is enabled.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'SystemDefault_acs_rds_dashboard_CpuUsage', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of monitoring data.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator that is used in the alert rule. Valid values:'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `=`', 'type' => 'string', 'example' => '>', 'title' => ''], + 'EndTime' => ['description' => 'The end of the time period during which the alert rule is effective.'."\n" + ."\n" + .'Unit: hours. For example, the value 23 indicates `23:59:59`.', 'type' => 'string', 'example' => '24', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time period during which the alert rule is effective.'."\n" + ."\n" + .'Unit: hours. For example, the value 00 indicates `00:00:00`.', 'type' => 'string', 'example' => '00', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- true: The alert rule is enabled.'."\n" + ."\n" + .'- false: The alert rule is disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'AlertList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alert' => [ + 'description' => 'The details of the alert rules. The result is in the same structure as that returned by the DescribeMetricRuleList operation.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.', 'type' => 'string', 'example' => 'http://www.aliyun.com', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The time period during which the alert rule is effective.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time period during which the alert rule is ineffective.', 'type' => 'string', 'example' => '00:00-06:00', 'title' => ''], + 'MailSubject' => ['description' => 'The subject of the alert notification email.', 'type' => 'string', 'example' => 'ECS_Bucket', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'myAlert', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'ruleIdxxxx', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of monitoring data.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'AlertState' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- OK: The alert rule has no active alerts.'."\n" + ."\n" + .'- ALARM: The alert rule has active alerts.'."\n" + ."\n" + .'- INSUFFICIENT\\_DATA: No data is found.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Dimensions' => ['description' => 'The monitoring data of the specified resource.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'EnableState' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- true: The alert rule is enabled.'."\n" + ."\n" + .'- false: The alert rule is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => ['description' => 'The resources that are associated with the alert rule.', 'type' => 'string', 'example' => '[{"resource":"_ALL"}]', 'title' => ''], + 'Escalations' => [ + 'description' => 'The conditions for triggering different levels of alerts.', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'The conditions for triggering Info-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', 'type' => 'string', 'example' => 'GreaterThanThreshold', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times'."\n" + ."\n" + .'for which the metric value meets the alert condition before an Info-level alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Info-level alerts.', 'type' => 'string', 'example' => '95', 'title' => ''], + 'Statistics' => ['description' => 'The statistical methods for Info-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Warn' => [ + 'description' => 'The conditions for triggering Warn-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', 'type' => 'string', 'example' => 'GreaterThanThreshold', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times'."\n" + ."\n" + .'for which the metric value meets the alert condition before a Warn-level alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Warn-level alerts.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'Statistics' => ['description' => 'The statistical methods for Warn-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'The trigger condition for Critical-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', 'type' => 'string', 'example' => 'GreaterThanThreshold', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Critical-level alerts.', 'type' => 'string', 'example' => '99', 'title' => ''], + 'Statistics' => ['description' => 'The statistical methods for Critical-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], ], - '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":"\\n 109C8095-6FAD-4DBB-B013-6ED18CE4C0B1\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'PutMonitoringConfig', + 'title' => 'DescribeActiveMetricRuleList', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UninstallMonitoringAgent' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveMetricRuleList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeActiveMetricRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeAlertHistoryList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the host.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'host-****', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successfully', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '466902B9-2842-40B0-B796-00FE772B6EF3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'For information about how to query the name of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Rule', 'title' => ''], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For information about how to query the namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric that is used to monitor the cloud service.'."\n" + ."\n" + .'For information about how to query the name of a metric, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => '7671****', 'title' => ''], ], - 412 => [ - [ - 'errorCode' => 'AgentStateError', - 'errorMessage' => 'Expected agent running state is stopped.', - ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether alerts are muted. Valid values:'."\n" + ."\n" + .'- 2 (default value): Alerts are muted and are not triggered within the mute period, even if the condition specified in the alert rule is met.'."\n" + ."\n" + .'- 0: Alerts are triggered or cleared.'."\n" + ."\n" + .'- 1: The alert rule is ineffective.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => ['description' => 'The status of the alert. Valid values:'."\n" + ."\n" + .'- ALARM (default value): Alerts are triggered.'."\n" + ."\n" + .'- OK: No alerts are triggered.', 'type' => 'string', 'required' => false, 'example' => 'ALARM', 'title' => ''], ], - ], - '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":"\\n 466902B9-2842-40B0-B796-00FE772B6EF3\\n 200\\n Successfully\\n","errorExample":""}]', - 'title' => 'UninstallMonitoringAgent', - 'summary' => 'Uninstalls the CloudMonitor agent from a third-party host.', - 'description' => '> This API operation is not applicable to Elastic Compute Service (ECS) instances. To uninstall the agent from an ECS instance, see [Install and uninstall the CloudMonitor agent](~~183482~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateMonitoringAgentProcess' => [ - 'summary' => 'Creates a task to monitor a process.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Ascending', + 'in' => 'query', + 'schema' => ['description' => 'The order of alerts. Valid values:'."\n" + ."\n" + .'- true (default value): reverse chronological order'."\n" + ."\n" + .'- false: chronological order', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'ProcessName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'java', - ], + 'schema' => ['description' => 'The start timestamp of the historical alerts that you want to query.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640237400000', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => ' i-2ze51wjtwox01r8g****', - ], + 'schema' => ['description' => 'The end timestamp of the historical alerts that you want to query.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640608200000', 'title' => ''], ], [ - 'name' => 'ProcessUser', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The user who launches the process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0DFCB47D-E7E1-4CBE-A381-8339F7B300EF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The process ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - ], - 'description' => '', - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlarmHistoryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlarmHistory' => [ + 'description' => 'The details of historical alerts.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether alerts are muted. Valid values:'."\n" + ."\n" + .'- 2 (default): Alerts are muted and are not triggered within the mute period, even if the condition specified in the alert rule is met.'."\n" + ."\n" + .'- 0: Alerts are triggered or cleared.'."\n" + ."\n" + .'- 1: The alert rule is ineffective.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'EvaluationCount' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'State' => ['description' => 'The alert status. Valid values:'."\n" + ."\n" + .'- ALARM: Alerts are triggered.'."\n" + ."\n" + .'- OK: No alerts are triggered.', 'type' => 'string', 'example' => 'ALARM', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Webhooks' => ['description' => 'The callback URL.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'ECS_Rule', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', 'title' => ''], + 'LastTime' => ['description' => 'The duration of the alert. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '360133', 'title' => ''], + 'Value' => ['description' => 'The threshold of the metric value to trigger or clear an alert.', 'type' => 'string', 'example' => '10.58', 'title' => ''], + 'Expression' => ['description' => 'The expression that is used to trigger alerts.', 'type' => 'string', 'example' => '$Average>=10', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '7671****', 'title' => ''], + 'AlertTime' => ['description' => 'The timestamp when the alert was triggered. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640586600000', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'i-bp1cqhiw1za2****', 'title' => ''], + 'Dimensions' => ['description' => 'The resources that are monitored.', 'type' => 'string', 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}', 'title' => ''], + 'Level' => ['description' => 'The severity level and notification methods of the alert. Valid values:'."\n" + ."\n" + .'- P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: No alert is generated.', 'type' => 'string', 'example' => 'P4', 'title' => ''], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => 'The alert contacts that receive alert notifications.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact that receives alert notifications.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ContactALIIMs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactALIIM' => [ + 'description' => 'The TradeManager IDs of the alert contacts.'."\n" + ."\n" + .'> This parameter is valid only on the China site (aliyun.com).', + 'type' => 'array', + 'items' => ['description' => 'The TradeManager ID of the alert contact.'."\n" + ."\n" + .'> This parameter is valid only on the China site (aliyun.com).', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ContactMails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactMail' => [ + 'description' => 'The email addresses of the alert contacts.', + 'type' => 'array', + 'items' => ['description' => 'The email address of the alert contact.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ContactSmses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactSms' => [ + 'description' => 'The mobile numbers of the alert contacts.'."\n" + ."\n" + .'> This parameter is valid only on the China site (aliyun.com).', + 'type' => 'array', + 'items' => ['description' => 'The mobile number of the alert contact.'."\n" + ."\n" + .'> This parameter is valid only on the China site (aliyun.com).', 'type' => 'string', 'example' => '13900009999', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'The alert contact groups.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError ', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n 0DFCB47D-E7E1-4CBE-A381-8339F7B300EF\\n 171894\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'CreateMonitoringAgentProcess', - 'requestParamsDescription' => ' ', + 'staticInfo' => [ + 'substitutions' => ['Cms::2019-01-01::DescribeAlertLogList'], + ], + 'title' => 'DescribeAlertHistoryList', + 'summary' => 'Queries historical alerts.', + 'description' => 'This API operation is no longer maintained. We recommend that you call the [DescribeAlertLogList](~~201087~~) operation.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMonitorAgentProcess' => [ - 'summary' => 'Creates a task to monitor a process.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertHistoryList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertHistoryList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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 \\"username@example.com\\"\\n ]\\n },\\n \\"ContactMails\\": {\\n \\"ContactMail\\": [\\n \\"username@example.com\\"\\n ]\\n },\\n \\"ContactSmses\\": {\\n \\"ContactSms\\": [\\n \\"13900009999\\"\\n ]\\n },\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"ECS_Group\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAlertLogCount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ProcessName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AliYunDun', - ], + 'schema' => ['description' => 'The start timestamp of the alert logs to be queried.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogCount` parameter is empty.'."\n" + ."\n" + .'> The interval between the start time (StartTime) and end time (EndTime) must be less than or equal to 15 days. The start time and end time must be specified or left empty at the same time. If you do not specify the start time and end time, the alert logs within the last 15 minutes are queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1609988009694', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-2ze2d6j5uhg20x47****', - ], + 'schema' => ['description' => 'The end timestamp of the alert logs to be queried.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogCount` parameter is empty.'."\n" + ."\n" + .'> The interval between the start time (StartTime) and end time (EndTime) must be less than or equal to 15 days. The start time and end time must be specified or left empty at the same time. If you do not specify the start time and end time, the alert logs within the last 15 minutes are queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1610074409694', 'title' => ''], ], [ - 'name' => 'ProcessUser', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The user who launches the process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" + ."\n" + .'- `product`: aggregates data by cloud service.'."\n" + ."\n" + .'- `level`: aggregates data by alert level.'."\n" + ."\n" + .'- `groupId`: aggregates data by application group.'."\n" + ."\n" + .'- `contactGroup`: aggregates data by alert contact group.'."\n" + ."\n" + .'- `product,metricName`: aggregates data both by cloud service and by metric.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => ['description' => 'The keyword based on which the alert logs to be counted are searched.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'> For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => ['description' => 'The abbreviation of the service name.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The level and notification method of the alert. Valid values:'."\n" + ."\n" + .'- P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: No alert is generated.', 'type' => 'string', 'required' => false, 'example' => 'P4', 'title' => ''], + ], + [ + 'name' => 'SendStatus', + 'in' => 'query', + 'schema' => ['description' => 'The status of the alert. Valid values:'."\n" + ."\n" + .'- 0: The alert is triggered or cleared.'."\n" + ."\n" + .'- 1: The alert is generated not during the effective period.'."\n" + ."\n" + .'- 2: The alert is muted and not triggered in a specified period.'."\n" + ."\n" + .'- 3: The host is restarting.'."\n" + ."\n" + .'- 4: Notifications are not sent for the alert.'."\n" + ."\n" + .'When the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => ['description' => 'The alert group.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'LastMin', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of alert logs. Unit: minutes.', 'type' => 'string', 'required' => false, 'example' => '360', 'title' => ''], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => ['description' => 'The dimension based on which data is aggregated. This parameter is similar to the Group By clause of SQL statements. Valid values:'."\n" + ."\n" + .'- `product`: aggregates data by cloud service.'."\n" + ."\n" + .'- `level`: aggregates data by alert level.'."\n" + ."\n" + .'- `groupId`: aggregates data by application group.'."\n" + ."\n" + .'- `contactGroup`: aggregates data by alert group.'."\n" + ."\n" + .'- `product,metricName`: aggregates data both by cloud service and by metric.', 'type' => 'string', 'required' => true, 'example' => 'product', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the alert event. Valid values:'."\n" + ."\n" + .'- TRIGGERED: The alert is triggered.'."\n" + ."\n" + .'- RESOLVED: The alert is resolved.', 'type' => 'string', 'required' => false, 'example' => 'TRIGGERED', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'bfae2ca5b4e07d2c7278772e***********', 'title' => ''], ], ], 'responses' => [ @@ -9896,746 +7793,1226 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The process ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlertLogCount' => [ + 'description' => 'The statistics of alert logs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The number of alert logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Logs' => [ + 'description' => 'The details about alert logs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the dimension field based on which alert logs are aggregated.', 'type' => 'string', 'example' => 'product', 'title' => ''], + 'Value' => ['description' => 'The value of the dimension field based on which alert logs are aggregated.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n 971CC023-5A96-452A-BB7C-2483F948BCFD\\n 123456\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'CreateMonitorAgentProcess', - 'requestParamsDescription' => ' ', + 'title' => 'DescribeAlertLogCount', + 'summary' => 'Queries the statistics of alert logs.', + 'description' => 'Queries the statistics of alert logs.'."\n" + ."\n" + .'This topic provides an example on how to query the statistics of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-12-07T03:28:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T09:48:52.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogCount'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertLogCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'DescribeMonitoringAgentProcesses' => [ - 'summary' => '查询指定资源的进程数列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAlertLogHistogram' => [ + 'summary' => 'Queries the number of alert logs that are generated during each interval within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-hp3hl3cx1pbahzy8****', - ], + 'schema' => ['description' => 'The start timestamp of the alert logs to be queried.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You can query only the alert logs within the last year.'."\n" + ."\n" + .'- The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1609988009694', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The value 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'C11C0E85-6862-4F25-8D66-D6A5E0882984', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeProcesses' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NodeProcess' => [ - 'description' => 'The information about the processes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProcessName' => [ - 'description' => 'The name of the process.'."\n", - 'type' => 'string', - 'example' => 'Nginx', - ], - 'ProcessId' => [ - 'description' => 'The ID of the process.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234567', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '3619****', - ], - 'Command' => [ - 'description' => 'The command used to obtain the number of processes. Valid value: `number`.'."\n" - ."\n" - .'> The `number` command obtains the number of processes that match the condition.'."\n", - 'type' => 'string', - 'example' => 'number', - ], - 'ProcessUser' => [ - 'description' => 'The user who launched the process.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-hp3hl3cx1pbahzy8****', - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp of the alert logs to be queried.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You can query only the alert logs within the last year.'."\n" + ."\n" + .'- The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1609989009694', 'title' => ''], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => ['description' => 'The keyword that is used to query alert logs.', 'type' => 'string', 'required' => false, 'example' => 'alert', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], ], - ], - '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' => 'DescribeMonitoringAgentProcesses', - 'description' => '> Before you call this operation, call the CreateMonitoringAgentProcess operation to create processes. For more information, see [CreateMonitoringAgentProcess](~~114951~~~).'."\n" - ."\n" - .'This topic provides an example of how to query the processes of the `i-hp3hl3cx1pbahzy8****` instance. The response indicates the details of the `NGINX` and `HTTP` processes.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMonitoringAgentProcess' => [ - 'summary' => 'Disables monitoring on a process.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Product', + 'in' => 'query', + 'schema' => ['description' => 'The abbreviation of the Alibaba Cloud service name.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-KpVny6l****', - ], + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'> For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'ProcessName', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'description' => 'The process name.'."\n" - ."\n" - .'> You must configure either `ProcessId` or `ProcessName`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http', - ], + 'schema' => ['description' => 'The severity level and notification methods of the alert. Valid values:'."\n" + ."\n" + .'- P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: No alert is generated.', 'type' => 'string', 'required' => false, 'example' => 'P4', 'title' => ''], ], [ - 'name' => 'ProcessId', + 'name' => 'SendStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The process ID.'."\n" - ."\n" - .'> You must configure either `ProcessId` or `ProcessName`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123****', - ], + 'schema' => ['description' => 'The alert status. Valid values:'."\n" + ."\n" + .'- 0: The alert is triggered or cleared.'."\n" + ."\n" + .'- 1: The alert is ineffective.'."\n" + ."\n" + .'- 2: The alert is muted and not triggered in a specified period.'."\n" + ."\n" + .'- 3: The host is restarting.'."\n" + ."\n" + .'- 4: No alert notification is sent.'."\n" + ."\n" + .'If the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name.'."\n" + ."\n" + .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'LastMin', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of alert logs. Unit: minutes.', 'type' => 'string', 'required' => false, 'example' => '360', 'title' => ''], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => ['description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" + ."\n" + .'- `product`: aggregates data by cloud service.'."\n" + ."\n" + .'- `level`: aggregates data by alert level.'."\n" + ."\n" + .'- `groupId`: aggregates data by application group.'."\n" + ."\n" + .'- `contactGroup`: aggregates data by alert contact group.'."\n" + ."\n" + .'- `product,metricName`: aggregates data both by cloud service and by metric.', 'type' => 'string', 'required' => false, 'example' => 'product', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the alert event. Valid values:'."\n" + ."\n" + .'- TRIGGERED: The alert is triggered.'."\n" + ."\n" + .'- RESOLVED: The alert is resolved.', 'type' => 'string', 'required' => false, 'example' => 'RESOLVED', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'ae06917_75a8c43178ab66****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => '971CC023-5A96-452A-BB7C-2483F948BCFD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlertLogHistogramList' => [ + 'description' => 'The number of alert logs that were generated during each interval of a time period.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'From' => ['description' => 'The start timestamp of the queried alert logs.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1610074791', 'title' => ''], + 'To' => ['description' => 'The end timestamp of the queried alert logs.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1610074800', 'title' => ''], + 'Count' => ['description' => 'The number of alert logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n EBB5215C-44AB-4000-A2D7-48634FDC4F04\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'DeleteMonitoringAgentProcess', - 'requestParamsDescription' => ' ', + 'title' => 'DescribeAlertLogHistogram', + 'description' => 'This topic provides an example on how to query the number of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSystemEventHistogram' => [ - 'summary' => 'Queries the number of times a system event occurred during each interval within a period of time.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-12-07T03:28:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T09:48:52.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogHistogram'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertLogHistogram', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeAlertLogList' => [ + 'summary' => 'Queries the alert history by calling the DescribeAlertLogList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Product', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the service name.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the abbreviations of service names.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], + 'schema' => ['description' => 'The beginning of the time range to query the alert history.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'You can query only the alert history within the last year. If the query time range exceeds one year, the return value of the `AlertLogList` parameter is empty.'."\n" + ."\n" + .'> The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days. Both parameters must be specified or unspecified at the same time. If they are not specified, the alert history within the last 15 minutes is queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1609988009694', 'title' => ''], ], [ - 'name' => 'EventType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The event type.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the types of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exception', - ], + 'schema' => ['description' => 'The end of the time range to query the alert history.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'You can query only the alert history within the last year. If the query time range exceeds one year, the return value of the `AlertLogList` parameter is empty.'."\n" + ."\n" + .'> The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days. Both parameters must be specified or unspecified at the same time. If they are not specified, the alert history within the last 15 minutes is queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1610074409694', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The event name.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the names of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BucketIngressBandwidth', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the event. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'SearchKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The event status.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the status of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], + 'schema' => ['description' => 'The keyword used to query the alert history.', 'type' => 'string', 'required' => false, 'example' => 'alert', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], ], [ - 'name' => 'SearchKeywords', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the system event. Valid values:'."\n" - ."\n" - .'* If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" - .'* If you want to search for the system event whose content contains a or b, set the value to `a or b`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'> For more information about the namespaces of cloud services, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552209685596', - ], + 'schema' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'For more information about how to obtain the abbreviation of a cloud service name, see [DescribeProductsOfActiveMetricRule](~~114930~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552220485596', - ], + 'schema' => ['description' => 'The alert level and notification methods. Valid values:'."\n" + ."\n" + .'- P2: phone calls, text messages, emails, and DingTalk chatbots.'."\n" + ."\n" + .'- P3: text messages, emails, and DingTalk chatbots.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.', 'type' => 'string', 'required' => false, 'example' => 'P4', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'SystemEventHistograms' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SystemEventHistogram' => [ - 'description' => 'The information about the number of times the system event occurred during each interval of a time period.'."\n", - 'type' => 'array', - 'items' => [ + [ + 'name' => 'SendStatus', + 'in' => 'query', + 'schema' => ['description' => 'The alert status. Valid values:'."\n" + .'- 0: An alert is triggered or cleared.'."\n" + .'- 1: The current time is not within the effective period of the alert.'."\n" + .'- 2: The current time is within the channel silence period.'."\n" + .'- 3: The host is being restarted.'."\n" + .'- 4: No alerts are sent.'."\n" + ."\n" + .'When the alert status is 0, an alert is triggered if Level is set to P2, P3, or P4; the alert is cleared if Level is set to OK.'."\n" + .'When the alert status is 0, an alert is triggered if Level is set to P4; the alert is cleared if Level is set to OK.'."\n" + .'When the alert status is 0, an alert is triggered if Level is set to P4; the alert is cleared if Level is set to OK.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'>For more information about the metrics of cloud services, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'IntranetInRate', 'title' => ''], + ], + [ + 'name' => 'LastMin', + 'in' => 'query', + 'schema' => ['description' => 'The interval at which logs are obtained. Unit: minutes.', 'type' => 'string', 'required' => false, 'example' => '360', 'title' => ''], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => ['description' => 'The spatial dimension by which the data is aggregated, which is equivalent to Group By in SQL. Valid values:'."\n" + .'- `product`: aggregates data by cloud service.'."\n" + .'- `level`: aggregates data by alert level.'."\n" + .'- `groupId`: aggregates data by application group.'."\n" + .'- `contactGroup`: aggregates data by alert contact group.'."\n" + .'- `product,metricName`: aggregates data by cloud service and metric. ', 'type' => 'string', 'required' => false, 'example' => 'product', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For more information about how to query the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'bc369e8_30f87e517ed2fc****', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the alert rule. Valid value: METRIC, which indicates a time series metric alert rule.', 'type' => 'string', 'required' => false, 'example' => 'METRIC', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The alert type. Valid values:'."\n" + ."\n" + .'- TRIGGERED: The alert is triggered.'."\n" + ."\n" + .'- RESOLVED: The alert is cleared.', 'type' => 'string', 'required' => false, 'example' => 'TRIGGERED', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'AlertLogList' => [ + 'description' => 'The list of alert history entries.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'EventName' => ['description' => 'The name of the event.', 'type' => 'string', 'example' => 'IOHang', 'title' => ''], + 'Product' => ['description' => 'The cloud service identifier. Valid values:'."\n" + ."\n" + .'- For an Alibaba Cloud service, the value is the abbreviation of the cloud service name. Example: ECS.'."\n" + ."\n" + .'- For a non-Alibaba Cloud service, the value is in the format of `acs_Product keyword`. Example: acs_networkmonitor.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'BlackListUUID' => ['description' => 'The UUID of the matched alert blacklist.', 'type' => 'string', 'example' => '8410dbbd-7d30-41c5-94cb-****', 'title' => ''], + 'Message' => ['description' => 'The alert-related information, which is a JSON string.', 'type' => 'string', 'example' => '{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'LevelChange' => ['description' => 'The change of the alert level. Valid values:'."\n" + .'- `P4->OK`: The alert level changes from P4 to OK, which indicates that the alert is cleared.'."\n" + .'- `P4->P4`: indicates a P4-level alert.', 'type' => 'string', 'example' => 'P4->OK', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'example' => 'i-m5e1qg6uo38rztr4****', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'CPU utilization', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'd582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime', 'title' => ''], + 'BlackListName' => ['description' => 'The name of the matched alert blacklist.', 'type' => 'string', 'example' => 'Black_Test', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'ECS_Instances', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '7301****', 'title' => ''], + 'AlertTime' => ['description' => 'The timestamp when the alert was triggered.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1610043776621', 'title' => ''], + 'InstanceName' => ['description' => 'The name of the resource.', 'type' => 'string', 'example' => 'portalHost', 'title' => ''], + 'BlackListDetail' => ['description' => 'The details of the matched alert blacklist.', '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"}', 'title' => ''], + 'Level' => ['description' => 'The alert level and notification methods. Valid values:'."\n" + ."\n" + .'- P2: phone calls, text messages, emails, and DingTalk chatbots.'."\n" + ."\n" + .'- P3: text messages, emails, and DingTalk chatbots.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.', 'type' => 'string', 'example' => 'P4', 'title' => ''], + 'SendStatus' => ['description' => 'The alert status. Valid values:'."\n" + .'- 0: An alert is triggered or cleared.'."\n" + .'- 1: The current time is not within the effective period of the alert.'."\n" + .'- 2: The current time is within the channel silence period.'."\n" + .'- 3: The host is being restarted.'."\n" + .'- 4: No alerts are sent.'."\n" + ."\n" + .'When the alert status is 0, an alert is triggered if Level is set to P2, P3, or P4; the alert is cleared if Level is set to OK.'."\n" + .'When the alert status is 0, an alert is triggered if Level is set to P4; the alert is cleared if Level is set to OK.'."\n" + .'When the alert status is 0, an alert is triggered if Level is set to P4; the alert is cleared if Level is set to OK.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ExtendedInfo' => [ + 'description' => 'The extended information of the alert.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the extension field.', 'type' => 'string', 'example' => 'userId', 'title' => ''], + 'Value' => ['description' => 'The value of the extension field.', 'type' => 'string', 'example' => '100931896542****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Dimensions' => [ + 'description' => 'The dimensions of the resource for which the alert is triggered.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the alerting resource.', 'type' => 'string', 'example' => 'instanceId', 'title' => ''], + 'Value' => ['description' => 'The value of the alerting resource.', 'type' => 'string', 'example' => 'i-m5e1qg6uo38rztr4****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WebhookList' => [ + 'description' => 'The list of URLs that are called back when the alert is triggered.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code returned for the alert callback.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'url' => ['description' => 'The URL that is called back when the alert is triggered.', 'type' => 'string', 'example' => 'https://www.aliyun.com/webhook.html', 'title' => ''], + 'message' => ['description' => 'The information returned for the alert callback.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DingdingWebhookList' => [ + 'description' => 'The list of webhook URLs of DingTalk chatbots for the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of webhook URLs of DingTalk chatbots for the alert contact.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactOnCallList' => [ + 'description' => 'The list of phone numbers of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of phone numbers of the alert contact.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => '1368888****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactMailList' => [ + 'description' => 'The list of email addresses of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of email addresses of the alert contact.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactGroups' => [ + 'description' => 'The list of alert contact groups.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactALIIWWList' => [ + 'description' => 'The list of Wangwang IDs of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of Wangwang IDs of the alert contact.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactSMSList' => [ + 'description' => 'The list of phone numbers that receive text messages of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of phone numbers that receive text messages of the alert contact.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => '1368888****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactDingList' => [ + 'description' => 'The list of DingTalk accounts of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of DingTalk accounts of the alert contact.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SendDetail' => [ + 'description' => 'The details of the alert pushing result.', 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552225753000', - ], - 'StartTime' => [ - 'description' => 'The start time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552225770000', + 'ResultCode' => ['description' => 'The pushing status of the alert information.'."\n" + ."\n" + .'- success: The alert was pushed.'."\n" + ."\n" + .'- error code: If a configuration error occurs and the pushing list is empty, an error code is displayed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ChannelResultList' => [ + 'description' => 'The list of alert pushing results by alert channel.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert pushing result by alert channel.', + 'type' => 'object', + 'properties' => [ + 'Channel' => ['description' => 'The alert pushing channel. Valid values:'."\n" + ."\n" + .'- MAIL: email.'."\n" + ."\n" + .'- SMS: text message.'."\n" + ."\n" + .'- WEBHOOK: alert callback.'."\n" + ."\n" + .'- SLS: Log Service.'."\n" + ."\n" + .'- ONCALL: phone call.'."\n" + ."\n" + .'- FC: Function Compute.'."\n" + ."\n" + .'- MNS: Message Service (MNS).', 'type' => 'string', 'example' => 'MAIL', 'title' => ''], + 'ResultList' => [ + 'description' => 'The list of alert information results that CloudMonitor sends to the alert channel.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert information result that CloudMonitor sends to the alert channel.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- If `Channel` is set to `WEBHOOK`, the status code is 200 or 500.'."\n" + ."\n" + .'- If `Channel` is set to `MAIL`, `SMS`, `SLS`, `ONCALL`, `FC`, or `MNS`, this parameter is unavailable or empty.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID returned by calling another cloud service.', 'type' => 'string', 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C4****', 'title' => ''], + 'Success' => ['description' => 'The result of calling the target.'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Detail' => ['description' => 'The details of the returned result.', 'type' => 'string', 'example' => '{ }', 'title' => ''], + 'notifyTargetList' => [ + 'description' => 'The list of channel notifications.', + 'type' => 'array', + 'items' => ['description' => 'The list of channel notifications.', 'type' => 'string', 'example' => 'MAIL', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Count' => [ - 'description' => 'The number of times the system event occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', + ], + 'title' => '', + 'example' => '', + ], + 'Escalation' => [ + 'description' => 'The rule that triggers the alert.', + 'type' => 'object', + 'properties' => [ + 'Expression' => ['description' => 'The description of the rule that triggers the alert.'."\n" + ."\n" + .'> The body of the alert rule. An alert rule is triggered when the monitoring data meets the alert conditions.', 'type' => 'string', 'example' => '$Average<90', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert is retried.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Level' => ['description' => 'The alert level and notification methods. Valid values:'."\n" + ."\n" + .'- P2: phone calls, text messages, emails, and DingTalk chatbots.'."\n" + ."\n" + .'- P3: text messages, emails, and DingTalk chatbots.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.'."\n" + ."\n" + .'- P4: emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: no alerts.', 'type' => 'string', 'example' => 'P4', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SendResultList' => [ + 'description' => 'The list of alert sending results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of alert sending results.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The channel that sends the alert. Valid values:'."\n" + .'- MAIL: email.'."\n" + .'- ALIIM: Wangwang.'."\n" + .'- SMS: text message.'."\n" + .'- CALL: phone call.'."\n" + .'- DING: DingTalk chatbot.'."\n" + .'- Merged: alert combination.', 'type' => 'string', 'example' => 'MAIL', 'title' => ''], + 'Value' => [ + 'description' => 'The notification target that corresponds to the alert channel.', + 'type' => 'array', + 'items' => ['description' => 'The notification target that corresponds to the alert channel.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'LogId' => ['description' => 'The log ID.', 'type' => 'string', 'example' => '7510****::e8a472a0-46ae-4ac0-84b1-e46be368****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t\\tE38CA81A-A012-4C59-B694-42AAFBE27ED2\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671700000\\r\\n\\t\\t\\t\\t1593671684000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671730000\\r\\n\\t\\t\\t\\t1593671700000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671760000\\r\\n\\t\\t\\t\\t1593671730000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671790000\\r\\n\\t\\t\\t\\t1593671760000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671820000\\r\\n\\t\\t\\t\\t1593671790000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671850000\\r\\n\\t\\t\\t\\t1593671820000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671880000\\r\\n\\t\\t\\t\\t1593671850000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671910000\\r\\n\\t\\t\\t\\t1593671880000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671940000\\r\\n\\t\\t\\t\\t1593671910000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593671970000\\r\\n\\t\\t\\t\\t1593671940000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672000000\\r\\n\\t\\t\\t\\t1593671970000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672030000\\r\\n\\t\\t\\t\\t1593672000000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672060000\\r\\n\\t\\t\\t\\t1593672030000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672090000\\r\\n\\t\\t\\t\\t1593672060000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672120000\\r\\n\\t\\t\\t\\t1593672090000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672150000\\r\\n\\t\\t\\t\\t1593672120000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672180000\\r\\n\\t\\t\\t\\t1593672150000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672210000\\r\\n\\t\\t\\t\\t1593672180000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672240000\\r\\n\\t\\t\\t\\t1593672210000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672270000\\r\\n\\t\\t\\t\\t1593672240000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672300000\\r\\n\\t\\t\\t\\t1593672270000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672330000\\r\\n\\t\\t\\t\\t1593672300000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672360000\\r\\n\\t\\t\\t\\t1593672330000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672390000\\r\\n\\t\\t\\t\\t1593672360000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672420000\\r\\n\\t\\t\\t\\t1593672390000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672450000\\r\\n\\t\\t\\t\\t1593672420000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672480000\\r\\n\\t\\t\\t\\t1593672450000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672510000\\r\\n\\t\\t\\t\\t1593672480000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672540000\\r\\n\\t\\t\\t\\t1593672510000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672570000\\r\\n\\t\\t\\t\\t1593672540000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1593672584000\\r\\n\\t\\t\\t\\t1593672570000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n\\r\\n","errorExample":""}]', - 'title' => 'DescribeSystemEventHistogram', - 'requestParamsDescription' => ' ', + 'title' => 'Queries the alert history', + 'description' => 'This operation can query the alert history only within the last year.'."\n" + ."\n" + .'This topic provides an example to show how to query the alert history of Elastic Compute Service (ECS) from the cloud service `product` dimension.', + 'requestParamsDescription' => ' For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSystemEventMetaList' => [ - 'summary' => 'Queries the meta information about system events.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-12-07T03:28:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T09:48:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-29T06:58:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-29T08:09:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-29T08:09:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertLogList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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 utilization\\",\\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 \\"username@example.com\\"\\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 \\"username@example.com\\"\\n ]\\n }\\n ],\\n \\"LogId\\": \\"7510****::e8a472a0-46ae-4ac0-84b1-e46be368****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAlertingMetricRuleResources' => [ + 'summary' => 'Queries the list of resources that are triggering alerts for a specified alert rule.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The alert rule ID. For information about how to query alert rule IDs, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The application group ID. For information about how to query application group IDs, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7671****', 'title' => ''], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. '."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The data namespace of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the data namespace of a cloud service, see [Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_mns_new', 'title' => ''], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => ['description' => 'The dimension map used to query monitoring data for a specified resource.', 'type' => 'string', 'required' => false, 'example' => '{\\"userId\\":\\"120886317861****\\",\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\"}', 'title' => ''], + ], + [ + 'name' => 'AlertBeforeTime', + 'in' => 'query', + 'schema' => ['description' => 'Queries alerts that occurred before this point in time. The value is a millisecond-level timestamp.', 'type' => 'string', 'required' => false, 'example' => '1698827400000', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A6582C8B-E67C-4A19-BC15-EAEFEBDC7995', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0724011B-D9E0-4B2F-8C51-F17A894CC42C', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Resource' => [ - 'description' => 'The queried meta information.'."\n", + 'description' => 'The list of resources associated with the alert rule.', 'type' => 'array', 'items' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the system event.'."\n", - 'type' => 'string', - 'example' => 'failed', - ], - 'EventType' => [ - 'description' => 'The type of the system event. Valid values:'."\n" - ."\n" - .'* StatusNotification: fault notifications'."\n" - .'* Exception: exceptions'."\n" - .'* Maintenance: O\\&M'."\n", - 'type' => 'string', - 'example' => 'Exception', - ], - 'Product' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'example' => 'ADS', - ], - 'NameDesc' => [ - 'description' => 'The description of the event name.'."\n", - 'type' => 'string', - 'example' => 'High query failure rate', - ], - 'NameDesc.En' => [ - 'description' => 'The description of the system event.'."\n", - 'type' => 'string', - 'example' => 'High query failure rate.', - ], - 'Name' => [ - 'description' => 'The name of the system event.'."\n", - 'type' => 'string', - 'example' => 'SelectFailureRate', - ], - 'StatusDesc' => [ - 'description' => 'The description of the event status.'."\n", - 'type' => 'string', - 'example' => 'Operation Failed', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'INFO', + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'ActiveMessages', 'title' => ''], + 'RetryTimes' => ['description' => 'The number of alert retries.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'MetricValues' => ['description' => 'The metric values when the alert was triggered. The value is a JSON string.', '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\\"}', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_mns_new', 'title' => ''], + 'RuleName' => ['description' => 'The alert rule name.', 'type' => 'string', 'example' => 'test123456789', 'title' => ''], + 'RuleId' => ['description' => 'The alert rule ID.', 'type' => 'string', 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', 'title' => ''], + 'ProductCategory' => ['description' => 'The cloud service type.', 'type' => 'string', 'example' => 'mns', 'title' => ''], + 'StartTime' => ['description' => 'The timestamp when the resource was associated with the alert rule.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1622427900000', 'title' => ''], + 'Resource' => ['description' => 'The resource that triggered the alert.', 'type' => 'string', 'example' => 'userId=120886317861****,region=cn-huhehaote,queue=test-0128', 'title' => ''], + 'LastModifyTime' => ['description' => 'The timestamp when the alert rule was last modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1622827900000', 'title' => ''], + 'GroupId' => ['description' => 'The application group ID.'."\n" + .'>If the alert rule is associated with a specified application group, this application group ID is displayed.', 'type' => 'string', 'example' => '7671****', 'title' => ''], + 'Dimensions' => ['description' => 'The dimension map used to query monitoring data for a specified resource.', 'type' => 'string', 'example' => '{\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\",\\"userId\\":\\"120886317861****\\"}', 'title' => ''], + 'LastAlertTime' => ['description' => 'The timestamp when the alert was last triggered.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1622427900000', 'title' => ''], + 'Level' => ['description' => 'The alert level and notification method. Valid values:'."\n" + ."\n" + .'- 2: phone call + text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 3: text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 4: email + DingTalk chatbot.'."\n" + ."\n" + .'- OK: no alert.'."\n" + ."\n" + .'- 4: email + DingTalk chatbot.'."\n" + ."\n" + .'- OK: no alert.'."\n" + ."\n" + .'- 4: email + DingTalk chatbot.'."\n" + ."\n" + .'- OK: no alert.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for the alert.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- true: The alert rule is enabled.'."\n" + ."\n" + .'- false: The alert rule is disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Escalation' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The rule that triggered the alert.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The threshold comparison operator. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + ."\n" + .'- GreaterThanThreshold: greater than'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + ."\n" + .'- LessThanThreshold: less than'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to'."\n" + ."\n" + .'- GreaterThanYesterday: increased compared with the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: decreased compared with the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: increased compared with the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: decreased compared with the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: increased compared with the previous period'."\n" + ."\n" + .'- LessThanLastPeriod: decreased compared with the previous period', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'PreCondition' => ['description' => 'The threshold comparison symbol. Valid values:'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `!=`', 'type' => 'string', 'example' => '>=', 'title' => ''], + 'Expression' => ['description' => 'The description of the rule that triggered the alert.'."\n" + ."\n" + .'> This is the body of the alert rule. When monitoring data meets the alert condition, the alert rule is triggered.', 'type' => 'string', 'example' => '$Average>=10', 'title' => ''], + 'Times' => ['description' => 'The number of alert retries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Tag' => ['description' => 'This parameter is deprecated and can be ignored.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Level' => ['description' => 'The alert level and notification method. Valid values:'."\n" + ."\n" + .'- 2: phone call + text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 3: text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 4: email + DingTalk chatbot.'."\n" + ."\n" + .'- OK: no alert.'."\n" + ."\n" + .'- 4: email + DingTalk chatbot.'."\n" + ."\n" + .'- OK: no alert.'."\n" + ."\n" + .'- 4: email + DingTalk chatbot.'."\n" + ."\n" + .'- OK: no alert.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ExpressionListJoin' => ['description' => 'The relationship between multiple metrics. Valid values:'."\n" + ."\n" + .'- &&: An alert notification is sent only when all metrics meet the alert conditions.'."\n" + .'- ||: An alert notification is sent when any metric meets the alert conditions.', 'type' => 'string', 'example' => '&&', 'title' => ''], + 'ExpressionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExpressionList' => [ + 'description' => 'The description of the multi-metric alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The threshold comparison operator for the alert level. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: increased compared with the same time yesterday'."\n" + .'- LessThanYesterday: decreased compared with the same time yesterday'."\n" + .'- GreaterThanLastWeek: increased compared with the same time last week'."\n" + .'- LessThanLastWeek: decreased compared with the same time last week'."\n" + .'- GreaterThanLastPeriod: increased compared with the previous period'."\n" + .'- LessThanLastPeriod: decreased compared with the previous period', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the metric. Unit: seconds. The default value is the original reporting period of the metric.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for the alert level. Valid values:'."\n" + ."\n" + .'- Maximum: maximum value'."\n" + .'- Minimum: minimum value'."\n" + .'- Average: average value', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '90', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ExpressionRaw' => ['description' => 'The alert condition created by using an expression. The following scenarios are supported but not limited to:'."\n" + ."\n" + .'- Set an alert blacklist for specific resources. For example, `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50` specifies that no alert is triggered for instance `i-io8kfvcpp7x5****` even if its `Average` exceeds 50.'."\n" + .'- Set a special alert threshold for a specific instance in the rule. For example, `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)` specifies that an alert is triggered for instance `i-io8kfvcpp7x5****` only when its `Average` exceeds 80, while an alert is triggered for other instances when their `Average` exceeds 50.'."\n" + .'- Limit the number of instances that exceed the threshold. For example, `count($Average > 20) > 3` specifies that an alert is triggered only when more than three instances in the alert rule have an `Average` greater than 20.', 'type' => 'string', 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t\\t46350DCE-3399-473B-875F-1340DC97186C\\r\\n\\t\\tsuccess\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tFailed\\r\\n\\t\\t\\t\\tOperationFailed\\r\\n\\t\\t\\t\\t插入失败率10%\\r\\n\\t\\t\\t\\tInsertFailureRate\\r\\n\\t\\t\\t\\tException\\r\\n\\t\\t\\t\\tADS\\r\\n\\t\\t\\t\\tCRITICAL\\r\\n\\t\\t\\t\\tInsertFailureRate\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tFailed\\r\\n\\t\\t\\t\\tOptionFailed\\r\\n\\t\\t\\t\\t查询失败率10%\\r\\n\\t\\t\\t\\tSelectFailureRate\\r\\n\\t\\t\\t\\tException\\r\\n\\t\\t\\t\\tADS\\r\\n\\t\\t\\t\\tCRITICAL\\r\\n\\t\\t\\t\\tSelectFailureRate\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tFailed\\r\\n\\t\\t\\t\\tOperation Failed\\r\\n\\t\\t\\t\\t磁盘使用率80%\\r\\n\\t\\t\\t\\tStorageUsage\\r\\n\\t\\t\\t\\tMaintenance\\r\\n\\t\\t\\t\\tADS\\r\\n\\t\\t\\t\\tCRITICAL\\r\\n\\t\\t\\t\\tStorageUsage\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tEightyPercentQuotaExceeded\\r\\n\\t\\t\\t\\t超过Quota 80%事件\\r\\n\\t\\t\\t\\t超过Quota 80%事件\\r\\n\\t\\t\\t\\tEightyPercentQuotaExceeded:Route\\r\\n\\t\\t\\t\\t80%QuotaExceeded\\r\\n\\t\\t\\t\\tCEN\\r\\n\\t\\t\\t\\tWARN\\r\\n\\t\\t\\t\\tEightyPercentQuotaExceeded:Route\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tNinetyEightPercentQuotaExceeded\\r\\n\\t\\t\\t\\t超过Quota 98%事件\\r\\n\\t\\t\\t\\t超过Quota 98%事件\\r\\n\\t\\t\\t\\tNinetyEightPercentQuotaExceeded:Route\\r\\n\\t\\t\\t\\t98%QuotaExceeded\\r\\n\\t\\t\\t\\tCEN\\r\\n\\t\\t\\t\\tWARN\\r\\n\\t\\t\\t\\tNinetyEightPercentQuotaExceeded:Route\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeSystemEventMetaList', - 'requestParamsDescription' => ' ', + 'title' => 'Query resources with active alerts for a specified alert rule', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSystemEventAttribute' => [ - 'summary' => 'Queries the details of a system event.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-20T09:20:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-01T02:53:57.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertingMetricRuleResources'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertingMetricRuleResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeContactGroupList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10643,422 +9020,373 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Product', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the service name.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the abbreviations of service names.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '100', 'example' => '10', 'title' => ''], ], [ - 'name' => 'EventType', + 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the system event.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the types of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exception', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Status code. Note that 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '916EE694-03C2-47B6-85EE-5054E3C168D3', 'title' => ''], + 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'List of alarm contact groups.', + 'type' => 'array', + 'items' => ['description' => 'Alarm contact group.', 'type' => 'string', 'example' => '云账号报警联系人', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ContactGroupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'List of alarm contact groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'Alarm contact group.', + 'type' => 'object', + 'properties' => [ + 'Describe' => ['description' => 'Description information of the alarm contact group.', 'type' => 'string', 'example' => 'Devops-运维组', 'title' => ''], + 'UpdateTime' => ['description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-04T02:12:06Z', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-06-07T03:52:30Z', 'title' => ''], + 'EnabledWeeklyReport' => ['description' => 'Indicates whether the weekly report function is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'EnableSubscribed' => ['description' => 'Indicates whether the weekly report subscription function is enabled. Values:'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => 'List of contacts.', + 'type' => 'array', + 'items' => ['description' => 'Contact.', 'type' => 'string', 'example' => '135xxxx8066', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => ''], + ], + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the system event.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the names of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BucketIngressBandwidth', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Query Alarm Contact Group List', + 'summary' => 'Call the DescribeContactGroupList interface to query the list of alarm contact groups.', + 'changeSet' => [ + ['createdAt' => '2022-01-11T10:15:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactGroupList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the system event. Valid values:'."\n" - ."\n" - .'* CRITICAL: critical'."\n" - .'* WARN: warning'."\n" - .'* INFO: information'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeContactGroupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + '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"}]', + ], + 'DescribeContactList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Status', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the system event.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the statuses of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '100', 'example' => '10', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12346', - ], + 'schema' => ['description' => 'The current page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'SearchKeywords', + 'name' => 'ContactName', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the system event. Valid values:'."\n" - ."\n" - .'* If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" - .'* If you want to search for the system event whose content contains a or b, set the value to `a or b`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => false, 'example' => 'Alice', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ChanelType', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552199984949', - ], + 'schema' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- SMS: text message.'."\n" + ."\n" + .'- AliIM: TradeManager.'."\n" + ."\n" + .'- Mail: email.'."\n" + ."\n" + .'- DingWebHook: DingTalk chatbot.', 'type' => 'string', 'required' => false, 'example' => 'Mail', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ChanelValue', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552221584949', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Valid values: 1 to 100000000.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Valid values: 1 to 100.'."\n" - ."\n" - .'Default value: 10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The value of the alert notification method.'."\n" + ."\n" + .'> This parameter is required only when `ChanelType` is set to `Mail`.', 'type' => 'string', 'required' => false, 'example' => 'Alice@example.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message that is returned. If the call is successful, `success` is returned. If the call fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values: True: The call is successful. false: The call fails.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'SystemEvents' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Contacts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'SystemEvent' => [ - 'description' => 'The details of the event.'."\n", + 'Contact' => [ + 'description' => 'The alert notification methods.', 'type' => 'array', 'items' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the event.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Time' => [ - 'description' => 'The time when the event occurred. The value is a timestamp.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552199984000', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'Product' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'instanceId1', - ], - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'xxxxx-1', - ], - 'Name' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => 'Agent_Status_Stopped', + 'UpdateTime' => ['description' => 'The timestamp when the alert contact was last updated.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552356159000', 'title' => ''], + 'Name' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the alert contact was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552356159000', 'title' => ''], + 'Lang' => ['description' => 'The language type of the alert. Valid values:'."\n" + .'- zh-cn: simplified Chinese.'."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh-cn', 'title' => ''], + 'Desc' => ['description' => 'The description.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact groups.', 'type' => 'string', 'example' => '{ "ContactGroup": [ "ECS_Group", "Jim" ] }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Content' => [ - 'description' => 'The details of the event.'."\n", - '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"}]', + 'Channels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'object', + 'properties' => [ + 'Mail' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'Alice@example.com', 'title' => ''], + 'AliIM' => ['description' => 'The TradeManager name.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'DingWebHook' => ['description' => 'The webhook URL of the DingTalk chatbot.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', 'title' => ''], + 'SMS' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '1333333****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Level' => [ - 'description' => 'The level of the event. Valid values:'."\n" + 'ChannelsState' => [ + 'description' => 'The status of the alert channel.'."\n" ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'WARN', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Id' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'example' => 'b936efc9-f621-4e8a-a6eb-076be40e****', + .'Text messages, phone numbers, and email addresses must be activated before they can be used. When you add or modify an alert channel, the status is PENDING if the channel is not activated, and OK if the channel is activated.'."\n" + ."\n" + .'Email addresses must be activated before they can be used. When you add or modify an alert channel, the status is PENDING if the channel is not activated, and OK if the channel is activated.'."\n" + ."\n" + .'Email addresses must be activated before they can be used. When you add or modify an alert channel, the status is PENDING if the channel is not activated, and OK if the channel is activated..', + 'type' => 'object', + 'properties' => [ + 'Mail' => ['description' => 'The status of the email address. Valid values:'."\n" + .'- PENDING: The alert channel is not activated. Activate it before use.'."\n" + .'- OK: The alert channel is normal and alerts can be sent.', 'type' => 'string', 'example' => 'PENDING', 'title' => ''], + 'AliIM' => ['description' => 'The status of the TradeManager name is normal.'."\n" + ."\n" + .'Currently, only the value OK is supported. OK indicates that the TradeManager name is normal, the corresponding alert channel is normal, and alerts can be sent.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'DingWebHook' => ['description' => 'The status of the DingTalk chatbot is normal.'."\n" + ."\n" + .'Currently, only the value OK is supported. OK indicates that the DingTalk chatbot is normal, the corresponding alert channel is normal, and alerts can be sent.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'SMS' => ['description' => 'The status of text messages. Valid values:'."\n" + .'- PENDING: The alert channel is not activated. Activate it before use.'."\n" + .'- OK: The alert channel is normal and alerts can be sent.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tnormal\\r\\n\\t\\t\\t\\tinstanceId1\\r\\n\\t\\t\\t\\txxxxx-1\\r\\n\\t\\t\\t\\t[{\\\\\\"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\\\\\\"}]\\r\\n\\t\\t\\t\\tCloudMonitor\\r\\n\\t\\t\\t\\tWARN\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\tAgent_Status_Stopped\\r\\n\\t\\t\\t\\t12345\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\tsuccess\\r\\n\\t\\t60912C8D-B340-4253-ADE7-61ACDFD25CFC\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeSystemEventAttribute', + 'title' => 'Query alert contacts', + 'summary' => 'Calls the DescribeContactList operation to query a list of alert contacts.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSystemEventCount' => [ - 'summary' => 'Queries the number of times that a system event of a cloud service has occurred.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeContactList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"Alice@example.com\\",\\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}","type":"json"}]', + ], + 'DescribeContactListByContactGroup' => [ + 'summary' => 'Queries the alert contacts in an alert contact group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Product', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud service.'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `Product`. The value of the Product parameter indicates the names of all cloud services in which the system events of your Alibaba Cloud account occurred. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the system event.'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `EventType`. The value of the EventType parameter indicates the types of system events that occurred for all cloud services in your Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StatusNotification', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the system event.'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `Name`. The value of the Name parameter indicates the names of system events that occurred for all cloud services in your Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Instance:StateChange', - ], - ], - [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the system event. Valid values:'."\n" - ."\n" - .'* Critical'."\n" - .'* Warn'."\n" - .'* Info'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `Level`. The value of the Level parameter indicates the levels of system events that occurred for all cloud services in your Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Info', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the system event.'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `Status`. The value of the Status parameter indicates the status of system events that occurred for all cloud services in your Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '17285****', - ], - ], - [ - 'name' => 'SearchKeywords', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the system event. Valid values:'."\n" - ."\n" - .'* If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" - .'* If you want to search for the system event whose content contains a or b, set the value to `a or b`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1635993541000', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1635993921000', - ], + 'schema' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CloudMonitor', 'title' => ''], ], ], 'responses' => [ @@ -11066,189 +9394,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status codes.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'SystemEventCounts' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The group is not exists.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Contacts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'SystemEventCount' => [ - 'description' => 'The details of the system event.'."\n", + 'Contact' => [ + 'description' => 'The alert contacts that receive alert notifications.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the system event.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Time' => [ - 'description' => 'The time when the system event occurred. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1635993751000', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '17285****', - ], - 'Product' => [ - 'description' => 'The name of the cloud service in which the system event occurred.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'InstanceName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'ECS-test', - ], - 'Num' => [ - 'description' => 'The number of times that the system event has occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'i-rj99xc6cptkk64ml****', - ], - 'Name' => [ - 'description' => 'The name of the system event.'."\n", - 'type' => 'string', - 'example' => 'Instance:StateChange', - ], - 'Content' => [ - 'description' => 'The description of the system event.'."\n", - 'type' => 'string', + 'UpdateTime' => ['description' => 'The time when the alert contact was modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552323252000', 'title' => ''], + 'Name' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the alert contact was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552314252000', 'title' => ''], + 'Desc' => ['description' => 'The description of the alert contact.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'Channels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'object', + 'properties' => [ + 'Mail' => ['description' => 'The email address of the alert contact.', 'type' => 'string', 'example' => 'alice@example.com', 'title' => ''], + 'AliIM' => ['description' => 'The TradeManager ID of the alert contact.'."\n" + ."\n" + .'> This parameter can be returned only on the China site (aliyun.com).', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'DingWebHook' => ['description' => 'The webhook URL of the DingTalk chatbot.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', 'title' => ''], + 'SMS' => ['description' => 'The mobile number of the alert contact.'."\n" + ."\n" + .'> This parameter can be returned only on the China site (aliyun.com).', 'type' => 'string', 'example' => '1333333****', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'Level' => [ - 'description' => 'The level of the system event. Valid values:'."\n" - ."\n" - .'* Critical'."\n" - .'* Warn'."\n" - .'* Info'."\n", - 'type' => 'string', - 'example' => 'Info', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\tsuccess\\r\\n\\tC7A7B776-0ACE-5A93-9B07-DE8008D9CCDF\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t3\\r\\n\\t\\t\\tECS\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tInstance:StateChange\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeSystemEventCount', - 'description' => '### [](#)Background information'."\n" - ."\n" - .'You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the cloud services supported by CloudMonitor and their system events.'."\n" - ."\n" - .'### [](#)Description'."\n" - ."\n" - .'This topic provides an example on how to query the number of times that a system event of `Elastic Compute Service (ECS)` has occurred. The returned result shows that the specified system event has occurred three times.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeContactListByContactGroup', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorResourceQuotaAttribute' => [ - 'summary' => 'Queries the resource quotas of CloudMonitor.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactListByContactGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeContactListByContactGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"alice@example.com\\",\\n \\"AliIM\\": \\"Alice\\",\\n \\"DingWebHook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****\\",\\n \\"SMS\\": \\"1333333****\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeCustomEventAttribute' => [ + 'summary' => 'Queries a custom event.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ShowUsed', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return information about used quotas. Valid values:'."\n" - ."\n" - .'* true (default): yes'."\n" - .'* false: no'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The event name.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => ['description' => 'The event ID.', 'type' => 'string', 'required' => false, 'example' => '123****', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '123****', 'title' => ''], + ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => ['description' => 'The keywords that are used to search for the event.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a and b, set the value to a and b.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a or b, set the value to a or b.', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552224365971', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552227965971', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], ], 'responses' => [ @@ -11256,439 +9566,142 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => '31BC7201-00F2-47B2-B7B9-6A173076ACE', - ], - 'ResourceQuota' => [ - 'description' => 'The details about the resource quotas of CloudMonitor.'."\n", + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'userId:173651113438**** and name:"BABEL_CHECK"', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'CustomEvents' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'SuitInfo' => [ - 'description' => 'The current edition of CloudMonitor. Valid values:'."\n" - ."\n" - .'* free: Free Edition'."\n" - .'* pro: Pro Edition'."\n" - .'* cms_post: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'pro', - ], - 'InstanceId' => [ - 'description' => 'The ID of the resource plan.'."\n", - 'type' => 'string', - 'example' => 'cms_edition-cn-n6w20rn****', - ], - 'ExpireTime' => [ - 'description' => 'The time when the resource plan expires.'."\n", - 'type' => 'string', - 'example' => '2021-02-28', - ], - 'SiteMonitorEcsProbe' => [ - 'description' => 'The details about the quota of ECS detection points for site monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of ECS detection points for site monitoring.'."\n" - ."\n" - .'> The value indicates the maximum number of ECS detection points that you can select for a site monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of ECS detection points for site monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of ECS detection points for site monitoring in your resource plan.'."\n" + 'CustomEvent' => [ + 'description' => 'The event details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => 'The time when the event occurred.'."\n" ."\n" - .'> The value indicates the total number of ECS detection points that are used by existing site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'SiteMonitorOperatorProbe' => [ - 'description' => 'The details about the quota of carrier detection points for site monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of carrier detection points for site monitoring.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of carrier detection points for site monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of carrier detection points for site monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'SiteMonitorTask' => [ - 'description' => 'The quota of site monitoring tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of site monitoring tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of site monitoring tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - ], - ], - 'SiteMonitorBrowser' => [ - 'description' => 'The quota of browser detection tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of browser detection tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of browser detection tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of browser detection tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - ], - ], - 'SiteMonitorMobile' => [ - 'description' => 'The quota of mobile detection tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of mobile detection tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of mobile detection tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of mobile detection tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - ], - ], - 'CustomMonitor' => [ - 'description' => 'The details about the quota for custom monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of the time series for custom monitoring.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1200', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of the time series for custom monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of the time series for custom monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - ], - ], - 'EventMonitor' => [ - 'description' => 'The details about the quota for event monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of events that can be reported in event monitoring. The total quota is the value that is multiplied by 10,000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '55', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of events that can be reported in event monitoring in your resource plan. The total quota is the value that is multiplied by 10,000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of events that can be reported in event monitoring in your resource plan. The total quota is the value that is multiplied by 10,000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'LogMonitor' => [ - 'description' => 'The details about the quota for log monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of processed log data in log monitoring. Unit: MB/min.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '150', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of processed log data in log monitoring in your resource plan. Unit: MB/min.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '150', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of processed log data in log monitoring in your resource plan. Unit: MB/min.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - ], - ], - 'Api' => [ - 'description' => 'The details about the quota of API calls.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of API calls. Unit: 10,000 calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of API calls in your resource plan. Unit: 10,000 calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of API calls in your resource plan. Unit: calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9987', - ], - ], - ], - 'SMS' => [ - 'description' => 'The details about the quota of alert text messages.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of alert text messages. Unit: messages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '550', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of alert text messages in your resource plan. Unit: messages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of alert text messages in your resource plan. Unit: messages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '38', - ], - ], - ], - 'Phone' => [ - 'description' => 'The details about the quota of alert phone calls.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of alert phone calls. Unit: calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '550', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of alert phone calls in your resource plan. Unit: calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of alert phone calls in your resource plan. Unit: calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - 'EnterpriseQuota' => [ - 'description' => 'The details about the quota of Hybrid Cloud Monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'SuitInfo' => [ - 'description' => 'The description of Hybrid Cloud Monitoring.'."\n", - 'type' => 'string', - 'example' => 'ENTERPRISE', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance monitored by Hybrid Cloud Monitoring.'."\n", - 'type' => 'string', - 'example' => 'cms_enterprise_public_cn-7mz27pd****', + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'example' => '1552199984000', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'BABEL_CHECK', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Content' => ['description' => 'The content of the event.', '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****}', 'title' => ''], + 'Id' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '123', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t1E1961C4-B340-45D7-8CC3-F7D0BF19F2E0\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t5\\r\\n\\t\\t\\t5\\r\\n\\t\\t\\r\\n\\t\\tcms_edition-cn-n6w20rn****\\r\\n\\t\\t\\r\\n\\t\\t\\t100\\r\\n\\t\\t\\t500\\r\\n\\t\\t\\t550\\r\\n\\t\\t\\r\\n\\t\\tpro\\r\\n\\t\\t\\r\\n\\t\\t\\t7\\r\\n\\t\\t\\t20\\r\\n\\t\\t\\t20\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t38\\r\\n\\t\\t\\t500\\r\\n\\t\\t\\t550\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t50\\r\\n\\t\\t\\t50\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t9987\\r\\n\\t\\t\\t500\\r\\n\\t\\t\\t500\\r\\n\\t\\t\\r\\n\\t\\t2021-02-28\\r\\n\\t\\t\\r\\n\\t\\t\\t20\\r\\n\\t\\t\\t5\\r\\n\\t\\t\\t5\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t8\\r\\n\\t\\t\\t1000\\r\\n\\t\\t\\t1200\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t2\\r\\n\\t\\t\\t50\\r\\n\\t\\t\\t55\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeMonitorResourceQuotaAttribute', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeCustomEventAttribute', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SendDryRunSystemEvent' => [ - 'summary' => 'Debugs a system event of an Alibaba Cloud service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomEventAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeCustomEventCount' => [ + 'summary' => 'Queries the number of times that a custom event occurred within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Product', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud service.'."\n" - ."\n" - .'> For information about the Alibaba Cloud services that are supported by CloudMonitor, see [Supported cloud services and their system events](~~167388~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The event name.', 'type' => 'string', 'required' => false, 'example' => 'BABEL_BUY', 'title' => ''], ], [ - 'name' => 'EventName', + 'name' => 'EventId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the system event.'."\n" - ."\n" - .'> For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Agent_Status_Stopped', - ], + 'schema' => ['description' => 'The event ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'EventContent', + 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the system event.'."\n" - ."\n" - .'> The value of this parameter is a JSON object. We recommend that you include the `product`, `resourceId`, and `regionId` fields in the JSON object.'."\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"}', - ], + 'schema' => ['description' => 'The keywords that are used to search for the event.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a and b, set the value to a and b.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a or b, set the value to a or b.', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552209685596', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552220485596', 'title' => ''], ], ], 'responses' => [ @@ -11696,158 +9709,147 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CustomEventCounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomEventCount' => [ + 'description' => 'The details of the custom event.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => 'The time when the event occurred.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552267615000', 'title' => ''], + 'Num' => ['description' => 'The number of times that the custom event occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'BABEL_BUY', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\tsuccess\\r\\n\\t590FB642-5FFE-4AE0-883B-E1323DD20541\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'SendDryRunSystemEvent', - 'description' => 'This operation is used to test whether a system event can be triggered as expected. You can call this operation to simulate a system event and check whether an expected response is returned after the system event triggers an alert.'."\n", + 'title' => 'DescribeCustomEventCount', + 'description' => '> This operation queries the number of times that a custom event occurred for each service.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCustomEventCount' => [ - 'summary' => 'Queries the number of times that a custom event occurred within a period of time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventCount'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomEventCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeCustomEventHistogram' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BABEL_BUY', - ], + 'schema' => ['description' => 'The event name.', 'type' => 'string', 'required' => false, 'example' => 'BucketIngressBandwidth', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The severity level of the event. Valid values:'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- INFO', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], ], [ 'name' => 'EventId', 'in' => 'query', - 'schema' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The event ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the event.'."\n" - ."\n" - .'* If you need to query the custom event whose content contains a and b, set the value to a and b.'."\n" - .'* If you need to query the custom event whose content contains a or b, set the value to a or b.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'The keywords that are used to search for the event.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a and b, set the value to "a and b".'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a or b, set the value to "a or b".', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552209685596', - ], + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552209685596', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552220485596', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552220485596', 'title' => ''], ], ], 'responses' => [ @@ -11855,204 +9857,137 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CustomEventCounts' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'EventHistograms' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'CustomEventCount' => [ - 'description' => 'The details of the custom event.'."\n", + 'EventHistogram' => [ + 'description' => 'The information about the number of times that the custom event occurred during each interval of the specified time period.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Time' => [ - 'description' => 'The time when the event occurred.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552267615000', - ], - 'Num' => [ - 'description' => 'The number of times that the custom event occurred.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Name' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => 'BABEL_BUY', - ], + 'EndTime' => ['description' => 'The end time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552226750000', 'title' => ''], + 'StartTime' => ['description' => 'The start time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552226740000', 'title' => ''], + 'Count' => ['description' => 'The information about the number of times that the custom event occurred during an interval of the specified time period.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t\\t\\n\\t\\t\\t\\n\\t\\t\\t\\tBABEL_BUY\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t20\\n\\t\\t\\t\\n\\t\\t\\n\\t\\tsuccess\\n\\t\\t38D3C270-6799-4461-AA55-7975352140C1\\n\\t\\t200\\n\\t\\ttrue\\n","errorExample":""}]', - 'title' => 'DescribeCustomEventCount', - 'description' => '> This operation queries the number of times that a custom event occurred for each service.'."\n", + 'title' => 'DescribeCustomEventHistogram', + 'summary' => 'Queries the number of times that a custom event occurred during each interval within a period of time.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCustomEventHistogram' => [ - 'summary' => 'Queries the number of times that a custom event occurred during each interval within a period of time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventHistogram'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomEventHistogram', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeCustomMetricList' => [ + 'summary' => 'Queries the reported monitoring data.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BucketIngressBandwidth', - ], - ], - [ - 'name' => 'Level', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The severity level of the event. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => '7378****', 'title' => ''], ], [ - 'name' => 'EventId', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The name of the custom metric.', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The dimensions based on which the resources are queried.', 'type' => 'string', 'required' => false, 'example' => '{sampleName1=value1&sampleName2=value2}', 'title' => ''], ], [ - 'name' => 'SearchKeywords', + 'name' => 'Md5', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the event.'."\n" - ."\n" - .'* If you need to query the custom event whose content contains a and b, set the value to "a and b".'."\n" - .'* If you need to query the custom event whose content contains a or b, set the value to "a or b".'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.', 'type' => 'string', 'required' => false, 'example' => '97c25982d9745a231276bff27469****', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552209685596', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552220485596', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Pages start from page 1. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -12060,400 +9995,337 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'EventHistograms' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'EventHistogram' => [ - 'description' => 'The information about the number of times that the custom event occurred during each interval of the specified time period.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552226750000', - ], - 'StartTime' => [ - 'description' => 'The start time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552226740000', - ], - 'Count' => [ - 'description' => 'The information about the number of times that the custom event occurred during an interval of the specified time period.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AF425E4-1DEA-54F2-910A-8117C9686140', 'title' => ''], + 'Result' => ['description' => 'The reported custom metrics that are found in the query.', '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\\":[]}', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t\\tsuccess\\r\\n\\t\\t5977C7EE-E727-4EC4-B756-ECC8CB820CF4\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1596000690000\\r\\n\\t\\t\\t\\t1596000689000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1596000720000\\r\\n\\t\\t\\t\\t1596000690000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1596000930000\\r\\n\\t\\t\\t\\t1596000900000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1596000960000\\r\\n\\t\\t\\t\\t1596000930000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t1596000990000\\r\\n\\t\\t\\t\\t1596000960000\\r\\n\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n\\r\\n","errorExample":""}]', - 'title' => 'DescribeCustomEventHistogram', - 'requestParamsDescription' => ' ', + 'title' => 'DescribeCustomMetricList', + 'description' => '> You can call the DescribeMetricList operation to query the metrics of cloud services. For more information, see [DescribeMetricList](~~51936~~).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCustomEventAttribute' => [ - 'summary' => 'Queries the details of a custom event.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomMetricList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomMetricList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeDynamicTagRuleList' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'TagRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], + 'schema' => ['description' => 'The region ID of the tag.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EventId', + 'name' => 'TagKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123****', - ], + 'schema' => ['description' => 'The tag key.'."\n" + ."\n" + .'For more information about how to obtain a tag key, see [DescribeTagKeyList](~~145558~~).', 'type' => 'string', 'required' => false, 'example' => 'tagkey1', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'TagValue', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123****', - ], + 'schema' => ['description' => 'The tag value.'."\n" + ."\n" + .'For more information about how to obtain a tag value, see [DescribeTagValueList](~~145557~~).', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], ], [ - 'name' => 'SearchKeywords', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the event.'."\n" - ."\n" - .'* If you need to query the custom event whose content contains a and b, set the value to a and b.'."\n" - .'* If you need to query the custom event whose content contains a or b, set the value to a or b.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Start value: 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552224365971', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552227965971', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Start value: 1. Default value: 30.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DynamicTagRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => 'The ID of the dynamic tag rule.', 'type' => 'string', 'required' => false, 'example' => '004155fa-15ba-466d-b61a-***********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response that is returned.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'userId:173651113438**** and name:"BABEL_CHECK"', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'CustomEvents' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0D50523D-8D59-4A61-B58E-E2286ECFB3A9', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the operation was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries in the tag list.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TagGroupList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'CustomEvent' => [ - 'description' => 'The event details.'."\n", + 'TagGroup' => [ + 'description' => 'The list of rules for the application groups.', 'type' => 'array', 'items' => [ + 'description' => 'The rule for the application group.', 'type' => 'object', 'properties' => [ - 'Time' => [ - 'description' => 'The time when the event occurred.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'example' => '1552199984000', - ], - 'Name' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => 'BABEL_CHECK', + 'Status' => ['description' => 'The status of tag sync to the application group.'."\n" + ."\n" + .'- `RUNNING`: The synchronization is in progress.'."\n" + ."\n" + .'- `FINISH`: The synchronization is complete.', 'type' => 'string', 'example' => 'FINISH', 'title' => ''], + 'MatchExpressFilterRelation' => ['description' => 'The relationship between conditional expressions. Valid values:'."\n" + ."\n" + .'- `and`'."\n" + ."\n" + .'- `or`'."\n" + ."\n" + .'> Only one combination of conditions is supported.', 'type' => 'string', 'example' => 'or', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the resource.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tagkey1', 'title' => ''], + 'DynamicTagRuleId' => ['description' => 'The ID of the tag rule.', 'type' => 'string', 'example' => '1536df65-a719-429d-8813-73cc40d7****', 'title' => ''], + 'MatchExpress' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchExpress' => [ + 'description' => 'The matching expression used to create an application group from a tag.', + 'type' => 'array', + 'items' => [ + 'description' => 'The matching expression used to create an application group from a tag.', + 'type' => 'object', + 'properties' => [ + 'TagValue' => ['description' => 'The tag value.'."\n" + ."\n" + .'`TagValue` is used with `TagValueMatchFunction`.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'TagValueMatchFunction' => ['description' => 'The method used to match the tag value. Valid values:'."\n" + ."\n" + .'- all'."\n" + ."\n" + .'- startWith: prefix'."\n" + ."\n" + .'- endWith: suffix'."\n" + ."\n" + .'- contains'."\n" + ."\n" + .'- notContains'."\n" + ."\n" + .'- equals', 'type' => 'string', 'example' => 'all', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'azone-version', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '12345', + 'TemplateIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateIdList' => [ + 'description' => 'A list of alert template IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert template.', 'type' => 'string', 'example' => '71****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Content' => [ - 'description' => 'The content of the event.'."\n", - '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****}', + 'ContactGroupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroupList' => [ + 'description' => 'A list of alert contact groups.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'example' => '123', + 'TagValueBlacklist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagValueBlacklist' => [ + 'type' => 'array', + 'items' => ['description' => 'The value of a tag.', 'type' => 'string', 'example' => 'test、offline', 'title' => ''], + 'description' => 'The tag values that are not processed by the dynamic rule. When a user deletes a dynamic tag group, the tag values of the group are added to a blacklist. If a new resource is later added with a blacklisted tag value, a corresponding group is not created.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n userId:173651113438**** and name:\\"BABEL_CHECK\\"\\r\\n 194A3F1D-8EA6-4922-BBF2-5F213AC7B648\\r\\n \\r\\n \\r\\n BABEL_CHECK\\r\\n \\r\\n E4407D77-72BA-4818-8644-39D119D7****\\r\\n 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****}\\r\\n 12345\\r\\n \\r\\n \\r\\n BABEL_CHECK\\r\\n \\r\\n D44FAC44-EB81-470A-909D-BD963FF9****\\r\\n 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****}\\r\\n 12345\\r\\n \\r\\n \\r\\n BABEL_CHECK\\r\\n \\r\\n 3AF6FE15-4F6E-459A-96F6-45C74F765209\\r\\n 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****}\\r\\n 12345\\r\\n \\r\\n \\r\\n true\\r\\n 200\\r\\n","errorExample":""}]', - 'title' => 'DescribeCustomEventAttribute', - 'requestParamsDescription' => ' ', + 'title' => 'DescribeDynamicTagRuleList', + 'summary' => 'Call the DescribeDynamicTagRuleList operation to query the rules for dynamic tags.', + 'description' => 'This topic provides an example of how to query the rules for the tag key `tagkey1`. The response shows that two rules are returned. The rule IDs are `1536df65-a719-429d-8813-73cc40d7****` and `56e8cebb-b3d7-4a91-9880-78a8c84f****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutCustomEvent' => [ - 'summary' => 'Reports custom events.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2024-03-13T08:11:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-14T08:13:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-11-04T05:58:44.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDynamicTagRuleList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeDynamicTagRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeEventRuleAttribute' => [ + 'summary' => 'Queries the details of a specified event-triggered alert rule by calling the DescribeEventRuleAttribute operation.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EventInfo', + 'name' => 'RuleName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The event details.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EventName' => [ - 'description' => 'The event name. Valid values of N: 1 to 50.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myEvent', - ], - 'Time' => [ - 'description' => 'The time when the event occurred.'."\n" - ."\n" - .'Format: `yyyyMMddTHHmmss.SSSZ`.'."\n" - ."\n" - .'Valid values of N: 1 to 50.'."\n" - ."\n" - .'> You can also specify a UNIX timestamp. Example: 1552199984000. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20171013T170923.456+0800', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group. Valid values of N: 1 to 50.'."\n" - ."\n" - .'Default value: 0. This value indicates that the event to be reported does not belong to any application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], - 'Content' => [ - 'description' => 'The event content. Valid values of N: 1 to 50.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'IOException', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The name of the event-triggered alert rule.'."\n" + ."\n" + .'For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testRule', 'title' => ''], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute period.'."\n" + ."\n" + .'Unit: seconds. Default value: 86400 (1 day).'."\n" + ."\n" + .'> When monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute period.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], ], ], 'responses' => [ @@ -12461,764 +10333,907 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '131DD9C8-9A32-4428-AD2E-4E3013B6E3A7', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The alert does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9AA3F210-C03D-4C86-8DB6-21C84FF692A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Result' => [ + 'description' => 'The details of the event-triggered alert rule.', + 'type' => 'object', + 'properties' => [ + 'EventType' => ['description' => 'The event type. Valid values:'."\n" + ."\n" + .'- SYSTEM: system event.'."\n" + ."\n" + .'- CUSTOM: custom event.', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], + 'GroupId' => ['description' => 'The application group ID.', 'type' => 'string', 'example' => '3607****', 'title' => ''], + 'Name' => ['description' => 'The name of the event-triggered alert rule.', 'type' => 'string', 'example' => 'test_DefaultEventRule_7378****', 'title' => ''], + 'Description' => ['description' => 'The description of the event-triggered alert rule.', 'type' => 'string', 'example' => 'Default group event rule.', 'title' => ''], + 'State' => ['description' => 'The status of the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- ENABLED: enabled.'."\n" + ."\n" + .'- DISABLED: disabled.', 'type' => 'string', 'example' => 'ENABLED', 'title' => ''], + 'EventPattern' => [ + 'description' => 'The event pattern. Describes the trigger conditions of the event.', + 'type' => 'object', + 'properties' => [ + 'Product' => ['description' => 'The name of the cloud service.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'LevelList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LevelList' => [ + 'description' => 'The list of levels for the event-triggered alert rule.', + 'type' => 'array', + 'items' => ['description' => 'The level of the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical.'."\n" + ."\n" + .'- WARN: warning.'."\n" + ."\n" + .'- INFO: information.', 'type' => 'string', 'example' => '["CRITICAL","WARN"] ', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'StatusList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StatusList' => [ + 'description' => 'The list of statuses for the event-triggered alert rule.', + 'type' => 'array', + 'items' => ['description' => 'The event status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NameList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NameList' => [ + 'description' => 'The list of names for the event-triggered alert rule.', + 'type' => 'array', + 'items' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'Agent_Status_Running', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EventTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventTypeList' => [ + 'description' => 'The list of types for the event-triggered alert rule.', + 'type' => 'array', + 'items' => ['description' => 'The type of the event-triggered alert rule.'."\n" + ."\n" + .'`*` indicates that the alert rule type is not restricted.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SQLFilter' => ['description' => 'Filters logs by using SQL statements. An alert is triggered if the filter conditions are met.', 'type' => 'string', 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', 'title' => ''], + 'KeywordFilterObj' => [ + 'description' => 'The filter keyword.', + 'type' => 'object', + 'properties' => [ + 'Keywords' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'keyword' => [ + 'description' => 'The list of keywords that match the event.', + 'type' => 'array', + 'items' => ['description' => 'The keyword.', 'type' => 'string', 'example' => 'VMException', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Relation' => ['description' => 'The condition for multiple keywords. Valid values:'."\n" + ."\n" + .'- OR: The relationship between multiple keywords is OR.'."\n" + .'- NOT: Does not contain the keyword. Matches all events that are not in the keyword list.', 'type' => 'string', 'example' => 'OR', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"131DD9C8-9A32-4428-AD2E-4E3013B6E3A7\\"\\n}","errorExample":""},{"type":"xml","example":"success\\n131DD9C8-9A32-4428-AD2E-4E3013B6E3A7\\n200","errorExample":""}]', - 'title' => 'PutCustomEvent', - 'requestParamsDescription' => ' ', + 'title' => 'Query the details of a specified event-triggered alert rule', + 'description' => 'This topic provides an example on how to query the details of the event-triggered alert rule `testRule`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutCustomMetric' => [ - 'summary' => 'Reports monitoring data.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-08-31T02:52:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-10T07:57:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-03-21T07:08:24.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeEventRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeEventRuleList' => [ + 'summary' => 'Queries event-triggered alert rules.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'MetricList', + 'name' => 'NamePrefix', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitoring data. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* 0: raw data'."\n" - .'* 1: aggregate data'."\n" - ."\n" - .'> We recommend that you report aggregate data in both the aggregation periods of 60 seconds and 300 seconds. Otherwise, you cannot query monitoring data in a time span that is more than seven days.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0', - ], - 'MetricName' => [ - 'description' => 'The metric name. Valid values of N: 1 to 21. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - 'Time' => [ - 'description' => 'The timestamp when the metric data is generated. Valid values of N: 1 to 21. The timestamp can be in one of the following formats:'."\n" - ."\n" - .'* A UTC timestamp in the YYYY-MM-DDThh:mm:ssZ format. Example: 20171012T132456.888+0800.'."\n" - .'* A UNIX timestamp of the LONG type. Example: 1508136760000.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1508136760000', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> If the metric does not belong to any application group, enter 0.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - 'Values' => [ - 'description' => 'The collection of metric values. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> If the Type parameter is set to 0, the keys in this parameter must be set to the specified value. CloudMonitor aggregates raw data in each aggregation period to generate multiple statistical values, such as the maximum value, the count, and the total value.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"value":10.5}', - ], - 'Dimensions' => [ - 'description' => 'The dimensions based on which the resources are queried. Valid values of N: 1 to 21.'."\n" - ."\n" - .'Set this parameter to a collection of key-value pairs. Format: `{"Key":"Value"}`.'."\n" - ."\n" - .'The key or value must be 1 to 64 bytes in length. Excessive characters are truncated.'."\n" - ."\n" - .'The key or value can contain letters, digits, periods (.), hyphens (-), underscores (\\_), forward slashes (/), and backslashes (\\\\).'."\n" - ."\n" - .'> Dimensions must be formatted as a JSON string in a specified order.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"sampleName1":"value1","sampleName2":"value2"}', - ], - 'Period' => [ - 'description' => 'The aggregation period. Valid values of N: 1 to 21. Unit: seconds. Valid values: 60 and 300.'."\n" - ."\n" - .'> If the Type parameter is set to 1, the Period parameter is required.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The prefix in the name of the event-triggered alert rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Pages start from page 1. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7378****', 'title' => ''], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- true (default)'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The event-triggered alert rules.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 request has failed due to a temporary failure of the server.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0E6D82B-16B5-422A-8136-EE5BDC01E415', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EventRules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventRule' => [ + 'description' => 'The event-triggered alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EventType' => ['description' => 'The type of the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- SYSTEM: system event-triggered alert rule'."\n" + ."\n" + .'- CUSTOM: custom event-triggered alert rule', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], + 'Description' => ['description' => 'The description of the event-triggered alert rule.', 'type' => 'string', 'example' => 'Default group event rule.', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '7378****', 'title' => ''], + 'Name' => ['description' => 'The name of the event-triggered alert rule.', 'type' => 'string', 'example' => 'test_DefaultEventRule_7378****', 'title' => ''], + 'State' => ['description' => 'The status of the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- ENABLED'."\n" + ."\n" + .'- DISABLED', 'type' => 'string', 'example' => 'ENABLED', 'title' => ''], + 'EventPattern' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventPattern' => [ + 'description' => 'The mode of the event-triggered alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Product' => ['description' => 'The abbreviation of the Alibaba Cloud service name.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'LevelList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LevelList' => [ + 'description' => 'The levels of the event-triggered alerts.', + 'type' => 'array', + 'items' => ['description' => 'The level of the event-triggered alert. Valid values:'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- INFO', 'type' => 'string', 'example' => 'CRITICAL', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EventTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventTypeList' => [ + 'description' => 'The types of the event-triggered alert rules.', + 'type' => 'array', + 'items' => ['description' => 'The type of the event-triggered alert rule.'."\n" + ."\n" + .'`*` indicates all types of alert rules.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NameList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NameList' => [ + 'description' => 'The event names.', + 'type' => 'array', + 'items' => ['description' => 'The event name.', 'type' => 'string', 'example' => '["Agent_Status_Stopped"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'CustomFilters' => ['description' => 'The custom filter conditions.', 'type' => 'string', 'example' => 'ECS123', 'title' => ''], + 'KeywordFilter' => [ + 'description' => 'The keyword for filtering.', + 'type' => 'object', + 'properties' => [ + 'Keywords' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Keywords' => [ + 'description' => 'The keywords that are used to match events.', + 'type' => 'array', + 'items' => ['description' => 'The keyword.', 'type' => 'string', 'example' => 'VMException', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Relation' => ['description' => 'The relationship between multiple keywords in a condition. Valid values:'."\n" + ."\n" + .'- OR: The relationship between keywords is OR.'."\n" + ."\n" + .'- NOT: The keyword is excluded. The value NOT indicates that all events that do not contain the keywords are matched.', 'type' => 'string', 'example' => 'OR', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SQLFilter' => ['description' => 'Indicates that logs are filtered based on the specified SQL statement. If the specified conditions are met, an alert is triggered.', 'type' => 'string', 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SilenceTime' => ['description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met.', 'type' => 'integer', 'format' => 'int64', 'example' => '86400', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t75D115CE-5DA8-4647-9073-8F72BB85B6F7\\n\\tsuccess\\n\\t200\\n","errorExample":""}]', - 'title' => 'PutCustomMetric', - 'description' => '> We recommend that you call the [PutHybridMonitorMetricData](~~383455~~) operation of Hybrid Cloud Monitoring to report monitoring data.'."\n", + 'title' => 'DescribeEventRuleList', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutCustomMetricRule' => [ - 'summary' => 'Creates a custom alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-09-19T07:37:30.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-03T08:46:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-03T08:46:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-03T08:46:17.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeEventRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeEventRuleTargetList' => [ + 'summary' => 'Queries the list of event-triggered alert rules.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group to which the custom monitoring data belongs.'."\n" - ."\n" - .'> The value 0 indicates that the reported custom monitoring data does not belong to an application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7378****', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'> You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyRuleId1', - ], - ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CpuUsage', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'> For more information about how to obtain the metric name, see [DescribeCustomMetricList](~~115005~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'Resources', - 'in' => 'query', - 'schema' => [ - 'description' => 'The custom monitoring data to which the alert rule applies. The value includes the application group ID to which the custom monitoring data belongs and the dimension to which the metric belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{"groupId":7378****,"dimension":"instanceId=i-hp3543t5e4sudb3s****"}]', - ], - ], - [ - 'name' => 'ContactGroups', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact groups. Separate multiple alert contact groups with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Group', - ], - ], - [ - 'name' => 'Webhook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - ], - [ - 'name' => 'EffectiveInterval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The period of time during which the alert rule is effective. Valid values: 00:00 to 23:59.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], - ], - [ - 'name' => 'SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400, which is equivalent to one day.'."\n" - ."\n" - .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - 'default' => '86400', - ], + 'schema' => ['description' => 'The name of the event-triggered alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testRule', 'title' => ''], ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cycle that is used to aggregate custom monitoring data. Unit: seconds Set the value to an integral multiple of 60. The original reporting cycle of custom monitoring data is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'default' => '300', - ], - ], - [ - 'name' => 'EmailSubject', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '90', - ], - ], - [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CRITICAL', - ], - ], - [ - 'name' => 'EvaluationCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'Statistics', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method used to calculate the metric value based on which alerts are triggered.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Average', - ], - ], - [ - 'name' => 'ComparisonOperator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* `>=`'."\n" - .'* `=`'."\n" - .'* `<=`'."\n" - .'* `>`'."\n" - .'* `<`'."\n" - .'* `!=`'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '>=', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', 'title' => ''], + 'ContactParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactParameter' => [ + 'description' => 'The notification method of the alert contact group.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'example' => 'Default alert notification group', 'title' => ''], + 'Level' => ['description' => 'The notification level. Valid values:'."\n" + ."\n" + .'- 2: phone call, text message, DingTalk, and email.'."\n" + ."\n" + .'- 3: text message, DingTalk, and email.'."\n" + ."\n" + .'- 4: DingTalk and email.'."\n" + ."\n" + .'4: DingTalk and email.'."\n" + ."\n" + .'4: DingTalk and email..', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the alert contact group notification method.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FcParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FCParameter' => [ + 'description' => 'The Function Compute notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceName' => ['description' => 'The service name of Function Compute.', 'type' => 'string', 'example' => 'service1', 'title' => ''], + 'FunctionName' => ['description' => 'The function name.', 'type' => 'string', 'example' => 'fcTest1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + ."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + ."\n" + .'- Service: the code of the Alibaba Cloud service.'."\n" + ."\n" + .'- Region: the region ID.'."\n" + ."\n" + .'- Account: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- ResourceType: the resource type.'."\n" + ."\n" + .'- ResourceId: the resource ID.', 'type' => 'string', 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the Function Compute notification method.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Region' => ['description' => 'The region of the Function Compute service.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'MnsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MnsParameter' => [ + 'description' => 'The Simple Message Queue (formerly MNS) notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Queue' => ['description' => 'The name of the Simple Message Queue (formerly MNS) queue.', 'type' => 'string', 'example' => 'testQueue', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + ."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + ."\n" + .'- Service: the code of the Alibaba Cloud service.'."\n" + ."\n" + .'- Region: the region ID.'."\n" + ."\n" + .'- Account: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- ResourceType: the resource type.'."\n" + ."\n" + .'- ResourceId: the resource ID.', 'type' => 'string', 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', 'title' => ''], + 'Region' => ['description' => 'The region of the Simple Message Queue (formerly MNS) service.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the Simple Message Queue (formerly MNS) notification method.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Topic' => ['description' => 'The topic of the Simple Message Queue (formerly MNS) service.', 'type' => 'string', 'example' => 'topic_sample', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, the return value is null. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'ComparisonOperator is mandatory for this action.', + 'WebhookParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WebhookParameter' => [ + 'description' => 'The URL callback notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The callback URL.', 'type' => 'string', 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Method' => ['description' => 'The HTTP request method for the callback. GET and POST methods are supported.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'Protocol' => ['description' => 'The protocol type.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the URL callback notification method.', 'type' => 'string', 'example' => '5', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9432', + 'SlsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SlsParameter' => [ + 'description' => 'The Simple Log Service (SLS) notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'project_test', 'title' => ''], + 'LogStore' => ['description' => 'The Logstore name.', 'type' => 'string', 'example' => 'logstore_test', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + ."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + ."\n" + .'- Service: the code of the Alibaba Cloud service.'."\n" + ."\n" + .'- Region: the region ID.'."\n" + ."\n" + .'- Account: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- ResourceType: the resource type.'."\n" + ."\n" + .'- ResourceId: the resource ID.', 'type' => 'string', 'example' => 'acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***', 'title' => ''], + 'Region' => ['description' => 'The region of the project.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the Simple Log Service notification method.', 'type' => 'string', 'example' => '4', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'OpenApiParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OpenApiParameters' => [ + 'description' => 'The parameters of the callback API.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'PutLogs', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + .' - Service: the Alibaba Cloud service.'."\n" + .' - Region: the region ID.'."\n" + .' - Account: the Alibaba Cloud account ID.'."\n" + .' - ResourceType: the resource type.'."\n" + .' - ResourceId: the resource ID.', 'type' => 'string', 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the API callback notification method.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Product' => ['description' => 'The ID of the Alibaba Cloud service to which the API belongs.', 'type' => 'string', 'example' => 'log', 'title' => ''], + 'Region' => ['description' => 'The region of the resource.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Role' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'MyRole', 'title' => ''], + 'Version' => ['description' => 'The API version.', 'type' => 'string', 'example' => '2019-01-01', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ], + 'title' => 'Query the notification channels of a specified event-triggered alert rule', + 'description' => 'This topic provides an example to query the details of the event-triggered alert rule `testRule`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-22T08:42:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-22T08:42:04.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleTargetList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeEventRuleTargetList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n\\t\\n\\t200\\n\\ttrue\\n","errorExample":""}]', - 'title' => 'PutCustomMetricRule', - 'description' => 'Before you call this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see [PutCustomMetric](~~115004~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","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\\": \\"Default alert notification group\\",\\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}","type":"json"}]', ], - 'DescribeCustomMetricList' => [ - 'summary' => 'Queries the reported monitoring data.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeExporterOutputList' => [ + 'summary' => 'Queries the list of monitoring data exports by calling the DescribeExporterOutputList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7378****', - ], - ], - [ - 'name' => 'MetricName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Dimension', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions based on which the resources are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{sampleName1=value1&sampleName2=value2}', - ], + 'schema' => ['description' => 'The number of records per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1000', 'example' => '10', 'title' => ''], ], - [ - 'name' => 'Md5', - 'in' => 'query', - 'schema' => [ - 'description' => 'The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '97c25982d9745a231276bff27469****', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Pages start from page 1. Default value: 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AF425E4-1DEA-54F2-910A-8117C9686140', - ], - 'Result' => [ - 'description' => 'The reported custom metrics that are found in the query.'."\n", - '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\\":[]}', + 'RequestId' => ['description' => 'The request ID.'."\n" + ."\n", 'type' => 'string', 'example' => '0E657631-CD6C-4C24-9637-98D000B9272C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: '."\n" + .'- `true`: successful'."\n" + .'- `false`: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call was successful. Other status codes indicate that the call failed.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'sucess', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'description' => 'The list of exported configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DestType' => ['description' => 'The type of the data export.'."\n" + ."\n" + .'> Only Log Service (SLS) is supported. More products will be supported in the future.', 'type' => 'string', 'example' => 'SLS', 'title' => ''], + 'CreateTime' => ['description' => 'The Unix timestamp when the export configuration was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1584016495498', 'title' => ''], + 'DestName' => ['description' => 'The name of the configuration.', 'type' => 'string', 'example' => 'exporterOut', 'title' => ''], + 'ConfigJson' => [ + 'description' => 'The monitoring output configuration.', + 'type' => 'object', + 'properties' => [ + 'ak' => ['description' => 'The AccessKey ID.', 'type' => 'string', 'example' => 'LTAIpY33********', 'title' => ''], + 'endpoint' => ['description' => 'The endpoint of the SLS data.', 'type' => 'string', 'example' => 'http://cn-qingdao-share.log.aliyuncs.com', 'title' => ''], + 'logstore' => ['description' => 'The Logstore.', 'type' => 'string', 'example' => 'monitorlogstore', 'title' => ''], + 'project' => ['description' => 'The SLS project.', 'type' => 'string', 'example' => 'exporter', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\tsuccess\\r\\n\\t1AF425E4-1DEA-54F2-910A-8117C9686140\\r\\n\\t200\\r\\n\\t{\\\\\\"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\\\\\\":[]}\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeCustomMetricList', - 'description' => '> You can call the DescribeMetricList operation to query the metrics of cloud services. For more information, see [DescribeMetricList](~~51936~~).'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeExporterOutputList', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteCustomMetric' => [ - 'summary' => 'Deletes the reported monitoring data of a metric.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:14:42.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExporterOutputList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3607****', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeExporterOutputList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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 \\"logstore\\": \\"monitorlogstore\\",\\n \\"project\\": \\"exporter\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeExporterRuleList' => [ + 'summary' => 'Queries a list of data export rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AdvanceCredit', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Md5', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.'."\n" - ."\n" - .'> `Md5` is returned when you query the reported monitoring data of a metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '38796C8CFFEB8F89BB2A626C7BD7****', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'UUID', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request for reporting monitoring data.'."\n" - ."\n" - .'> `UUID` is returned when you query the reported monitoring data of a metric. We recommend that you specify the `Md5` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5497633c-66c5-4eae-abaa-89db5adb****', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1000', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -13226,566 +11241,444 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6BA047CA-8BC6-40BC-BC8F-FBECF35F1993', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: '."\n" + .'- `true`: Successful.'."\n" + .'- `false`: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success. Any other value indicates failure.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'description' => 'The data point.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data point.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'CPUUtilization', 'title' => ''], + 'Describe' => ['description' => 'The description of the export rules.', 'type' => 'string', 'example' => 'export test', 'title' => ''], + 'TargetWindows' => ['description' => 'The time window for data export. Unit: seconds.'."\n" + ."\n" + .'> - If you need to export data from multiple windows, separate them with commas (,).'."\n" + .'- Exporting data with a granularity of less than 60 seconds is not supported.', 'type' => 'string', 'example' => 'rule_test', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the rule was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1667526533000', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Dimension' => ['description' => 'The dimension.', 'type' => 'string', 'example' => 'hotsName', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'RuleName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'L121-寿险-全能保建议书系统_DefaultEventRule_10842827', 'title' => ''], + 'DstName' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DstName' => [ + 'description' => 'The destination name.', + 'type' => 'array', + 'items' => ['description' => 'The destination name.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\t\\tsuccess\\n\\t\\t05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'DeleteCustomMetric', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PutLogMonitor' => [ - 'summary' => 'Creates or modifies a log monitoring metric.', - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BA047CA-8BC6-40BC-BC8F-FBECF35F1993\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1000,\\n \\"Datapoints\\": {\\n \\"Datapoint\\": [\\n {\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"Describe\\": \\"export test\\",\\n \\"TargetWindows\\": \\"rule_test\\",\\n \\"CreateTime\\": 1667526533000,\\n \\"Enabled\\": true,\\n \\"Dimension\\": \\"hotsName\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"RuleName\\": \\"L121-寿险-全能保建议书系统_DefaultEventRule_10842827\\",\\n \\"DstName\\": {\\n \\"DstName\\": [\\n \\"[]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query data export rules', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:14:42.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExporterRuleList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'LogId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the log monitoring metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '16****', - ], - ], - [ - 'name' => 'SlsRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region in which the Simple Log Service project resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SlsProject', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Simple Log Service project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], - ], - [ - 'name' => 'SlsLogstore', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Simple Log Service Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - ], + 'ramActions' => [ [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. For more information about the metrics for cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeExporterRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeGroupMonitoringAgentProcess' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MetricExpress', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended field. The extended field allows you to perform basic operations on the aggregation results.'."\n" - ."\n" - .'For example, you have calculated TotalNumber and 5XXNumber by aggregating the data. TotalNumber indicates the total number of HTTP requests, and 5XXNumber indicates the number of HTTP requests whose status code is greater than 499. You can calculate the server error rate by adding the following formula to the extended field: 5XXNumber/TotalNumber\\*100.'."\n" - ."\n" - .'JSON format: {"extend":{"errorPercent":"5XXNumber/TotalNumber\\*100"}}. Description:'."\n" - ."\n" - .'* extend: required.'."\n" - .'* errorPercent: the alias of the field generated in the calculation result. You can specify the alias as needed.'."\n" - .'* 5XXNumber/TotalNumber\\*100: the calculation expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'ValueFilterRelation', + 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'description' => 'The logical operator that is used between log filter conditions. Valid values:'."\n" - ."\n" - .'* and'."\n" - .'* or'."\n" - ."\n" - .'> The ValueFilterRelation and `ValueFilter.N.Key` parameters must be used in pair.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'and', - ], + 'schema' => ['description' => 'The process name.', 'type' => 'string', 'required' => false, 'example' => 'sshd', 'title' => ''], ], [ - 'name' => 'Tumblingwindows', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the tumbling window for calculation. Unit: seconds. CloudMonitor performs aggregation for each tumbling window.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60,300', - ], + 'schema' => ['description' => 'The page number. Default value: 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Unit', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Percent', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '10', 'title' => ''], ], - [ - 'name' => 'Aggregates', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The aggregation logic.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'The name of the field to be aggregated. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sourceCount', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate log data within a statistical period. Valid values of N: 1 to 10. Valid values:'."\n" - ."\n" - .'* count: counts the number.'."\n" - .'* sum: calculates the total value.'."\n" - .'* avg: calculates the average value.'."\n" - .'* max: calculates the maximum value.'."\n" - .'* min: calculates the minimum value.'."\n" - .'* countps: calculates the number of values of the specified field divided by the total number of seconds within a statistical period.'."\n" - .'* sumps: calculates the sum of the values of the specified field divided by the total number of seconds within a statistical period.'."\n" - .'* distinct: calculates the number of unique values of the specified field within a statistical period.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregate function. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Count', - ], - ], - 'required' => false, - 'description' => 'The aggregation logic.', - ], - 'required' => true, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'Groupbys', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The dimension based on which the data is grouped. This parameter is equivalent to the GROUP BY clause in SQL statements. If no dimension is specified, all data is aggregated based on the aggregate function.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'The name of the field that is specified as the dimension. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu', - ], - 'Alias' => [ - 'description' => 'The alias of the dimension based on which the data is grouped. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CPUUtilization', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'ValueFilter', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements. If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the log field that is used for matching in the filter condition. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'lh_source', - ], - 'Value' => [ - 'description' => 'The field value to be matched in the filter condition. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Operator' => [ - 'description' => 'The method that is used to match the field value. Valid values of N: 1 to 10. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'contain', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 20, - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'description' => 'The response parameters.', '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 returned message.'."\n" - ."\n" - .'* If the request was successful, `successful` is returned.'."\n" - .'* If the request failed, an error message is returned. Example: `alias of aggreate must be set value.`'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '91561287-0802-5F9C-9BDE-404C50D41B06', - ], - 'LogId' => [ - 'description' => 'The ID of the log monitoring metric.'."\n", - 'type' => 'string', - 'example' => '16****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status codes.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 1', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of returned entries.', 'type' => 'string', 'example' => '28', 'title' => ''], + 'Processes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Process' => [ + 'description' => 'The process monitoring tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The process monitoring task.', + 'type' => 'object', + 'properties' => [ + 'ProcessName' => ['description' => 'The process name.', 'type' => 'string', 'example' => 'sshd', 'title' => ''], + 'MatchExpressFilterRelation' => ['description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" + ."\n" + .'- all'."\n" + ."\n" + .'- and'."\n" + ."\n" + .'- or', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Id' => ['description' => 'The ID of the process monitoring task.', 'type' => 'string', 'example' => '3F6150F9-45C7-43F9-9578-A58B2E72****', 'title' => ''], + 'MatchExpress' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchExpress' => [ + 'description' => 'The matching conditions.'."\n" + ."\n" + .'> Only the instances that meet the conditional expressions are monitored by the process monitoring task.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The keyword used to match the instance name.', 'type' => 'string', 'example' => 'portalHost', 'title' => ''], + 'Name' => ['description' => 'The criteria based on which the instances are matched.'."\n" + ."\n" + .'> Set the value to `name`. The value name indicates that the instances are matched based on the instance name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'The matching condition. Valid values:'."\n" + ."\n" + .'- all (default): matches all'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- notContains: excludes'."\n" + ."\n" + .'- equals: equals'."\n" + ."\n" + .'> The matched instances are monitored by the process monitoring task.', 'type' => 'string', 'example' => 'all', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AlertConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertConfig' => [ + 'description' => 'The alert rule configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert rule configuration.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday.'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'SilenceTime' => ['description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" + ."\n" + .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.', 'type' => 'string', 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Times' => ['description' => 'The number of times for which the threshold can be consecutively exceeded.'."\n" + ."\n" + .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'EscalationsLevel' => ['description' => 'The level of the alert. Valid values:'."\n" + ."\n" + .'- critical'."\n" + ."\n" + .'- warn'."\n" + ."\n" + .'- Info', 'type' => 'string', 'example' => 'warn', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time period during which the alert rule is ineffective.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The time period during which the alert rule is effective.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Statistics' => ['description' => 'The method used to calculate metric values that trigger alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'TargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => 'The resources for which alerts are triggered.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource for which alerts are triggered.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the resource for which alerts are triggered.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message. Example: acs:mns:cn-hangzhou:120886317861\\*\\*\\*\\*:/queues/test123/message. Fields:'."\n" + ."\n" + .'- {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" + ."\n" + .'- {userId}: the ID of the Alibaba Cloud account.'."\n" + ."\n" + .'- {regionId}: the region ID of the SMQ queue or topic.'."\n" + ."\n" + .'- {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" + ."\n" + .' - **queues**'."\n" + ."\n" + .' - **topics**'."\n" + ."\n" + .'- {Resource name}: the resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + ."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- CRITICAL', 'type' => 'string', 'example' => 'CRITICAL', 'title' => ''], + 'JsonParmas' => ['description' => 'The parameters of the alert callback. The parameters are in the JSON format.', 'type' => 'string', 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'LimitorError', - 'errorMessage' => 'Log monitor limit is not enough', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\tsuccessful\\r\\n\\t91561287-0802-5F9C-9BDE-404C50D41B06\\r\\n\\t200\\r\\n\\t16****\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'PutLogMonitor', - 'description' => 'In the example of this topic, the `cpu_total` log monitoring metric is created. The response shows that the log monitoring metric is created and the metric ID is `16****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeGroupMonitoringAgentProcess', + 'summary' => 'Queries the process monitoring tasks for an application group.', + 'description' => 'You can create a process monitoring task to monitor all or the specified Elastic Compute Service (ECS) instances in an application group and configure alert rules for the process monitoring task.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteLogMonitor' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeGroupMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeHostAvailabilityList' => [ + 'summary' => 'Queries the list of availability monitoring tasks.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'LogId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the log monitoring metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'metric not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], - ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + 'schema' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 'name' => 'Ids', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of multiple availability monitoring tasks. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '123456,345678', 'title' => ''], ], - ], - '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":"\\n\\t\\tEBB5215C-44AB-4000-A2D7-48634FDC4F04\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'DeleteLogMonitor', - 'summary' => 'Deletes a log monitoring metric.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeLogMonitorList' => [ - 'summary' => 'Queries log monitoring metrics.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the availability monitoring task.', 'type' => 'string', 'required' => false, 'example' => 'ecs_instance', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Minimum value: 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'SearchValue', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to search for log monitoring metrics. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '123456', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -13793,1567 +11686,1472 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '01E90080-4300-4FAA-B9AE-161956BC350D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'LogMonitorList' => [ - 'description' => 'The log monitoring metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ValueFilterRelation' => [ - 'description' => 'The logical operator that is used between log filter conditions. The ValueFilter and ValueFilterRelation parameters are used in pair. Valid values:'."\n" - ."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'SlsLogstore' => [ - 'description' => 'The name of the Simple Log Service (SLS) Logstore.'."\n", - 'type' => 'string', - 'example' => 'testSlS****', - ], - 'MetricName' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'LogId' => [ - 'description' => 'The ID of the log monitoring metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'SlsRegionId' => [ - 'description' => 'The ID of the region where the SLS Logstore resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => 'The time when the log monitoring metric was created.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1577766395000', - ], - 'SlsProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'example' => 'sls-project-test****', - ], - 'ValueFilter' => [ - 'description' => 'The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements. If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the log field used for matching in the filter condition.'."\n", - 'type' => 'string', - 'example' => 'hostName', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4A288E86-45C3-4858-9DB0-6D85B10BD92A', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TaskList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeTaskConfig' => [ + 'description' => 'The list of availability monitoring tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of availability monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'TaskType' => ['description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'- PING'."\n" + .'- TELNET'."\n" + .'- HTTP', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'Group_ECS', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'TaskName' => ['description' => 'The name of the availability monitoring task.', 'type' => 'string', 'example' => 'ecs_instance', 'title' => ''], + 'Disabled' => ['description' => 'Indicates whether the availability monitoring task is disabled. Valid values:'."\n" + ."\n" + .'- true: The task is disabled.'."\n" + ."\n" + .'- false: The task is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TaskScope' => ['description' => 'The scope of the availability monitoring task. Valid values:'."\n" + ."\n" + .'- GROUP: All ECS instances in the current application group are used as detection points.'."\n" + .'- GROUP_SPEC_INSTANCE: Specified ECS instances in the current application group are used as detection points.', 'type' => 'string', 'example' => 'GROUP', 'title' => ''], + 'Id' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => 'The list of ECS instances that initiate detection.', + 'type' => 'array', + 'items' => ['description' => 'The list of ECS instances that initiate detection.', 'type' => 'string', 'example' => 'i-abcdefgh12****', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'Value' => [ - 'description' => 'The field value to be matched in the filter condition.'."\n", - 'type' => 'string', - 'example' => 'portal', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TaskOption' => [ + 'description' => 'The parameter options of the availability monitoring task.', + 'type' => 'object', + 'properties' => [ + 'HttpMethod' => ['description' => 'The HTTP method of the detection type. Valid values:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'Interval' => ['description' => 'The detection frequency. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'HttpURI' => ['description' => 'The URI for HTTP detection.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'TelnetOrPingHost' => ['description' => 'The domain name or address to detect.', 'type' => 'string', 'example' => 'ssh.aliyun.com', 'title' => ''], + 'HttpResponseCharset' => ['description' => 'The response character set for HTTP detection.', 'type' => 'string', 'example' => 'UTF-8', 'title' => ''], + 'HttpPostContent' => ['description' => 'The POST content of the HTTP detection request.', 'type' => 'string', 'example' => 'params1=paramsValue1', 'title' => ''], + 'HttpNegative' => ['description' => 'The alert rule for matching HTTP response content. Valid values:'."\n" + .'- true: An alert is triggered if the HTTP response content contains the specified alert rule.'."\n" + .'- false: An alert is triggered if the HTTP response content does not contain the specified alert rule.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpKeyword' => ['description' => 'The keyword to match in the HTTP detection response content.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], - 'Operator' => [ - 'description' => 'The method that is used to match the field value. Valid values:'."\n" + 'title' => '', + 'example' => '', + ], + 'AlertConfig' => [ + 'description' => 'The alert rule configuration.', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute period. Unit: seconds. Default value: 86400.', 'type' => 'integer', 'format' => 'int32', 'example' => '86400', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the alert effective period. Valid values: 0 to 23.'."\n" ."\n" - .'* contain: contains'."\n" - .'* notContain: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'example' => 'contain', + .'For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert effective period is 00:00:00 to 22:00:00.'."\n" + ."\n" + .'>If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the alert effective period. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert effective period is 00:00:00 to 22:00:00.'."\n" + ."\n" + .'>If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WebHook' => ['description' => 'The callback URL when an alert is triggered.'."\n" + ."\n" + .'CloudMonitor pushes alert information to this URL by using POST requests. Only the HTTP protocol is supported.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'NotifyType' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- 2: Phone call + text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 1: Text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 0: Email + DingTalk chatbot.'."\n" + ."\n" + .'- 2: Email + DingTalk chatbot.'."\n" + ."\n" + .'- 1: Email + DingTalk chatbot.'."\n" + ."\n" + .'- 0: Email + DingTalk chatbot.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'EscalationList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'escalationList' => [ + 'description' => 'The conditions that trigger the alert.', + 'type' => 'array', + 'items' => [ + 'description' => 'The conditions that trigger the alert.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'MetricName' => ['description' => 'The metric for the alert. Valid values:'."\n" + ."\n" + .'- HttpStatus: HTTP status code.'."\n" + .'- HttpLatency: HTTP response time.'."\n" + .'- TelnetStatus: TELNET status code.'."\n" + .'- TelnetLatency: TELNET response time.'."\n" + .'- PingLostRate: PING packet loss rate.', 'type' => 'string', 'example' => 'HttpStatus', 'title' => ''], + 'Operator' => ['description' => 'The comparison operator for the alert rule. Valid values:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', 'type' => 'string', 'example' => '=', 'title' => ''], + 'Times' => ['description' => 'The number of consecutive periods during which the threshold is exceeded before an alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Aggregate' => ['description' => 'The statistical method for the alert. The valid values vary based on the metric:'."\n" + ."\n" + .'- Value: The value of the HTTP status code.'."\n" + .'- Average: The average HTTP response time.'."\n" + .'- Value: The value of the TELNET status code.'."\n" + .'- TelnetLatency: The average TELNET response time.'."\n" + .'- Average: The average PING packet loss rate.', 'type' => 'string', 'example' => 'Value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => 'The list of alert targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of alert targets.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert target.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + ."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + ."\n" + .'- Service: The code of the Alibaba Cloud service.'."\n" + ."\n" + .'- Region: The region ID.'."\n" + ."\n" + .'- Account: The Alibaba Cloud account ID.'."\n" + ."\n" + .'- ResourceType: The resource type.'."\n" + ."\n" + .'- ResourceId: The resource ID.', 'type' => 'string', 'example' => 'acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: Information.'."\n" + .'- WARN: Warning.'."\n" + .'- CRITICAL: Critical.', 'type' => 'string', 'example' => 'INFO', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'example' => '{"key1":"value1"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'description' => '', ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'description' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t\\tsuccessful\\r\\n\\t\\tC085617E-7A64-402E-877D-410E86174B0C\\r\\n\\t\\t10\\r\\n\\t\\t2\\r\\n\\t\\t\\r\\n\\t\\t\\tsls-project-test****\\r\\n\\t\\t\\tcpu_total\\r\\n\\t\\t\\t1591175112000\\r\\n\\t\\t\\tand\\r\\n\\t\\t\\t12345\\r\\n\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\ttestSlS****\\r\\n\\t\\t\\t12345\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tsls-project-test****\\r\\n\\t\\t\\tcpu_total\\r\\n\\t\\t\\t1586826787000\\r\\n\\t\\t\\tand\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t=\\r\\n\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\tlh_source\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t12345\\r\\n\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\tinternal-alert-history\\r\\n\\t\\t\\t12345\\r\\n\\t\\t\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n\\r\\n","errorExample":""}]', - 'title' => 'DescribeLogMonitorList', - 'requestParamsDescription' => ' ', + 'title' => 'Query availability monitoring tasks', + 'description' => 'This topic provides an example on how to query the list of availability monitoring tasks for the current account. The response shows that the current account has one availability monitoring task record `ecs_instance`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeLogMonitorAttribute' => [ - 'summary' => 'Queries the details of a log monitoring metric.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHostAvailabilityList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeHostAvailabilityList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeHybridMonitorDataList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'MetricName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. Exact match is supported.'."\n" - ."\n" - .'For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'For more information about how to query the names of namespaces, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'default-aliyun', 'title' => ''], + ], + [ + 'name' => 'PromSQL', + 'in' => 'query', + 'schema' => ['description' => 'The metric name.'."\n" + ."\n" + .'> PromQL statements are supported.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'AliyunEcs_cpu_total', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => false, 'example' => '1653804865', 'title' => ''], + ], + [ + 'name' => 'End', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => false, 'example' => '1653805225', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C6718537-E673-4A58-8EE1-24B8B38C7AAE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'LogMonitor' => [ - 'description' => 'The details of the log monitoring metric.'."\n", - 'type' => 'object', - 'properties' => [ - 'ValueFilterRelation' => [ - 'description' => 'The logical operator that is used between log filter conditions. The ValueFilter and ValueFilterRelation parameters must be used in pair. Valid values:'."\n" - ."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'SlsLogstore' => [ - 'description' => 'The name of the Simple Log Service Logstore.'."\n", - 'type' => 'string', - 'example' => 'test-logstore', - ], - 'MetricName' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'LogId' => [ - 'description' => 'The ID of the log.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'MetricExpress' => [ - 'description' => 'The extended field. The extended field allows you to perform basic operations on the aggregation results.'."\n" - ."\n" - .'For example, if you have calculated TotalNumber and 5XXNumber by aggregating the data. TotalNumber indicates the total number of HTTP requests, and 5XXNumber indicates the number of HTTP requests whose status code is greater than 499. You can calculate the server error rate by adding the following formula to the extended field: 5XXNumber/TotalNumber\\*100.'."\n", - 'type' => 'string', - 'example' => '{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}', - ], - 'SlsRegionId' => [ - 'description' => 'The ID of the region where the Simple Log Service (SLS) Logstore resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => 'The time when the metric was created.'."\n" - ."\n" - .'This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1547431398000', - ], - 'SlsProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'example' => 'test-project', - ], - 'Aggregates' => [ - 'description' => 'The aggregation logic.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Max' => [ - 'description' => 'The maximum value.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Min' => [ - 'description' => 'The minimum value.'."\n", - 'type' => 'string', - 'example' => '0', + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'end timestamp must not be before start time.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C240412F-3F5F-50E2-ACEC-DE808EF9C4BE', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'TimeSeries' => [ + 'description' => 'The returned monitoring data.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'AliyunEcs_cpu_total', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags of the time dimension.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'K' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'instanceId', 'title' => ''], + 'V' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'i-rj99xc6cptkk64ml****', 'title' => ''], ], - 'Function' => [ - 'description' => 'The function that is used to aggregate the monitoring data of logs within a statistical period. Valid values:'."\n" + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Values' => [ + 'description' => 'The metric values that are collected at different timestamps.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'V' => ['description' => 'The metric value.', 'type' => 'string', 'example' => '0.13', 'title' => ''], + 'Ts' => ['description' => 'The timestamp that indicates the time when the metric value is collected.'."\n" ."\n" - .'* count: counts the number'."\n" - .'* sum: calculates the total value'."\n" - .'* avg: calculates the average value'."\n" - .'* max: calculates the maximum value'."\n" - .'* min: calculates the minimum value'."\n" - .'* countps: calculates the number of values of the specified field divided by the total number of seconds within a statistical period'."\n" - .'* sumps: calculates the sum of the values of the specified field divided by the total number of seconds within a statistical period'."\n" - .'* distinct: calculates the number of unique values of the specified field within a statistical period'."\n", - 'type' => 'string', - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the field.'."\n", - 'type' => 'string', - 'example' => 'HostName', - ], - 'FieldName' => [ - 'description' => 'The name of the field in logs.'."\n", - 'type' => 'string', - 'example' => 'hostName', + .'Unit: seconds.', 'type' => 'string', 'example' => '1653804865', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'ValueFilter' => [ - 'description' => 'The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements.'."\n" - ."\n" - .'If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the log field used for matching in the filter condition.'."\n", - 'type' => 'string', - 'example' => 'hostName', - ], - 'Value' => [ - 'description' => 'The field value to be matched in the filter condition.'."\n", - 'type' => 'string', - 'example' => 'portal', - ], - 'Operator' => [ - 'description' => 'The method that is used to match the field value. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'example' => 'contain', - ], - ], - 'description' => '', - ], - ], - 'Tumblingwindows' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The size of the tumbling window for calculation. Unit: seconds The system performs an aggregation for each tumbling window.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'description' => '', - ], - 'Groupbys' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The dimension based on which the data is grouped. This parameter is equivalent to the GROUP BY clause in SQL statements. If no dimension is specified, all data is aggregated based on the aggregate function.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - 'description' => '', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'BadRequest', 'errorMessage' => 'Bad request.', 'description' => 'Error Parameter Request'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DescribeHybridMonitorDataList', + 'summary' => 'Queries the monitoring data in a namespace.', + 'description' => '## [](#)Prerequisites'."\n" + ."\n" + .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" + ."\n" + .'## [](#)Limits'."\n" + ."\n" + .'The size of monitoring data that is returned in each call cannot exceed 1.5 MB. If the returned data reaches the upper limit, the query fails. You must reset the query conditions.'."\n" + ."\n" + .'## [](#)Operation description'."\n" + ."\n" + .'This topic provides an example to show how to query the monitoring data of the `AliyunEcs_cpu_total` metric in the `default-aliyun` namespace from `1653804865` (14:14:25 on May 29, 2022) to `1653805225` (14:20:25 on May 29, 2022).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-05-30T06:45:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorDataList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomMetricDataPoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'DescribeLogMonitorAttribute', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'CreateMonitorGroupByResourceGroupId' => [ - 'summary' => 'Creates an application group by using a resource group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHybridMonitorNamespaceList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'EnableSubscribeEvent', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values:'."\n" - ."\n" - .'* true: The application group automatically subscribes to event notifications.'."\n" - .'* false (default): The application group does not automatically subscribe to event notifications.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EnableInstallAgent', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the CloudMonitor agent is automatically installed for the application group. CloudMonitor determines whether to automatically install the CloudMonitor agent for the hosts in an application group based on the value of this parameter. Valid values:'."\n" - ."\n" - .'* true: The CloudMonitor agent is automatically installed.'."\n" - .'* false (default): The CloudMonitor agent is not automatically installed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Minimum value: 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region where the resource group resides.'."\n" - ."\n" - .'For information about how to obtain the ID of the region where a resource group resides, see [GetResourceGroup](~~158866~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n" - ."\n" - .'For information about how to obtain the ID of a resource group, see [ListResourceGroups](~~158855~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acfmw3ty5y7****', - ], + 'schema' => ['description' => 'The keyword for the search.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'For information about how to obtain the name of a resource group, see [ListResourceGroups](~~158855~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CloudMonitor', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'The name can contain uppercase letters, lowercase letters, digits, and hyphens (-).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aliyun-test', 'title' => ''], ], [ - 'name' => 'ContactGroupList', + 'name' => 'ShowTaskStatistic', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The alert contact groups. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" - ."\n" - .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact group. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" - ."\n" - .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], - 'required' => true, - 'example' => 'ECS_Group', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'Specifies whether to display the configuration details of data import tasks for Alibaba Cloud services and the number of data import tasks for non-Alibaba Cloud services. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'No description is available.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => '784CAB3C-F613-5BCE-8469-6DCB29B18A20', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3607****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1EC450A4-3221-5148-B77E-2827576CFE48', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter PageSize is not valid.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DescribeHybridMonitorNamespace' => [ + 'description' => 'The details of the namespaces.', + 'type' => 'array', + 'items' => [ + 'description' => 'No description is available.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the namespace.', 'type' => 'string', 'example' => 'aliyun-test', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the namespace was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1652682744000', 'title' => ''], + 'Namespace' => ['description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'aliyun-test', 'title' => ''], + 'IsDelete' => ['description' => 'Indicates whether the namespace is deleted. Valid values:'."\n" + ."\n" + .'- 0: The namespace is not deleted.'."\n" + ."\n" + .'- 1: The namespace is deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The namespace ID.', 'type' => 'string', 'example' => '3****', 'title' => ''], + 'ModifyTime' => ['description' => 'The timestamp when the namespace was last modified. Unit: milliseconds.', 'type' => 'string', 'example' => '1652682744000', 'title' => ''], + 'Detail' => [ + 'description' => 'The details of the data storage duration.', + 'type' => 'object', + 'properties' => [ + 'Spec' => ['description' => 'The data storage duration. Valid values:'."\n" + ."\n" + .'- cms.s1.large: 15 days.'."\n" + ."\n" + .'- cms.s1.xlarge: 32 days.'."\n" + ."\n" + .'- cms.s1.2xlarge: 63 days.'."\n" + ."\n" + .'- cms.s1.3xlarge: 93 days.'."\n" + ."\n" + .'- cms.s1.6xlarge: 185 days.'."\n" + ."\n" + .'- cms.s1.12xlarge: 376 days.', 'type' => 'string', 'example' => 'cms.s1.3xlarge', 'title' => ''], + 'NamespaceRegion' => ['description' => 'The region where the monitoring data is stored.'."\n" + ."\n" + .'> This parameter is returned if you set `NamespaceType` to `m_prom_user` when you create the namespace.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The Simple Log Service (SLS) project where the monitoring data is stored.'."\n" + ."\n" + .'> This parameter is returned if you set `NamespaceType` to `m_prom_user` when you create the namespace.', 'type' => 'string', 'example' => 'cms-hybrid-120886317861****-cn-hangzhou-a83d', 'title' => ''], + 'PrometheusInstanceId' => ['description' => 'The Prometheus instance where the monitoring data is stored.'."\n" + ."\n" + .'> This parameter is returned if you set `NamespaceType` to `aliyun_prometheus` when you create the namespace.', 'type' => 'string', 'example' => 'rw-57******************7f', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'NotAliyunTaskNumber' => ['description' => 'The number of data import tasks for non-Alibaba Cloud services.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AliyunProductMetricList' => [ + 'description' => 'The configuration details of data import tasks for Alibaba Cloud services.', + 'type' => 'array', + 'items' => [ + 'description' => 'No description is available.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => 'The account that is used to create the namespace.', 'type' => 'integer', 'format' => 'int64', 'example' => '120886317861****', 'title' => ''], + 'NamespaceList' => [ + 'description' => 'The list of namespaces.', + 'type' => 'array', + 'items' => [ + 'description' => 'No description is available.', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The data namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'MetricList' => [ + 'description' => 'The list of metrics for the Alibaba Cloud service.', + 'type' => 'array', + 'items' => [ + 'description' => 'No description is available.', + 'type' => 'object', + 'properties' => [ + 'Period' => ['description' => 'The collection period of the metric.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'List' => [ + 'description' => 'The list of metrics.', + 'type' => 'array', + 'items' => ['description' => 'The metric.', 'type' => 'string', 'example' => '["cpu_total"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'YAMLConfig' => ['description' => 'The configuration file for the Alibaba Cloud service that is connected to Hybrid Cloud Monitoring.'."\n" + ."\n" + .'- namespace: the namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'- metric\\_list: the metrics of the Alibaba Cloud service.'."\n" + ."\n" + .'- dimension: the resources of the Alibaba Cloud service that can be queried in Hybrid Cloud Monitoring. If this parameter is empty, all resources are monitored.', 'type' => 'string', 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: \'\'', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NamespaceType' => ['description' => 'The storage solution for monitoring data. Valid values:'."\n" + ."\n" + .'- m\\_prom\\_user: The monitoring data is stored in SLS.'."\n" + ."\n" + .'- m\\_prom\\_pool: The monitoring data is stored in the storage space provided by Cloud Monitor.'."\n" + ."\n" + .'- aliyun\\_prometheus: The monitoring data is stored in a Prometheus instance.', 'type' => 'string', 'example' => 'aliyun_prometheus', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 4092 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'ResourceGroupId already create group', + ], + 'title' => 'DescribeHybridMonitorNamespaceList', + 'summary' => 'Queries a list of namespaces and the details of their data sources.', + 'description' => 'This example shows how to query all namespaces that belong to the current account. The response indicates that only one namespace, `aliyun-test`, exists.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2025-05-27T06:45:50.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-21T10:00:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-25T07:24:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorNamespaceList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n 784CAB3C-F613-5BCE-8469-6DCB29B18A20\\n 3607****\\n 200\\n true\\n","errorExample":""}]', - 'title' => 'CreateMonitorGroupByResourceGroupId', - 'description' => 'This topic provides an example on how to create an application group by using the resource group `CloudMonitor` and the alert contact group `ECS_Group`. The region ID of the resource group is `cn-hangzhou`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'CreateSiteMonitor' => [ - 'summary' => 'Creates a site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHybridMonitorSLSGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Address', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URL or IP address that is monitored by the task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://www.aliyun.com', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol that is used by the site monitoring task.'."\n" - ."\n" - .'Valid values: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, FTP, and WEBSOCKET.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HTTPS', - ], - ], - [ - 'name' => 'TaskName', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the site monitoring task.'."\n" - ."\n" - .'The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HanZhou_ECS1', - ], + 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'Logstore', 'title' => ''], ], [ - 'name' => 'Interval', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which detection requests are sent.'."\n" - ."\n" - .'Valid values: 1, 5, 15, 30, and 60. Unit: minutes.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Minimum value: 1. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'IspCities', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The information of the detection points. If you leave this parameter empty, the system randomly selects three detection points.'."\n" - ."\n" - .'The value is a JSON array. Example: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. The values of the city field indicate Beijing, Hangzhou, and Qingdao.'."\n" - ."\n" - .'For information about how to obtain detection points, see [DescribeSiteMonitorISPCityList](~~115045~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'OptionsJson', + 'name' => 'SLSGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"time_out":5000}', - ], + 'schema' => ['description' => 'The name of the Logstore group.', 'type' => 'string', 'required' => false, 'example' => 'Logstore_test', 'title' => ''], ], - [ - 'name' => 'AlertIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', - ], - ], - [ - 'name' => 'AgentGroup', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'CustomSchedule', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The custom detection period. You can only select a time period from Monday to Sunday for detection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', - ], - ], - [ - 'name' => 'VpcConfig', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'description' => 'None.', '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 returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The result of the site monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'AttachAlertResult' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Contact' => [ - 'description' => 'The result that is returned after you associate the existing alert rule with the site monitoring task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result that is returned after you associate the existing alert rule with the site monitoring task.', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code that is returned after you associate the existing alert rule with the site monitoring task.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message that is returned after you associate the existing alert rule with the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request that was sent to associate the existing alert rule with the site monitoring task.'."\n", - 'type' => 'string', - 'example' => '5dd33455-4f65-4b0c-9200-33d66f3f340b', - ], - 'Success' => [ - 'description' => 'Indicates whether the existing alert rule was associated with the site monitoring task. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'NotFound.SLSGroup', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'List' => [ + 'description' => 'The list of Logstore groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSGroupName' => ['description' => 'The name of the Logstore group.', 'type' => 'string', 'format' => 'int64', 'example' => 'Logstore_test', 'title' => ''], + 'SLSGroupDescription' => ['description' => 'The description of the Logstore group.', 'type' => 'string', 'example' => 'Logstore group of Alibaba Cloud products.', 'title' => ''], + 'SLSGroupConfig' => [ + 'description' => 'The configuration information of the Logstore group.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The Simple Log Service project.', 'type' => 'string', 'example' => 'aliyun-project', 'title' => ''], + 'SLSLogstore' => ['description' => 'The Logstore.', 'type' => 'string', 'example' => 'Logstore-aliyun-all', 'title' => ''], + 'SLSUserId' => ['description' => 'The member ID.'."\n" + ."\n" + .'> This parameter is returned only when you call this operation by using a management account.', 'type' => 'string', 'example' => '120886317861****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'CreateResultList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CreateResultList' => [ - 'description' => 'The returned result.'."\n" + 'CreateTime' => ['description' => 'The timestamp when the Logstore group was created.'."\n" ."\n" - .'If a site monitoring task is created, the result is returned. If a site monitoring task fails to be created, no result is returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', - ], - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'HanZhou_ECS1', - ], - ], - ], + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1652845630000', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp when the Logstore group was last modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1652845630000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], - 'description' => 'N/A.', + 'title' => '', + 'example' => '', ], ], ], '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' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'Query logstore group list', + 'summary' => 'Queries the list of Logstore groups by calling the DescribeHybridMonitorSLSGroup operation.', + 'description' => 'This topic provides an example of how to query all Logstore groups in the current account. The response shows that the current account has two Logstore groups: `Logstore_test` and `Logstore_aliyun`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-06-20T02:41:49.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorSLSGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeHybridMonitorSLSGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\tsuccessful\\r\\n\\t68192f5d-0d45-4b98-9724-892813f86c71\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tsuccessful\\r\\n\\t\\t\\t\\t5dd33455-4f65-4b0c-9200-33d66f3f340b\\r\\n\\t\\t\\t\\tSystemDefault_acs_ecs_dashboard_InternetOutRate_Percent\\r\\n\\t\\t\\t\\t200\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t2c8dbdf9-a3ab-46a1-85a4-f094965e****\\r\\n\\t\\t\\tHanZhou_ECS1\\r\\n\\t\\t\\r\\n\\t\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'CreateSiteMonitor', - 'description' => 'This topic provides an example on how to create a site monitoring task named `HanZhou_ECS1`. The URL that is monitored by the task is `https://www.aliyun.com` and the type of the task is `HTTPS`.'."\n", - 'requestParamsDescription' => 'The following tables describe the extended options of the HTTP, HTTPS, PING, TCP, UDP, DNS, WEBSOCKET, SMTP, POP3, and FTP protocols specified by the TaskType parameter.'."\n" - ."\n" - .'* HTTP or HTTPS'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|http\\_method|String|The HTTP or HTTPS request method. Valid values: GET, POST, and HEAD. Default value: GET.|'."\n" - .'|header|String|The custom HTTP headers that are separated by line feeds (\\\\n).Each header must comply with the HTTP protocol. Each header must be a key-value pair in which the key and value are separated by a colon (:).|'."\n" - .'|cookie|String|The HTTP cookie that is specified in compliance with the HTTP request standard.|'."\n" - .'|request\\_content|String|The content of the request. The content can be in the JSON or form format. If this parameter is not specified, the request body is empty.|'."\n" - .'|response\\_content|String|The expected content of the response. The first 64 bytes of the content returned by the HTTP server are checked during site monitoring.|'."\n" - .'|match\\_rule|String|0: The detection is successful if the response does not contain the content specified by the response\\_content parameter.1: The detection is successful if the response contains the content specified by the response\\_content parameter.|'."\n" - .'|username|String|If the username parameter is specified, the HTTP request contains the basic authentication header.|'."\n" - .'|password|String|The password that is used to authenticate the HTTP or HTTPS request.|'."\n" - .'|time\\_out|int|The timeout period. Unit: milliseconds. Default value: 5.|'."\n" - .'|max\\_redirect|int|The maximum number of redirections. The default value is 5 for a detection point that is running on an Elastic Compute Service (ECS) instance and 2 for a detection point that is provided by a carrier.To disable redirections, set the value to 0.Valid values: 0 to 50.|'."\n" - ."\n" - .'* PING'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|failure\\_rate|Text|If the rate of the failed pings exceeds the value of this parameter, the detection fails and the status code 610 or 615 is returned. The error message of the status code 610 is PingAllFail and the error message of the status code 615 is PingPartialFail.Default value: 0.1.|'."\n" - .'|ping\\_num|int|The number of times that the monitored address is pinged. Default value: 10.Valid values: 1 to 100.|'."\n" - ."\n" - .'* DNS'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|dns\\_server|string|The domain name or IP address of the Domain Name System (DNS) server.|'."\n" - .'|dns\\_type|string|The type of the DNS records to query. Valid values: A, NS, CNAME, MX, TXT, ANY, and AAAA.|'."\n" - .'|expect\\_value|string|The list of expected values. Separate the expected values with space characters.|'."\n" - .'|match\\_rule|string|The relationship between the list of expected values and the list of DNS results. If the two lists do not meet the specified relationship, the detection fails. Valid values:Empty string or IN\\_DNS: The list of expected values is a subset of the list of DNS results.DNS\\_IN: The list of DNS results is a subset of the list of expected values.EQUAL: The list of DNS results is the same as the list of expected values.ANY: The list of DNS results intersects with the list of expected values.|'."\n" - ."\n" - .'* FTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the FTP server. If this parameter is not specified, the default value is used. The default port number is 21 for FTP and 990 for FTPS.|'."\n" - .'|username|string|The username that is used to log on to the FTP server. If this parameter is not specified, anonymous logon is used.|'."\n" - .'|password|string|The password that is used to log on to the FTP server.|'."\n" - ."\n" - .'* POP3 or SMTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the POP3 or SMTP server. The default port number is 110 for POP3, 995 for POP3S, and 25 for SMTP.|'."\n" - .'|username|string|The username that is used to log on to the POP3 or SMTP server. The username and password that are used to log on to the POP3 or SMTP server are required.|'."\n" - .'|password|string|The password that is used to log on to the POP3 or SMTP server. The username and password that are used to log on to the POP3 or SMTP server are required.|'."\n" - ."\n" - .'* TCP or UDP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the TCP or UDP server.|'."\n" - .'|request\\_content|string|The content of the request. If the request\\_format parameter is set to hex, the value of the request\\_content parameter is parsed in the hexadecimal format.|'."\n" - .'|request\\_format|string|If the request\\_format parameter is set to another value, the value of the request\\_content parameter is sent to the TCP or UDP server as a regular string.|'."\n" - .'|response\\_content|string|The content of the response. If the response from the TCP or UDP server does not contain the content specified by the response\\_content parameter, the detection fails.If the response\\_format parameter is set to hex, the value of the response\\_content parameter is parsed in the hexadecimal format.If the response\\_format parameter is set to another value, the value of the response\\_content parameter is parsed as a regular string.|'."\n" - ."\n" - .'* WEBSOCKET'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|request\\_content|string|The message content.|'."\n" - .'|empty\\_message|boolean|Allows the server to return no message or an empty string.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => "\n" - ."\n\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NotFound.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\",\\n \\"List\\": [\\n {\\n \\"SLSGroupName\\": \\"Logstore_test\\",\\n \\"SLSGroupDescription\\": \\"Logstore group of Alibaba Cloud products.\\",\\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}","type":"json"}]', ], - 'CreateInstantSiteMonitor' => [ - 'summary' => 'Creates an instant test task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHybridMonitorTaskList' => [ + 'summary' => 'Queries metric import tasks.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Address', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL or IP address that you want to test.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'http://www.aliyun.com', - ], + 'schema' => ['description' => 'The keyword that is used for the search.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'task', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the instant test task. Valid values: HTTP, PING, TCP, UDP, and DNS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The ID of the metric import task.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '36****', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the instant test task.'."\n" - ."\n" - .'The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task1', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'IspCities', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The detection points. If you leave this parameter empty, the system randomly selects three detection points.'."\n" - ."\n" - .'The value is a `JSON array`. Example: {"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}. The values of the city field indicate Beijing, Hangzhou, and Qingdao.'."\n" - ."\n" - .'For information about how to obtain detection points, see [DescribeSiteMonitorISPCityList](~~115045~~).'."\n" - ."\n" - .'> You must specify one of the `IspCities` and `RandomIspCity` parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'OptionsJson', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended options of the protocol that is used by the instant test task. The options vary based on the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"time_out":5000}', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Pages start from page 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'RandomIspCity', + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IncludeAliyunTask', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the returned result includes metric import tasks for Alibaba Cloud services. Valid values:'."\n" + ."\n" + .'- true (default): The returned result includes metric import tasks for Alibaba Cloud services.'."\n" + ."\n" + .'- false: The returned result excludes metric import tasks for Alibaba Cloud services.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'TaskType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of detection points.'."\n" + 'description' => 'The type of the metric import task. Valid values:'."\n" ."\n" - .'> '."\n" + .'- aliyun\\_fc: metric import tasks for Alibaba Cloud services'."\n" ."\n" - .'* You must specify one of the `IspCities` and `RandomIspCity` parameters. If you specify the `RandomIspCity` parameter, the `IspCities` parameter automatically becomes invalid.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'- aliyun\\_sls: metrics for logs imported from Log Service', + 'enumValueTitles' => ['aliyun_sls' => 'aliyun\\_sls'], + 'type' => 'string', 'required' => false, - 'example' => '1', - 'default' => '0', + 'example' => 'aliyun_fc', + 'title' => '', ], ], [ - 'name' => 'AgentGroup', + 'name' => 'TargetUserId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'PC', - 'MOBILE', - ], - ], + 'schema' => ['description' => 'The ID of the member account.'."\n" + ."\n" + .'> This parameter is required only if you use a management account to call this operation to delete the metric import tasks that belong to a member in a resource directory. In this case, the `TaskType` parameter is set to `aliyun_fc`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '120886317861****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.', - 'type' => 'string', - 'example' => 'true', - ], - 'CreateResultList' => [ - 'description' => 'The results for creating the instant test task.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'- If the request was successful, the value `successful` is returned.'."\n" + ."\n" + .'- If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TaskList' => [ + 'description' => 'The metric import tasks.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the instant test task.', + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the instant test task.'."\n", - 'type' => 'string', - 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', - ], - 'TaskName' => [ - 'description' => 'The name of the instant test task.'."\n", - 'type' => 'string', - 'example' => 'task1', + 'YARMConfig' => ['description' => 'The configuration file of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring.'."\n" + ."\n" + .'- namespace: the namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'- metric\\_list: the metrics of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the metric import task was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1639382496000', 'title' => ''], + 'TaskName' => ['description' => 'The name of the metric import task.', 'type' => 'string', 'example' => 'aliyun_task', 'title' => ''], + 'Namespace' => ['description' => 'The namespace to which the host belongs.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''], + 'UploadRegion' => ['description' => 'The region where the host resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'NetworkType' => ['description' => 'The network type of the host. Valid values:'."\n" + ."\n" + .'- `vpc`'."\n" + ."\n" + .'- `Internet`', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'CollectTimout' => ['description' => 'The timeout period during which the CloudMonitor agent collects host monitoring data. Valid values:'."\n" + ."\n" + .'- 0'."\n" + ."\n" + .'- 15'."\n" + ."\n" + .'- 30'."\n" + ."\n" + .'- 60'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'CollectTargetEndpoint' => ['description' => 'The URL of the destination from which the CloudMonitor agent collects host monitoring data.', 'type' => 'string', 'example' => 'http://localhost', 'title' => ''], + 'TaskType' => ['description' => 'The type of the metric import task. Valid values:'."\n" + ."\n" + .'- aliyun\\_fc: metric import tasks for Alibaba Cloud services'."\n" + ."\n" + .'- aliyun\\_sls: metrics for logs imported from Log Service', 'type' => 'string', 'example' => 'aliyun_sls', 'title' => ''], + 'MatchExpressRelation' => ['description' => 'The relationship between the conditions that are used to filter metric import tasks. Valid values:'."\n" + ."\n" + .'- or'."\n" + ."\n" + .'- and', 'type' => 'string', 'example' => 'or', 'title' => ''], + 'Description' => ['description' => 'The description of the metric import task.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '3607****', 'title' => ''], + 'CollectInterval' => ['description' => 'The interval at which the CloudMonitor agent collects host monitoring data. Valid values:'."\n" + ."\n" + .'- 15'."\n" + ."\n" + .'- 30'."\n" + ."\n" + .'- 60'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'TargetUserId' => ['description' => 'The ID of the member account.'."\n" + ."\n" + .'> This parameter is displayed only when you call this operation by using a management account.', 'type' => 'string', 'example' => '120886317861****', 'title' => ''], + 'CollectTargetPath' => ['description' => 'The relative path from which the CloudMonitor agent collects monitoring data.', 'type' => 'string', 'example' => '/metrics', 'title' => ''], + 'CollectTargetType' => ['description' => 'The type of the monitoring data. Valid values: Spring, Tomcat, Nginx, Tengine, JVM, Redis, and MySQL.', 'type' => 'string', 'example' => 'nginx', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the metric import task.', 'type' => 'string', 'example' => '36****', 'title' => ''], + 'AttachLabels' => [ + 'description' => 'The tags of the metric import task.', + 'type' => 'array', + 'items' => [ + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - 'description' => '', - ], - ], + 'MatchExpress' => [ + 'description' => 'The conditions that are used to match the instances in the application group.', + 'type' => 'array', + 'items' => [ + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The keyword that corresponds to the instance name.', 'type' => 'string', 'example' => 'ECS_instance1', 'title' => ''], + 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'The method that is used to match the instance name. Valid values:'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix'."\n" + ."\n" + .'- all: matches all'."\n" + ."\n" + .'- equals: equals'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- notContains: does not contain', 'type' => 'string', 'example' => 'all', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Instances' => [ + 'description' => 'The instances where monitoring data is collected in batches.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-hp368focau7dp0hw****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ExtraInfo' => ['description' => 'The additional information of the instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'LogFilePath' => ['description' => 'The path where on-premises log data is stored. On-premises log data is stored in the specified path of the host where CloudMonitor is deployed.'."\n" + ."\n" + .'- Windows: The log path must start with a drive letter. Example: `C:\\UserData\\log\\*.Log`. You cannot specify wildcard characters in a log path.'."\n" + ."\n" + .'- Linux: The log path must start with a forward slash (/). Example: `/home/appdata/log/**/*.log`. In this example, `/**/` is used to match all files in the appdata directory.', 'type' => 'string', 'example' => 'C:\\UserData\\log\\*.Log', 'title' => ''], + 'LogSplit' => ['description' => 'The result that is returned after on-premises log data is split based on the specified matching mode.'."\n" + ."\n" + .'> The matching modes of on-premises log data include full regex mode, delimiter mode, and JSON mode.', '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"}]}}]}', 'title' => ''], + 'LogProcess' => ['description' => 'The method that is used to aggregate on-premises log data.', '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"}]}]', 'title' => ''], + 'LogSample' => ['description' => 'The sample on-premises log.', '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"]}}', 'title' => ''], + 'SLSProcess' => ['description' => 'The configurations of the logs that are imported from Log Service.', '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"}]}', 'title' => ''], + 'SLSProcessConfig' => [ + 'description' => 'The configurations of the logs that are imported from Log Service.'."\n" + ."\n" + .'> This parameter is returned only if the `TaskType` parameter is set to `aliyun_sls`.', + 'type' => 'object', + 'properties' => [ + 'Filter' => [ + 'description' => 'The conditions that are used to filter logs imported from Log Service.', + 'type' => 'object', + 'properties' => [ + 'Relation' => ['description' => 'The relationship between multiple filter conditions. Valid values:'."\n" + ."\n" + .'- and (default): Logs are processed only if all filter conditions are met.'."\n" + ."\n" + .'- or: Logs are processed if one of the filter conditions is met.', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'Filters' => [ + 'description' => 'The conditions that are used to filter logs imported from Log Service.', + 'type' => 'array', + 'items' => [ + 'description' => 'The conditions that are used to filter logs imported from Log Service.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the key that is used to filter logs imported from Log Service.', 'type' => 'string', 'example' => 'host', 'title' => ''], + 'Operator' => ['description' => 'The method that is used to filter logs imported from Log Service. Valid values:'."\n" + ."\n" + .'- `contain`: contains'."\n" + ."\n" + .'- `notContain`: does not contain'."\n" + ."\n" + .'- `>`: greater than'."\n" + ."\n" + .'- `<`: less than'."\n" + ."\n" + .'- `=`: equal to'."\n" + ."\n" + .'- `! =`: not equal to'."\n" + ."\n" + .'- `>=`: greater than or equal to'."\n" + ."\n" + .'- `<=`: less than or equal to', 'type' => 'string', 'example' => '=', 'title' => ''], + 'Value' => ['description' => 'The value of the key that is used to filter logs imported from Log Service.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Statistics' => [ + 'description' => 'The methods that are used to aggregate logs imported from Log Service.', + 'type' => 'array', + 'items' => [ + 'description' => 'The method that is used to aggregate logs imported from Log Service.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the key that is used to aggregate logs imported from Log Service.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'The function that is used to aggregate log data within a statistical period. Valid values:'."\n" + ."\n" + .'- count: counts the number.'."\n" + ."\n" + .'- sum: calculates the total value.'."\n" + ."\n" + .'- avg: calculates the average value.'."\n" + ."\n" + .'- max: calculates the maximum value.'."\n" + ."\n" + .'- min: calculates the minimum value.'."\n" + ."\n" + .'- value: collects samples within the statistical period.'."\n" + ."\n" + .'- countps: calculates the average number of the specified field per second by using the following formula: Counted number of the specified field/Total number of seconds within the statistical period.'."\n" + ."\n" + .'- sumps: calculates the average number of the specified field per second by using the following formula: Total value of the specified field/Total number of seconds within the statistical period.'."\n" + ."\n" + .'- distinct: counts the number of logs where the specified field appears within the statistical period.'."\n" + ."\n" + .'- distribution: counts the number of logs that meet a specified condition within the statistical period.'."\n" + ."\n" + .'- percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.', 'type' => 'string', 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the aggregation result.', 'type' => 'string', 'example' => 'level_count', 'title' => ''], + 'Parameter1' => ['description' => 'The value of the function that is used to aggregate logs imported from Log Service.'."\n" + ."\n" + .'- If the `Function` parameter is set to `distribution`, this parameter indicates the lower limit of the statistical interval. For example, 200 indicates that the number of HTTP requests whose status code is 2XX is calculated.'."\n" + ."\n" + .'- If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Parameter2' => ['description' => 'The value of the function that is used to aggregate logs imported from Log Service.'."\n" + ."\n" + .'> This parameter is returned only if the `Function` parameter is set to `distribution`. This parameter indicates the upper limit of the statistical interval. For example, 299 indicates that the number of HTTP requests whose status code is 2XX is calculated.', 'type' => 'string', 'example' => '299', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GroupBy' => [ + 'description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.', + 'type' => 'array', + 'items' => [ + 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the key that is used to aggregate logs imported from Log Service.', 'type' => 'string', 'example' => 'code', 'title' => ''], + 'Alias' => ['description' => 'The alias of the aggregation result.', 'type' => 'string', 'example' => 'ApiResult', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Express' => [ + 'description' => 'The extended fields that indicate the results of basic operations that are performed on aggregation results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The extended field that indicates the result of basic operations that are performed on aggregation results.', + 'type' => 'object', + 'properties' => [ + 'Express' => ['description' => 'The extended field that indicates the result of basic operations that are performed on aggregation results.', 'type' => 'string', 'example' => 'success_count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the extended field that indicates the result of basic operations that are performed on aggregation results.', 'type' => 'string', 'example' => 'SuccRate', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], ], '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' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => '%s', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeHybridMonitorTaskList', + 'description' => 'This topic provides an example on how to query all metric import tasks that belong to the current Alibaba Cloud account. The returned result indicates that the current account has only one metric import task. The metric import task is named `aliyun_task`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-07-20T10:29:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-09T09:38:01.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorTaskList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeHybridMonitorTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\tsuccessful\\r\\n\\t68192f5d-0d45-4b98-9724-892813f86c71\\r\\n\\t200\\r\\n\\t\\r\\n\\t\\t2c8dbdf9-a3ab-46a1-85a4-f094965e****\\r\\n\\t\\ttask1\\r\\n\\t\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'CreateInstantSiteMonitor', - 'description' => 'You can create an instant test task only by using the Alibaba Cloud account that you used to enable Network Analysis and Monitoring. '."\n" - ."\n" - .'This topic provides an example to show how to create an instant test task. The name of the task is `task1`. The tested address is `http://www.aliyun.com`. The test type is `HTTP`. The number of detection points is `1`.', - 'requestParamsDescription' => '# Extended options of the TaskType parameter'."\n" - ."\n" - .'The following tables describe the extended options of the HTTP, PING, TCP, UDP, and DNS protocols specified by the `TaskType` parameter.'."\n" - ."\n" - .'* HTTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|http\\_method|String|The HTTP request method. Valid values: GET, POST, and HEAD. Default value: GET.|'."\n" - .'|header|String|The custom HTTP headers that are separated by line feeds (\\\\n). Each header must comply with the HTTP protocol. Each header must be a key-value pair in which the key and value are separated by a colon (:).|'."\n" - .'|cookie|String|The HTTP cookie that is specified in compliance with the HTTP request standard.|'."\n" - .'|request\\_content|String|The content of the request. The content can be in the JSON or form format. If this parameter is not specified, the request body is empty.|'."\n" - .'|response\\_content|String|The expected content of the response. The first 64 bytes of the content returned by the HTTP server are checked during site monitoring.|'."\n" - .'|match\\_rule|String|0: The detection is successful if the response does not contain the content specified by the response\\_content parameter. 1: The detection is successful if the response contains the content specified by the response\\_content parameter.|'."\n" - .'|username|String|If the username parameter is specified, the HTTP request contains the basic authentication header.|'."\n" - .'|password|String|The password used to authenticate the HTTP request.|'."\n" - .'|time\\_out|int|The timeout period. Unit: milliseconds. Default value: 30000.|'."\n" - .'|max\\_redirect|int|The maximum number of redirections. The default value is 5 for a detection point that is running on an Elastic Compute Service (ECS) instance and 2 for a detection point that is provided by a carrier. To disable redirections, set the value to 0. Valid values: 0 to 50.|'."\n" - ."\n" - .'* PING'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|failure\\_rate|int|If the rate of the failed pings exceeds the value of this parameter, the detection fails and the status code 610 or 615 is returned. The error message of the status code 610 is PingAllFail and the error message of the status code 615 is PingPartialFail. Default value: 0.1.|'."\n" - .'|ping\\_num|int|The number of times that the monitored address is pinged. Default value: 20. Valid values: 1 to 100.|'."\n" - ."\n" - .'* TCP or UDP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the TCP or UDP server.|'."\n" - .'|request\\_content|string|The content of the request. If the request\\_format parameter is set to hex, the value of the request\\_content parameter is parsed in the hexadecimal format.|'."\n" - .'|request\\_format|string|If the request\\_format parameter is set to another value, the value of the request\\_content parameter is sent to the TCP or UDP server as a regular string.|'."\n" - .'|response\\_content|string|The content of the response. If the response from the TCP or UDP server does not contain the content specified by the response\\_content parameter, the detection fails. If the response\\_format parameter is set to hex, the value of the response\\_content parameter is parsed in the hexadecimal format. If the response\\_format parameter is set to another value, the value of the response\\_content parameter is parsed as a regular string.|'."\n" - ."\n" - .'* DNS'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|dns\\_server|string|The domain name or IP address of the Domain Name System (DNS) server.|'."\n" - .'|dns\\_type|string|The type of the DNS records to query. Valid values: A, NS, CNAME, MX, TXT, and ANY.|'."\n" - .'|expect\\_value|string|The list of expected values. Separate the expected values with space characters.|'."\n" - .'|match\\_rule|string|The relationship between the list of expected values and the list of DNS results. If the two lists do not meet the specified relationship, the detection fails. Valid values: Empty string or IN\\_DNS: The list of expected values is a subset of the list of DNS results. DNS\\_IN: The list of DNS results is a subset of the list of expected values. EQUAL: The list of DNS results is the same as the list of expected values. ANY: The list of DNS results intersects with the list of expected values.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'BatchCreateInstantSiteMonitor' => [ - 'summary' => 'Creates site monitoring tasks.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeLogMonitorAttribute' => [ + 'summary' => 'Queries a Log Monitoring task.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskList', + 'name' => 'MetricName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The site monitoring tasks.'."\n" - ."\n" - .'> You must create at least one site monitoring task. You must specify all of the `Address`, `TaskName`, and `TaskType` parameters in each request.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Address' => [ - 'description' => 'The URL or IP address that is monitored by the task.'."\n" - ."\n" - .'> You must create at least one site monitoring task. You must specify all of the `Address`, `TaskName`, and `TaskType` parameters in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - 'IspCities' => [ - 'description' => 'The detection points. If you leave this parameter empty, the system randomly selects three detection points.'."\n" - ."\n" - .'The value is a `JSON array`. Example: `{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}`. The values of the city field indicate Beijing, Hangzhou, and Qingdao.'."\n" - ."\n" - .'For information about how to obtain detection points, see [DescribeSiteMonitorISPCityList](~~115045~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], - 'OptionsJson' => [ - 'description' => 'The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"time_out":5000}', - ], - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n" - ."\n" - .'The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n" - ."\n" - .'> You must create at least one site monitoring task. You must specify all of the `Address`, `TaskName`, and `TaskType` parameters in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HangZhou_ECS1', - ], - 'TaskType' => [ - 'description' => 'The type of the site monitoring task.'."\n" - ."\n" - .'Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n" - ."\n" - .'> You must create at least one site monitoring task. You must specify all of the `Address`, `TaskName`, and `TaskType` parameters in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 200, - 'minItems' => 1, - ], + 'schema' => ['description' => 'The name of the metric.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_total_******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7AE72720-2C96-5446-9F2B-308C7CEDFF1A', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about the site monitoring task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'HangZhou_ECS1', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates a successful request.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C6718537-E673-4A58-8EE1-24B8B38C7AAE', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'LogMonitor' => [ + 'description' => 'The details of the Log Monitoring task.', + 'type' => 'object', + 'properties' => [ + 'ValueFilterRelation' => ['description' => 'The logical operator for the filter conditions. This parameter is used with \\`ValueFilter\\`. Valid values:'."\n" + ."\n" + .'- and: The logical AND operator.'."\n" + ."\n" + .'- or: The logical OR operator.', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'SlsLogstore' => ['description' => 'The name of the Simple Log Service Logstore.', 'type' => 'string', 'example' => 'logstore_******', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'cpu_total_******', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123******', 'title' => ''], + 'LogId' => ['description' => 'The ID of the Log Monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '123******', 'title' => ''], + 'MetricExpress' => ['description' => 'The metric expression.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'SlsRegionId' => ['description' => 'The ID of the region where Simple Log Service resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the task was created.'."\n" + ."\n" + .'This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'example' => '1678440033000', 'title' => ''], + 'SlsProject' => ['description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'example' => 'project_******', 'title' => ''], + 'Aggregates' => [ + 'description' => 'The definitions of aggregations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Max' => ['description' => 'The maximum value.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Min' => ['description' => 'The minimum value.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Function' => ['description' => 'The function that is used to aggregate log data in a statistical period. Valid values:'."\n" + ."\n" + .'- count: Counts the number of logs.'."\n" + ."\n" + .'- sum: Calculates the sum of values in a field.'."\n" + ."\n" + .'- avg: Calculates the average of values in a field.'."\n" + ."\n" + .'- max: Selects the maximum value in a field.'."\n" + ."\n" + .'- min: Selects the minimum value in a field.'."\n" + ."\n" + .'- countps: Calculates the average number of logs that are generated per second in a statistical period.'."\n" + ."\n" + .'- sumps: Calculates the average sum of values in a field per second in a statistical period.'."\n" + ."\n" + .'- distinct: Counts the number of unique values in a field in a statistical period.', 'type' => 'string', 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the field.', 'type' => 'string', 'example' => 'alias_******', 'title' => ''], + 'FieldName' => ['description' => 'The original name of the field in the log.', 'type' => 'string', 'example' => 'field_******', 'title' => ''], + ], + 'description' => 'The definition of an aggregation.', + 'title' => '', + 'example' => '', ], - 'TaskId' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => '679fbe4f-b80b-4706-91b2-5427b43e****', + 'title' => '', + 'example' => '', + ], + 'ValueFilter' => [ + 'description' => 'The filter conditions. This parameter is used with \\`ValueFilterRelation\\`. This parameter is equivalent to the \\`WHERE\\` clause in an SQL statement.'."\n" + ."\n" + .'If you do not specify this parameter, all data is processed. For example, if a log contains a \\`Level\\` field and you want to count the number of logs where the value of \\`Level\\` is \\`Error\\`, you can set the aggregation function to \\`count\\` and specify a filter condition where \\`Level\\` equals \\`Error\\`.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key.', 'type' => 'string', 'example' => 'key_******', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'value_******', 'title' => ''], + 'Operator' => ['description' => 'The operator that is used to match the field value. Valid values:'."\n" + ."\n" + .'- `contain`: contains.'."\n" + ."\n" + .'- `notContain`: does not contain.'."\n" + ."\n" + .'- `>`: greater than.'."\n" + ."\n" + .'- `<`: less than.'."\n" + ."\n" + .'- `>=`: greater than or equal to.'."\n" + ."\n" + .'- `<=`: less than or equal to.', 'type' => 'string', 'example' => 'contain', 'title' => ''], + ], + 'description' => 'The filter condition.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'Tumblingwindows' => [ + 'type' => 'array', + 'items' => ['description' => 'The pre-aggregation window. Unit: seconds. Cloud Monitor aggregates data in the specified pre-aggregation window.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'description' => 'The pre-aggregation window. Unit: seconds. Cloud Monitor aggregates data in the specified pre-aggregation window.', + 'title' => '', + 'example' => '', + ], + 'Groupbys' => [ + 'type' => 'array', + 'items' => ['description' => 'The \\`group by\\` definition', 'type' => 'string', 'example' => 'userId', 'title' => ''], + 'description' => 'The dimension based on which log data is aggregated. This parameter is equivalent to the \\`GROUP BY\\` clause in an SQL statement. You can specify a dimension to group monitoring data. If you do not specify this parameter, all monitoring data is aggregated based on the aggregation method.', + 'title' => '', + 'example' => '', ], ], - 'example' => '[{"taskName": "HangZhou_ECS1", "taskId": "679fbe4f-b80b-4706-91b2-5427b43e****"}]', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'The parameter is missing or invalid. %s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - 429 => [ - [ - 'errorCode' => 'ResourceOverLimit', - 'errorMessage' => 'The resource has exceeded the limit. %s', + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeLogMonitorAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogMonitorAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeLogMonitorAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n 7AE72720-2C96-5446-9F2B-308C7CEDFF1A\\n successful\\n \\n HangZhou_ECS1\\n 679fbe4f-b80b-4706-91b2-5427b43e****\\n \\n 200\\n true\\n","errorExample":""}]', - 'title' => 'BatchCreateInstantSiteMonitor', - 'description' => 'This topic provides an example on how to create a site monitoring task named `HangZhou_ECS1`. The URL that is monitored by the task is `https://www.aliyun.com` and the type of the task is `HTTP`. The returned result shows that the site monitoring task is created. The name of the site monitoring task is `HangZhou_ECS1` and the task ID is `679fbe4f-b80b-4706-91b2-5427b43e****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + '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"}]', 'extraInfo' => ' ', ], - 'DeleteSiteMonitors' => [ - 'summary' => 'Deletes one or more site monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeLogMonitorList' => [ + 'summary' => 'Queries log monitoring metrics.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskIds', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the site monitoring tasks that you want to delete. Separate multiple task IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '01adacc2-ece5-41b6-afa2-3143ab5d****,43bd1ead-514f-4524-813e-228ce091****', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'IsDeleteAlarms', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to delete the alert rules configured for the site monitoring tasks. Valid values:'."\n" - ."\n" - .'* true (default value)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SearchValue', + 'in' => 'query', + 'schema' => ['description' => 'The keyword that is used to search for log monitoring metrics. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ @@ -15361,385 +13159,408 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the call was successful, the value success is returned. If the call failed, an error message such as `TaskId not found` is returned.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '123BCC5D-8B63-48EA-B747-9A8995BE7AA6', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates success. The value false indicates failure.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about the site monitoring tasks that were deleted.'."\n", - 'type' => 'object', - 'properties' => [ - 'count' => [ - 'description' => 'The number of the site monitoring tasks that were deleted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '01E90080-4300-4FAA-B9AE-161956BC350D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'LogMonitorList' => [ + 'description' => 'The log monitoring metrics.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ValueFilterRelation' => ['description' => 'The logical operator that is used between log filter conditions. The ValueFilter and ValueFilterRelation parameters are used in pair. Valid values:'."\n" + ."\n" + .'- and'."\n" + ."\n" + .'- or', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'SlsLogstore' => ['description' => 'The name of the Simple Log Service (SLS) Logstore.', 'type' => 'string', 'example' => 'testSlS****', 'title' => ''], + 'MetricName' => ['description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'LogId' => ['description' => 'The ID of the log monitoring metric.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'SlsRegionId' => ['description' => 'The ID of the region where the SLS Logstore resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the log monitoring metric was created.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1577766395000', 'title' => ''], + 'SlsProject' => ['description' => 'The name of the SLS project.', 'type' => 'string', 'example' => 'sls-project-test****', 'title' => ''], + 'ValueFilter' => [ + 'description' => 'The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements. If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The name of the log field used for matching in the filter condition.', 'type' => 'string', 'example' => 'hostName', 'title' => ''], + 'Value' => ['description' => 'The field value to be matched in the filter condition.', 'type' => 'string', 'example' => 'portal', 'title' => ''], + 'Operator' => ['description' => 'The method that is used to match the field value. Valid values:'."\n" + ."\n" + .'- contain: contains'."\n" + ."\n" + .'- notContain: does not contain'."\n" + ."\n" + .'- `>`: greater than'."\n" + ."\n" + .'- `<`: less than'."\n" + ."\n" + .'- `>=`: greater than or equal to'."\n" + ."\n" + .'- `<=`: less than or equal to', 'type' => 'string', 'example' => 'contain', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - '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.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t\\t\\n\\t\\t\\t0\\n\\t\\t\\n\\t\\t请求成功\\n\\t\\t123BCC5D-8B63-48EA-B747-9A8995BE7AA6\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'DeleteSiteMonitors', + 'title' => 'DescribeLogMonitorList', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DisableSiteMonitors' => [ - 'summary' => 'Disables site monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogMonitorList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeLogMonitorList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMetricData' => [ + 'summary' => 'Queries the monitoring data of a metric for a cloud service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TaskIds', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric that is used to monitor the cloud service.'."\n" + ."\n" + .'For more information about the metrics of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_idle', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of the metric.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.'."\n" + ."\n" + .'- For more information about the statistical period of a metric that is specified by the `MetricName` parameter, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query monitoring data.'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.\\`\\`'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.\\`\\`\\`\\` The following examples demonstrate how to determine the period in which monitoring data is queried:'."\n" + ."\n" + .' - If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 3600, the specified time range must be less than or equal to 2 days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" + ."\n" + .'The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" + ."\n" + .'- UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You must set the `StartTime` parameter to a point in time that is later than 00:00:00 UTC on Thursday, January 1, 1970. Otherwise, this parameter is invalid.'."\n" + ."\n" + .'- We recommend that you use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '1618368900000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query monitoring data.'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.\\`\\`'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.\\`\\`\\`\\` The following examples demonstrate how to determine the period in which monitoring data is queried:'."\n" + ."\n" + .' - If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 3600, the specified time range must be less than or equal to 2 days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" + ."\n" + .'The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" + ."\n" + .'- UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n" + ."\n" + .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '1618368960000', 'title' => ''], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => ['description' => 'The dimensions based on which the resources are queried.'."\n" + ."\n" + .'Set the value to a collection of key-value pairs. A typical key-value pair is `instanceId:i-2ze2d6j5uhg20x47****`.'."\n" + ."\n" + .'> You can query a maximum of 50 instances in a single request.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId": "i-abcdefgh12****"}]', 'title' => ''], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => ['description' => 'The expression that is used to compute the query results in real time.'."\n" + ."\n" + .'> Only the `groupby` expression is supported. This expression is similar to the `GROUP BY` statement that is used in databases.', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', 'title' => ''], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 1000.'."\n" + ."\n" + .'> The maximum value of the Length parameter in a request is 1440.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The number of detection points that are affected by the site monitoring tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'count' => [ - 'description' => 'The number of detection points.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', 'title' => ''], + 'Datapoints' => ['description' => 'The monitoring data. The value includes the following fields:'."\n" + ."\n" + .'- `timestamp`: the time when the alert was triggered.'."\n" + ."\n" + .'- `userId`: the ID of the user for which the alert was triggered.'."\n" + ."\n" + .'- `instanceId`: the ID of the instance for which the alert was triggered.'."\n" + ."\n" + .'- `Minimum`, `Average`, and `Maximum`: the aggregation methods.', '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}]', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - '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.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeMetricData', + 'description' => '### [](#)Limits'."\n" + ."\n" + .'- The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. If the free quota is used up, you are automatically charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" + ."\n" + .'- Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" + ."\n" + .'### [](#)Description'."\n" + ."\n" + .'> Different from [DescribeMetricList](~~51936~~), the DescribeMetricData operation provides statistical features. You can set the Dimension parameter to `{"instanceId": "i-abcdefgh12****"}` to aggregate all data of your Alibaba Cloud account.'."\n" + ."\n" + .'This topic provides an example on how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2024-01-23T02:42:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-10T11:06:15.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:QueryMetricData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\tsuccessful\\r\\n\\tEC3F33C8-9149-493C-92A8-9B33A9DA951C\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DisableSiteMonitors', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'extraInfo' => ' ', ], - 'ModifySiteMonitor' => [ - 'summary' => 'Modifies a site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMetricLast' => [ + 'summary' => 'Queries the latest monitoring data of a specified metric.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Address', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL or IP address that is monitored by the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For information about the namespaces of cloud services, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', - ], + 'schema' => ['description' => 'The metric name of the cloud service.'."\n" + ."\n" + .'For information about metric names, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CPUUtilization', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the site monitoring task. The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HanZhou_ECS2', - ], + 'schema' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'> - If you do not specify a statistical period, the monitoring data is queried based on the reporting period that was specified when the metric was registered.'."\n" + .' - The statistical period varies by metric (`MetricName`) for each cloud service. For more information, see the `Min Periods` column on the **Metrics** page of the target cloud service in [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], [ - 'name' => 'Interval', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which detection requests are sent. Valid values: 1, 5, and 15. Unit: minutes. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The start time of the query.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00', 'title' => ''], ], [ - 'name' => 'IspCities', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The information of the detection points. The value is a JSON array. Example: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. The values of the `city` field indicate Beijing, Hangzhou, and Qingdao.'."\n" - ."\n" - .'> You can call the DescribeSiteMonitorISPCityList operation to query the detection points. For more information, see [DescribeSiteMonitorISPCityList](~~115045~~). If you leave this parameter empty, the system randomly selects three detection points.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], + 'schema' => ['description' => 'The end time of the query.'."\n" + ."\n" + .'- For second-level data, the actual start time of the query is the greater value between the time that is 20 minutes before EndTime and the specified startTime.'."\n" + ."\n" + .'- For minute-level data, the actual start time of the query is the greater value between the time that is 2 hours before EndTime and the specified startTime.'."\n" + ."\n" + .'- For hour-level data, the actual start time of the query is the greater value between the time that is 2 days before EndTime and the specified startTime.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:10:00', 'title' => ''], ], [ - 'name' => 'OptionsJson', + 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"time_out":5000}', - ], + 'schema' => ['description' => 'The monitoring dimensions of the specified resource.'."\n" + ."\n" + .'Format: a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A maximum of 50 instances can be queried in a single request.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', 'title' => ''], ], [ - 'name' => 'AlertIds', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can call the DescribeMetricRuleList operation to query the IDs of existing alert rules in CloudMonitor. For more information, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '49f7c317-7645-4cc9-94fd-ea42e122****', - ], + 'schema' => ['description' => 'The pagination cursor.'."\n" + ."\n" + .'- If the number of results that match the query conditions exceeds the page size, a pagination cursor is returned.'."\n" + .'- To retrieve the next page of data, use the returned cursor value as the request parameter until no cursor value is returned, which indicates that all data has been retrieved.', 'type' => 'string', 'required' => false, 'example' => '15761432850009dd70bb64cff1f0fff6c0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', 'title' => ''], ], [ - 'name' => 'IntervalUnit', + 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the metric.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ms', - ], + 'schema' => ['description' => 'The number of entries per page for the monitoring data. This parameter is used for paging.'."\n" + ."\n" + .'Default value: 1000, which indicates 1,000 entries of monitoring data per page.'."\n" + ."\n" + .'> The maximum value of Length in a single request is 1440.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'CustomSchedule', + 'name' => 'Express', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The custom detection period. You can only select a time period from Monday to Sunday for detection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', - ], + 'schema' => ['description' => 'The expression for real-time computation on existing query results.', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', 'title' => ''], ], ], 'responses' => [ @@ -15747,243 +13568,315 @@ 'schema' => [ '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 returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The result of modifying the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'count' => [ - 'description' => 'The number of site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], + 'NextToken' => ['description' => 'The pagination cursor.', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Datapoints' => ['description' => 'The monitoring data list.', 'type' => 'string', 'example' => '[{"timestamp":1548777660000,"userId":"123456789876****","instanceId":"i-abcdefgh12****","Minimum":93.1,"Average":99.52,"Maximum":100}]', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'Period' => ['description' => 'The time interval.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], ], - 'description' => 'N/A', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Query the latest monitoring data of a specified metric', + 'description' => '### Limits'."\n" + .'- The DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations share a free quota of 1,000,000 invocations per month in total. After the free quota is exhausted and you have not activated CloudMonitor Basic pay-as-you-go billing method, you cannot use this API operation normally. If you have activated CloudMonitor Basic pay-as-you-go billing method, this API operation remains available after the free quota is exhausted, and the excess usage is automatically billed. For more information about how to activate the pay-as-you-go billing method, see [Activate pay-as-you-go billing](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG&commodityCode=cms_basic_public_cn&from_biz_channel=help_bill).'."\n" + .'- A single API operation is limited to 50 invocations per second. This limit is shared by an Alibaba Cloud account and all Resource Access Management (RAM) users under the account.'."\n" + ."\n" + .'> If the response contains `Throttling.User` or `Request was denied due to user flow control` when you invoke this API operation, the request is throttled. For the method to handle this issue, see [How do I handle query API throttling](~~2615031~~).'."\n" + .'### Before you begin'."\n" + .'The storage duration of cloud service monitoring data depends on the `Period` (statistical period). A larger `Period` value results in sparser monitoring data and a longer storage duration. The following list describes the relationship:'."\n" + .'- If `Period` is less than 60 seconds, the storage duration is 7 days.'."\n" + .'- If `Period` is equal to 60 seconds, the storage duration is 31 days.'."\n" + .'- If `Period` is greater than or equal to 300 seconds, the storage duration is 91 days.'."\n" + .'### Operation description'."\n" + .'This topic provides an example of how to query the latest monitoring data of the `CPUUtilization` metric for the cloud service `acs_ecs_dashboard`. The response shows that the maximum value is 100, the minimum value is 93.1, and the average value is 99.52 at 60-second intervals for instance `i-abcdefgh12****` under account `123456789876****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricLast'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:QueryMetricLast', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeMetricList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - [ - '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.', - ], + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'For more information, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_idle', 'title' => ''], ], [ - [ - 'errorCode' => 'TaskNotExist', - 'errorMessage' => 'The specified task does not exist.', - ], + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'> - If you do not set this parameter, the reporting period that was specified when the metric was registered is used.'."\n" + ."\n" + .'- The statistical period of each metric (`MetricName`) of a cloud service is different. For more information, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on January 1, 1970.'."\n" + ."\n" + .'- Format: YYYY-MM-DD hh:mm:ss.'."\n" + ."\n" + .'> * The time range is a left-open and right-closed interval. The value of \\`StartTime\\` must be earlier than the value of \\`EndTime\\`.'."\n" + ."\n" + .'- The interval between \\`StartTime\\` and \\`EndTime\\` must be less than or equal to 31 days.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:00:00', 'title' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on January 1, 1970.'."\n" + ."\n" + .'- Format: YYYY-MM-DD hh:mm:ss.'."\n" + ."\n" + .'> The interval between \\`StartTime\\` and \\`EndTime\\` must be less than or equal to 31 days.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:10:00', 'title' => ''], ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => ['description' => 'The dimensions that specify the resources to be monitored.'."\n" + ."\n" + .'Format: a collection of key-value pairs, such as `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A single request can be used to query a maximum of 50 instances.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination cursor.'."\n" + ."\n" + .'> If you do not set this parameter, the first page of data is returned. If a value is returned for this parameter, it indicates that more data is available. To retrieve the next page, use the returned value as the \\`NextToken\\` in your next request. A null value indicates that all data has been retrieved.', 'type' => 'string', 'required' => false, 'example' => '15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****', 'title' => ''], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page for a paged query.'."\n" + ."\n" + .'> The maximum value of \\`Length\\` in a single request is 1440.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => ['description' => 'The expression that is used for real-time computing based on the query results.'."\n" + ."\n" + .'> Only the groupby expression is supported. This expression is similar to the GROUP BY statement in databases.', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The pagination cursor.', 'type' => 'string', 'example' => '15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Datapoints' => ['description' => 'The list of monitoring data.', 'type' => 'string', 'example' => '[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'Period' => ['description' => 'The statistical period. Unit: seconds. Valid values: 60, 300, and 900.', 'type' => 'string', 'example' => '60', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternetServerError', - 'errorMessage' => 'System internal error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\tsuccessful\\r\\n\\t32E77F32-B86E-4763-A0BB-0311581ABE67\\r\\n\\t\\r\\n\\t\\t1\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'ModifySiteMonitor', - 'description' => 'The number of site monitoring tasks.'."\n", - 'requestParamsDescription' => 'Site monitoring supports the following eight protocols. The following tables describe the extended options specified by the OptionsJson parameter for each protocol.'."\n" + 'title' => 'DescribeMetricList', + 'summary' => 'The DescribeMetricList operation queries the monitoring data of a specific metric for a cloud service.', + 'description' => '### Limits'."\n" ."\n" - .'* HTTP'."\n" + .'- You have a free quota of 1 million total API calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If you use up the free quota and have not enabled the pay-as-you-go billing method for CloudMonitor Basic, you can no longer use these API operations. If you have enabled the pay-as-you-go billing method, you can continue to use the API operations after the free quota is used up. API calls that exceed the free quota are automatically charged on a pay-as-you-go basis. For more information, see [Enable pay-as-you-go](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|http\\_method|String|The HTTP request method. Valid values: GET, POST, and HEAD. Default value: GET.|'."\n" - .'|header|String|The custom HTTP headers that are separated by line feeds (\\\\n).Each header must comply with the HTTP protocol. Each header must be a key-value pair in which the key and value are separated by a colon (:).|'."\n" - .'|cookie|String|The HTTP cookie that is specified in compliance with the HTTP request standard.|'."\n" - .'|request\\_content|String|The content of the request. The content can be in the JSON or form format. If this parameter is not specified, the request body is empty.|'."\n" - .'|response\\_content|String|The expected content of the response. The first 64 bytes of the content returned by the HTTP server are checked during site monitoring.|'."\n" - .'|match\\_rule|String|The value 0 indicates that the detection is successful if the response does not contain the content specified by the response\\_content parameter.1: If the response contains the content specified by the response\\_content parameter, the detection is successful.|'."\n" - .'|username|String|If the username parameter is specified, the HTTP request contains the basic authentication header.|'."\n" - .'|password|String|The password used to authenticate the HTTP request.|'."\n" - .'|time\\_out|int|The timeout period. Unit: milliseconds. Default value: 5.|'."\n" - .'|max\\_redirect|int|The maximum number of redirections. The default value is 5 for a detection point that is running on an Elastic Compute Service (ECS) instance and 2 for a detection point that is provided by a carrier.To disable redirections, set the value to 0.Valid values: 0 to 50.|'."\n" - ."\n\n" - .'* PING'."\n" + .'- You can call each API operation up to 50 times per second. This limit is shared between an Alibaba Cloud account and its RAM users.'."\n" ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|failure\\_rate|int|If the rate of the failed pings exceeds the value of this parameter, the detection fails and the status code 610 or 615 is returned. The error message of the status code 610 is PingAllFail and the error message of the status code 615 is PingPartialFail.Default value: 0.1.|'."\n" - .'|ping\\_num|int|The number of times that the monitored address is pinged. Default value: 20.Valid values: 1 to 100.|'."\n" - ."\n\n" - .'* DNS'."\n" + .'> If you receive the `Throttling.User` or `Request was denied due to user flow control` error message when you call an API operation, the API call is throttled. For more information, see [How do I resolve an API call throttling issue?](~~2615031~~).'."\n" ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|dns\\_server|string|The domain name or IP address of the Domain Name System (DNS) server.|'."\n" - .'|dns\\_type|string|The type of the DNS records to query. Valid values: A, NS, CNAME, MX, TXT, and ANY.|'."\n" - .'|expect\\_value|string|The list of expected values. Separate the expected values with spaces.|'."\n" - .'|match\\_rule|string|The relationship between the list of expected values and the list of DNS results. If the two lists do not meet the specified relationship, the detection fails. Valid values:Empty string or IN\\_DNS: The list of expected values is a subset of the list of DNS results.DNS\\_IN: The list of DNS results is a subset of the list of expected values.EQUAL: The list of DNS results is the same as the list of expected values.ANY: The list of DNS results intersects with the list of expected values.|'."\n" - ."\n\n" - .'* FTP'."\n" + .'### Notes'."\n" ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the FTP server. If this parameter is not specified, the default value is used. The default port number is 21 for FTP and 990 for FTPS.|'."\n" - .'|username|string|The username that is used to log on to the FTP server. If this parameter is not specified, anonymous logon is used.|'."\n" - .'|password|string|The password that is used to log on to the FTP server.|'."\n" - ."\n\n" - .'* POP3/SMTP'."\n" + .'The storage duration of monitoring data for a cloud service depends on the `Period` (statistical period). A larger `Period` value indicates that the monitoring data is less granular and is stored for a longer period. The relationship is as follows:'."\n" ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the POP3 server. The default port number is 110 for POP3 and 995 for POP3S.|'."\n" - .'|username|string|The username used to log on to the POP3 or SMTP server.|'."\n" - .'|password|string|The password used to log on to the POP3 or SMTP server.|'."\n" - ."\n\n" - .'* TCP/UDP'."\n" + .'- If the value of `Period` is less than 60 seconds, the storage duration is 7 days.'."\n" ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the TCP or UDP server.|'."\n" - .'|request\\_content|string|The content of the request. If the request\\_format parameter is set to hex, the value of the request\\_content parameter is parsed in the hexadecimal format.|'."\n" - .'|request\\_format|string|If the request\\_format parameter is set to another value, the value of the request\\_content parameter is sent to the TCP or UDP server as a regular string.|'."\n" - .'|response\\_content|string|The response content. If the response from the TCP or UDP server does not contain the content specified by the response\\_content parameter, the detection fails. If the response\\_format parameter is set to hex, the value of the response\\_format parameter is parsed in the hexadecimal format. If the response\\_format parameter is set to another value, the value of the response\\_content parameter is parsed as a regular string.|', + .'- If the value of `Period` is 60 seconds, the storage duration is 31 days.'."\n" + ."\n" + .'- If the value of `Period` is 300 seconds or greater, the storage duration is 91 days.'."\n" + ."\n" + .'### Usage notes'."\n" + ."\n" + .'This topic provides an example of how to query the monitoring data of the `cpu_idle` metric for the `acs_ecs_dashboard` cloud service. The response shows the data for the instance `i-abcdefgh12****`, which belongs to the Alibaba Cloud account `120886317861****`. At a 60 second interval, the maximum, minimum, and average values of the metric are 100, 93.1, and 99.52, respectively.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'EnableSiteMonitors' => [ - 'summary' => 'Enables site monitoring tasks.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-03-10T06:01:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-10T11:06:16.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:QueryMetricList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMetricMetaList' => [ + 'summary' => 'Queries metrics that are supported in CloudMonitor.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskIds', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'acs_kvstore', 'title' => ''], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => ['description' => 'The tags for filtering metrics. Specify a JSON string.'."\n" + ."\n" + .'Format: `[{"name":"tag key","value":"tag value"},{"name":"tag key","value":"tag value"}] `. The following tags are available:'."\n" + ."\n" + .'- metricCategory: the category of the metric.'."\n" + ."\n" + .'- alertEnable: specifies whether to report alerts for the metric.'."\n" + ."\n" + .'- alertUnit: the unit of the metric in the alerts.'."\n" + ."\n" + .'- unitFactor: the factor for metric unit conversion.'."\n" + ."\n" + .'- minAlertPeriod: the minimum interval at which the alert is reported.'."\n" + ."\n" + .'- productCategory: the category of the service.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"productCategory","value":"kvstore_old"}]', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ @@ -15991,1462 +13884,924 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The number of detection points that are affected by the site monitoring tasks.'."\n", + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CDE9EAFF-D54E-4024-BBFC-B0AAC883143B', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'count' => [ - 'description' => 'The number of detection points.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'Resource' => [ + 'description' => 'The configuration of the metrics in the resources.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'ads.diskSize', 'title' => ''], + 'Description' => ['description' => 'The metric description.', 'type' => 'string', 'example' => 'The rated disk capacity', 'title' => ''], + 'Labels' => ['description' => 'The tags of the metric, including one or more JSON strings.'."\n" + ."\n" + .'Format: `[{"name":"tag key","value":"tag value"}]`. The `name` can be repeated. The following tags are available:'."\n" + ."\n" + .'- metricCategory: the category of the metric.'."\n" + ."\n" + .'- alertEnable: indicates whether to report alerts for the metric.'."\n" + ."\n" + .'- alertUnit: the unit of the metric in the alerts.'."\n" + ."\n" + .'- unitFactor: the factor for metric unit conversion.'."\n" + ."\n" + .'- minAlertPeriod: the minimum interval at which the alert is reported.'."\n" + ."\n" + .'- productCategory: the category of the service.', '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\\"}]', 'title' => ''], + 'Unit' => ['description' => 'The unit of the metric.', 'type' => 'string', 'example' => 'MB', 'title' => ''], + 'Dimensions' => ['description' => 'The monitoring dimensions of the resource. Multiple monitoring dimensions are separated with commas (,).', 'type' => 'string', 'example' => 'userId,instanceId,tableSchema,workerId', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ads', 'title' => ''], + 'Periods' => ['description' => 'The statistical periods of the metric. Multiple statistical periods are separated with commas (,).'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method. Multiple statistical methods are separated with commas (,).', 'type' => 'string', 'example' => 'Average,Minimum,Maximum', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], - [ - [ - '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.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\tsuccessful\\n\\t7AB49ADD-3276-4161-B9F9-8662CAA800D6\\n\\t\\n\\t\\t0\\n\\t\\n\\t200\\n\\ttrue\\n","errorExample":""}]', - 'title' => 'EnableSiteMonitors', + 'title' => 'DescribeMetricMetaList', + 'description' => 'Use this operation together with DescribeMetricList and DescribeMetricLast. For more information, see [DescribeMetricList](~~51936~~) and [DescribeMetricLast](~~51939~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSiteMonitorQuota' => [ - 'summary' => 'Queries the quotas and version of site monitoring.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricMetaList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMetricRuleBlackList' => [ + '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' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '26860260-76C6-404E-AB7A-EB98D36A6885', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The quota.'."\n", - 'type' => 'object', - 'properties' => [ - 'SiteMonitorOperatorQuotaQuota' => [ - 'description' => 'The quota of detection points that are not provided by Alibaba Cloud. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SecondMonitor' => [ - 'description' => 'Indicates whether second-level monitoring is enabled. Valid values:'."\n" - ."\n" - .'* true: Second-level monitoring is enabled.'."\n" - .'* false: Second-level monitoring is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'SiteMonitorQuotaTaskUsed' => [ - 'description' => 'The used quota of site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'SiteMonitorTaskQuota' => [ - 'description' => 'The quota of site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SiteMonitorVersion' => [ - 'description' => 'The version of site monitoring. Valid values:'."\n" - ."\n" - .'* V1'."\n" - .'* V2'."\n", - 'type' => 'string', - 'example' => 'V1', - ], - 'SiteMonitorIdcQuota' => [ - 'description' => 'The quota of detection points that are provided by Alibaba Cloud. Five detection points are provided for free.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'systemTags' => ['operationType' => 'list', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'For information about the namespaces of Alibaba Cloud services, see [Cloud service metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The current page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order in which the query results are sorted by time. Valid values:'."\n" + ."\n" + .'- DESC (default): descending order.'."\n" + ."\n" + .'- ASC: ascending order.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'DESC', 'title' => ''], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['description' => 'The category of the Alibaba Cloud service. For example, Redis has `kvstore_standard` (Standard Edition), `kvstore_sharding` (Cluster Edition), and `kvstore_splitrw` (read/write splitting Edition).', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the alert blacklist policies.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert blacklist policy.', 'type' => 'string', 'required' => false, 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', 'title' => ''], + 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert blacklist policy.'."\n" + ."\n" + .'This parameter supports fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'Blacklist-01', 'title' => ''], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => ['description' => 'The effective scope of the alert blacklist policy. Valid values:'."\n" + ."\n" + .'- USER: The alert blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" + ."\n" + .'- GROUP: The alert blacklist policy takes effect within the specified application groups.', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => ['description' => 'The status of the alert blacklist policy. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + .'- false: disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'flat', + 'schema' => [ + 'description' => 'The instance IDs in the alert blacklist policy.'."\n" + ."\n" + .'Valid values of N: 0 to 10.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID in the alert blacklist policy.', 'type' => 'string', 'required' => false, 'example' => 'i-2ze2d6j5uhg20x47****', 'title' => ''], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D63E76CB-29AA-5B9F-88CE-400A6F28D428', 'title' => ''], + 'Total' => ['description' => 'The total number of alert blacklist policies.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: successful.'."\n" + ."\n" + .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DescribeMetricRuleBlackList' => [ + 'description' => 'The alert blacklist policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert blacklist policies.', + 'type' => 'object', + 'properties' => [ + 'EffectiveTime' => ['description' => 'The effective period of the alert blacklist policy.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp when the alert blacklist policy was last modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1665718373000', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the alert blacklist policy was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1665714561000', 'title' => ''], + 'ScopeType' => ['description' => 'The effective scope of the alert blacklist policy. Valid values:'."\n" + ."\n" + .'- USER: The alert blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" + ."\n" + .'- GROUP: The alert blacklist policy takes effect within the specified application groups.', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'IsEnable' => ['description' => 'The status of the alert blacklist policy. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Category' => ['description' => 'The category of the Alibaba Cloud service. For example, Redis has `kvstore_standard` (Standard Edition), `kvstore_sharding` (Cluster Edition), and `kvstore_splitrw` (read/write splitting Edition).', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'EnableEndTime' => ['description' => 'The start timestamp of the alert blacklist policy.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640608200000', 'title' => ''], + 'Name' => ['description' => 'The name of the alert blacklist policy.', 'type' => 'string', 'example' => 'Blacklist-01', 'title' => ''], + 'EnableStartTime' => ['description' => 'The end timestamp of the alert blacklist policy.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640237400000', 'title' => ''], + 'Id' => ['description' => 'The ID of the alert blacklist policy.', 'type' => 'string', 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', 'title' => ''], + 'Metrics' => [ + 'description' => 'The monitoring metrics of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The monitoring metrics of the instance.', + 'type' => 'object', + 'properties' => [ + 'Resource' => ['description' => 'The extension dimension information of the instance. For example, `{"device":"C:"}` indicates that the alert blacklist policy is applied to all C drives of the ECS instance under the Alibaba Cloud service.', 'type' => 'string', 'example' => '[{"device":"C:"}]', 'title' => ''], + 'MetricName' => ['description' => 'The monitoring metrics name.', 'type' => 'string', 'example' => 'disk_utilization', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Instances' => [ + 'description' => 'The instances of the specified Alibaba Cloud service in the alert blacklist policy.', + 'type' => 'array', + 'items' => ['description' => 'The instances of the specified Alibaba Cloud service in the alert blacklist policy.', 'type' => 'string', 'example' => 'i-rj99xc6cptkk64ml****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ScopeValue' => [ + 'description' => 'The application group IDs.', + 'type' => 'array', + 'items' => ['description' => 'The application group IDs. The value is in the JSON Array format.'."\n" + ."\n" + .'> This parameter is returned only when `ScopeType` is set to `GROUP`.', 'type' => 'string', 'example' => '["67****","78****"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Query alert blacklist policies', + 'summary' => 'Queries a list of alert blacklist policies.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2023-07-11T01:53:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleBlackList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeMetricRuleCount' => [ + 'summary' => 'Queries the number of alert rules in each state.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + 'AK' => [], ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MetricRuleCount' => [ + 'description' => 'The number of alert rules in each state.', + 'type' => 'object', + 'properties' => [ + 'Ok' => ['description' => 'The number of alert rules without active alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'Nodata' => ['description' => 'The number of alert rules without data.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Disable' => ['description' => 'The number of disabled alert rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Total' => ['description' => 'The total number of alert rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '45', 'title' => ''], + 'Alarm' => ['description' => 'The number of alert rules with active alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 402 => [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t\\t请求成功\\n\\t\\tC1359088-B0D3-4344-BA51-FB920425D836\\n\\t\\t\\n\\t\\t\\tV2\\n\\t\\t\\t2\\n\\t\\t\\tfalse\\n\\t\\t\\t0\\n\\t\\t\\t100\\n\\t\\t\\t5\\n\\t\\t\\n\\t\\t200\\n\\t\\ttrue\\n","errorExample":""}]', - 'title' => 'DescribeSiteMonitorQuota', + 'title' => 'DescribeMetricRuleCount', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSiteMonitorAttribute' => [ - 'summary' => 'Queries the details of a site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleCount'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMetricRuleList' => [ + 'summary' => 'Query all rules in the alert rule list.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', - ], + 'schema' => ['description' => 'The metric name.'."\n" + ."\n" + .'For information about how to obtain metric names, see [DescribeMetricMetaList](~~98846~~) or [Cloud service metrics](~~163515~~).'."\n" + ."\n" + .'Note: For composite metrics, you can only search by the first metric.', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], ], [ - 'name' => 'IncludeAlert', + 'name' => 'EnableState', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the information of the alert rules that are configured for the site monitoring task. Valid values:'."\n" - ."\n" - .'* true: The system returns the information of the alert rules that are configured for the site monitoring task.'."\n" - .'* false (default): The system does not return the information of the alert rules that are configured for the site monitoring task.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The enabled state of the alert rule. Valid values:'."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Cloud service metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Minimum value: 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'AlertState', + 'in' => 'query', + 'schema' => ['description' => 'The status of the alert rule. Valid values:'."\n" + .'- OK: Normal.'."\n" + .'- ALARM: Alert.'."\n" + .'- INSUFFICIENT_DATA: No data.', 'type' => 'string', 'required' => false, 'example' => 'OK', 'title' => ''], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => ['description' => 'The monitoring dimensions of the specified resource.'."\n" + ."\n" + .'Format: A collection of `key:value` pairs, for example, `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.', 'type' => 'string', 'required' => false, 'example' => '{"instanceId":"i-2ze2d6j5uhg20x47****"}', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'This parameter supports fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'Rule_01', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], + ], + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of alert rules. Separate multiple IDs with commas (,). You can query up to 20 alert rules at a time.', 'type' => 'string', 'required' => false, 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'MetricRules' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '386C6712-335F-5054-930A-CC92B851ECBA', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Alarms' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'MetricRule' => [ - 'description' => 'The alert rules that are configured for the site monitoring task.', + 'Alarm' => [ + 'description' => 'The list of alert rules.', 'type' => 'array', 'items' => [ - 'description' => 'The alert rule that is configured for the site monitoring task.', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'ActionEnable' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'AlarmActions' => [ - 'description' => 'The alert contact group to which alert notifications are sent.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold in the alert rule. Valid values:'."\n" - ."\n" - .'* `>=`'."\n" - .'* `>`'."\n" - .'* `<=`'."\n" - .'* `<`'."\n" - .'* `=`'."\n" - .'* `!=`'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanYesterday', - ], - 'Dimensions' => [ - 'description' => 'The dimension of the alert rule.'."\n", - 'type' => 'string', - 'example' => '[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]', - ], - 'EvaluationCount' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Expression' => [ - 'description' => 'The expression that is used to trigger alerts.'."\n", - 'type' => 'string', - 'example' => '$Availability=30', - ], - 'Level' => [ - 'description' => 'The alert severity. Valid values:'."\n" - ."\n" - .'* 1: critical'."\n" - .'* 2: warning'."\n" - .'* 3: information'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'Availability', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'The value is in the following format: acs_service name.'."\n", - 'type' => 'string', - 'example' => 'acs_networkmonitor', - ], - 'OkActions' => [ - 'description' => 'The alert contact group that receives alert notifications.'."\n", - 'type' => 'string', - 'example' => '[ "CloudMonitor"]', - ], - 'Period' => [ - 'description' => 'The time interval. The value is the same as the interval at which metric data is reported. Unit: seconds.'."\n" - ."\n" - .'> If you specify a statistical period for the alert rule, data is queried based on the statistical period.'."\n", - 'type' => 'string', - 'example' => '15s', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'bf071ae_7b7aec3817b0fdf****', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'rule1', - ], - 'StateValue' => [ - 'description' => 'The alert status. Valid values:'."\n" - ."\n" - .'* OK: The alert rule has no active alerts.'."\n" - .'* ALARM: The alert rule has active alerts.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Statistics' => [ - 'description' => 'The statistical method of the alert rule. Valid values:'."\n" - ."\n" - .'* Availability: the percentage of available detection points'."\n" - .'* AvailableNumber: the number of available detection points'."\n" - .'* ErrorCodeMaximum: a status code for an alert'."\n" - .'* ErrorCodeMinimum: all status codes for a set of alerts'."\n" - .'* Average: response time'."\n", - 'type' => 'string', - 'example' => 'Availability', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D17DF650-7EBD-54D0-903A-1D4E624D7402', - ], - 'SiteMonitors' => [ - 'description' => 'The details of the site monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Address' => [ - 'description' => 'The URL that is monitored by the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'https://aliyun.com', - ], - 'AgentGroup' => [ - 'description' => 'The type of the detection point. Default value: PC. Valid values:'."\n" - .'- PC'."\n" - .'- MOBILE', - 'type' => 'string', - 'example' => 'PC', - ], - 'CustomSchedule' => [ - 'description' => 'The custom detection cycle. You can specify only a time range within a week (from Monday to Sunday).', - 'type' => 'object', - 'properties' => [ - 'days' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'days' => [ - 'description' => 'The days in a week.', - 'type' => 'array', - 'items' => [ - 'description' => 'The days in a week.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'end_hour' => [ - 'description' => 'The end time of the detection. Unit: hours.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '18', - ], - 'start_hour' => [ - 'description' => 'The start time of the detection. Unit: hours.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'time_zone' => [ - 'description' => 'The time zone of the detection.', - 'type' => 'string', - 'example' => 'local', - ], - ], - ], - 'Interval' => [ - 'description' => 'The interval at which the site monitoring task is executed. Unit: minutes. Valid values: 1, 5, 15, 30, and 60.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'IspCities' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'IspCity' => [ - 'description' => 'The information of detection points. The information includes the carriers that provide the detection points and the cities where the detection points reside.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection point information.', + 'SilenceTime' => ['description' => 'The mute period. Unit: seconds. Default value: 86400. Minimum value: 3600.'."\n" + ."\n" + .'If the monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute period.', 'type' => 'integer', 'format' => 'int32', 'example' => '86400', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL when an alert is triggered. CloudMonitor pushes alert information to this URL through a POST request. Currently, only the HTTP protocol is supported.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Alarm', 'title' => ''], + 'SourceType' => ['description' => 'The type of the alert rule. Valid value: METRIC, indicating a time series metric alert rule.', 'type' => 'string', 'example' => 'METRIC', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'MailSubject' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'example' => '"${serviceType}-${metricName}-${levelDescription} notification(${dimensions})"', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time range during which the alert rule is ineffective.', 'type' => 'string', 'example' => '00:00-05:30', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The time range during which the alert rule is effective.', 'type' => 'string', 'example' => '05:31-23:59', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'Rule_01', 'title' => ''], + 'AlertState' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- OK: Normal.'."\n" + ."\n" + .'- ALARM: Alert.'."\n" + ."\n" + .'- INSUFFICIENT_DATA: No data.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Period' => ['description' => 'The aggregation period.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.'."\n" + .'> This parameter is displayed if the alert rule is associated with an application group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '7301****', 'title' => ''], + 'Dimensions' => ['description' => 'The dimensions of the alert rule.', 'type' => 'string', 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', 'title' => ''], + 'EnableState' => ['description' => 'The enabled state. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => ['description' => 'The resources associated with the alert rule.', 'type' => 'string', 'example' => '[{\\"instanceId\\":\\"i-2ze2d6j5uhg20x47****\\"}]', 'title' => ''], + 'Escalations' => [ + 'description' => 'The trigger conditions for alerts by severity level.', 'type' => 'object', 'properties' => [ - 'City' => [ - 'description' => 'The city ID.'."\n", - 'type' => 'string', - 'example' => '738', - ], - 'CityName' => [ - 'description' => 'The city name.'."\n", - 'type' => 'string', + 'Info' => [ + 'description' => 'The trigger conditions of Info-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Info-level thresholds. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: year-over-year increase compared to the same time yesterday.'."\n" + .'- LessThanYesterday: year-over-year decrease compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: year-over-year increase compared to the same time last week.'."\n" + .'- LessThanLastWeek: year-over-year decrease compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: period-over-period increase compared to the previous period.'."\n" + .'- LessThanLastPeriod: period-over-period decrease compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'PreCondition' => ['description' => 'The precondition for Info-level alerts. When the ComparisonOperator parameter is set to year-over-year or period-over-period comparison, this parameter works together with it.'."\n" + ."\n" + .'For example, if this parameter is set to $Average>80, ComparisonOperator is set to GreaterThanYesterday, and Threshold is set to 10, an alert is triggered when the average value is greater than 80 and the value has increased by 10% compared to yesterday.'."\n" + ."\n" + .'>$Average in $Average>0 is a placeholder in the format of $monitoring_result_field_value. CloudMonitor replaces it with the corresponding statistical value or original monitoring value.', 'type' => 'string', 'example' => '$Average>80', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times for which the Info-level alert condition is met. An alert is triggered only when the condition is met for the specified consecutive times and the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Info-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Info-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'Isp' => [ - 'description' => 'The carrier ID.'."\n", - 'type' => 'string', - 'example' => '465', - ], - 'IspName' => [ - 'description' => 'The carrier name.'."\n", - 'type' => 'string', + 'Warn' => [ + 'description' => 'The trigger conditions of Warn-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Warn-level thresholds. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: year-over-year increase compared to the same time yesterday.'."\n" + .'- LessThanYesterday: year-over-year decrease compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: year-over-year increase compared to the same time last week.'."\n" + .'- LessThanLastWeek: year-over-year decrease compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: period-over-period increase compared to the previous period.'."\n" + .'- LessThanLastPeriod: period-over-period decrease compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'PreCondition' => ['description' => 'The precondition for Warn-level alerts. When the ComparisonOperator parameter is set to year-over-year or period-over-period comparison, this parameter works together with it.'."\n" + ."\n" + .'For example, if this parameter is set to $Average>80, ComparisonOperator is set to GreaterThanYesterday, and Threshold is set to 10, an alert is triggered when the average value is greater than 80 and the value has increased by 10% compared to yesterday.'."\n" + .'> $Average in $Average>0 is a placeholder in the format of $monitoring_result_field_value. CloudMonitor replaces it with the corresponding statistical value or original monitoring value.', 'type' => 'string', 'example' => '$Average>80', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times for which the Warn-level alert condition is met. An alert is triggered only when the condition is met for the specified consecutive times and the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Warn-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Warn-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'Type' => [ - 'description' => 'The network type of the detection point. Valid values: IDC, LASTMILE, and MOBILE.', - 'type' => 'string', - 'example' => 'IDC', + 'Critical' => [ + 'description' => 'The trigger conditions of Critical-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Critical-level thresholds. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: year-over-year increase compared to the same time yesterday.'."\n" + .'- LessThanYesterday: year-over-year decrease compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: year-over-year increase compared to the same time last week.'."\n" + .'- LessThanLastWeek: year-over-year decrease compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: period-over-period increase compared to the previous period.'."\n" + .'- LessThanLastPeriod: period-over-period decrease compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'PreCondition' => ['description' => 'The precondition for Critical-level alerts. When the ComparisonOperator parameter is set to year-over-year or period-over-period comparison, this parameter works together with it.'."\n" + ."\n" + .'For example, if this parameter is set to $Average>80, ComparisonOperator is set to GreaterThanYesterday, and Threshold is set to 10, an alert is triggered when the average value is greater than 80 and the value has increased by 10% compared to yesterday.'."\n" + .'>$Average in $Average>0 is a placeholder in the format of `$monitoring_result_field_value`. CloudMonitor replaces it with the corresponding statistical value or original monitoring value.', 'type' => 'string', 'example' => '$Average>80', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times for which the Critical-level alert condition is met. An alert is triggered only when the condition is met for the specified consecutive times and the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Critical-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Critical-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'OptionJson' => [ - 'description' => 'The extended options of the site monitoring task. The options vary based on the specified protocol. For more information, see [CreateSiteMonitor](~~115048~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'assertions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'assertions' => [ - 'description' => 'The assertions.', - 'type' => 'array', - 'items' => [ - 'description' => 'The assertions.', + 'NoDataPolicy' => ['description' => 'The method to handle alerts when no monitoring data is found. Valid values:'."\n" + .'- KEEP_LAST_STATE (default): No action is taken.'."\n" + .'- INSUFFICIENT_DATA: The alert content indicates no data.'."\n" + .'- OK: Normal.', 'type' => 'string', 'example' => 'KEEP_LAST_STATE', 'title' => ''], + 'CompositeExpression' => [ + 'description' => 'The alert conditions for multiple metrics.'."\n" + .'> Single-metric and multi-metric conditions are mutually exclusive and cannot be set at the same time.', + 'type' => 'object', + 'properties' => [ + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL: Critical.'."\n" + .'- WARN: Warning.'."\n" + .'- INFO: Information.', 'type' => 'string', 'example' => 'CRITICAL', 'title' => ''], + 'ExpressionList' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'operator' => [ - 'description' => 'The operator. Valid values:'."\n" - .'- contains: contains'."\n" - .'- doesNotContain: does not contain'."\n" - .'- matches: matches a regular expression'."\n" - .'- doesNotMatch: does not match a regular expression'."\n" - .'- is: equal to'."\n" - .'- isNot: not equal to'."\n" - .'- lessThan: less than'."\n" - .'- moreThan: greater than', - 'type' => 'string', - 'example' => 'lessThan', - ], - 'property' => [ - 'description' => 'The path to the assertion.'."\n" - .'- If the assertion type is body_json, the path is json path.'."\n" - .'- If the assertion type is body_xml, the path is xml path.', - 'type' => 'string', - 'example' => 'json path', - ], - 'target' => [ - 'description' => 'The value or character to which the condition of the assertion is compared.', - 'type' => 'string', - 'example' => '0', - ], - 'type' => [ - 'description' => 'The assertion type. Valid values:'."\n" - .'- response_time: checks whether the response time meets expectations.'."\n" - .'- status_code: checks whether the HTTP status code meets expectations.'."\n" - .'- header: checks whether the fields in the response header meet expectations.'."\n" - .'- body_text: check whether the content in the response body meets expectations by using text matching.'."\n" - .'- body_json: check whether the content in the response body meets expectations by using JSON parsing (JSONPath).'."\n" - .'- body_xml: check whether the content in the response body meets expectations by using XML parsing (XPath).', - 'type' => 'string', - 'example' => 'response_time', + 'ExpressionList' => [ + 'description' => 'The list of alert conditions created in standard mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name of the cloud service.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of the metric.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method of the metric. Valid values:'."\n" + .'- $Maximum: Maximum value.'."\n" + .'- $Minimum: Minimum value.'."\n" + .'- $Average: Average value.'."\n" + .'- $Availability: Availability (typically used for site monitoring).'."\n" + ."\n" + .'> `$` is the unified prefix for metrics. For supported cloud services, see [Cloud service metrics](~~163515~~).', 'type' => 'string', 'example' => '$Maximum', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator for the threshold. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: year-over-year increase compared to the same time yesterday.'."\n" + .'- LessThanYesterday: year-over-year decrease compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: year-over-year increase compared to the same time last week.'."\n" + .'- LessThanLastWeek: year-over-year decrease compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: period-over-period increase compared to the previous period.'."\n" + .'- LessThanLastPeriod: period-over-period decrease compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '90', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'ExpressionListJoin' => ['description' => 'The relationship between multi-metric alert conditions. Valid values:'."\n" + ."\n" + .'- `&&`: An alert is triggered only when all metrics meet the alert conditions. An alert is triggered only when all expressions in ExpressionList are `true`.'."\n" + ."\n" + .'- `||`: An alert is triggered when any one of the metrics meets the alert condition.', 'type' => 'string', 'example' => '||', 'title' => ''], + 'ExpressionRaw' => ['description' => 'The alert conditions created by using expressions. The following scenarios are included but not limited to:'."\n" + ."\n" + .'- Set an alert blocklist for some resources. For example, `$instanceId != \'i-io8kfvcpp7x5****\'` `&&` `$Average > 50` indicates that no alert is triggered even if the `Average` value of the instance `i-io8kfvcpp7x5****` in the alert rule exceeds 50.'."\n" + .'- Set a special alert threshold for a specified instance in the rule. For example, `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)` indicates that an alert is triggered only when the `Average` value of the instance `i-io8kfvcpp7x5****` exceeds 80, and an alert is triggered when the `Average` value of other instances exceeds 50.'."\n" + .'- Limit the number of instances that exceed the threshold in the rule. For example, `count($Average > 20) > 3` indicates that an alert is triggered only when the number of instances whose `Average` value exceeds 20 is greater than 3.'."\n", 'type' => 'string', 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert condition must be met before an alert notification is sent.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'attempts' => [ - 'description' => 'The number of retries after a DNS failure occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'auth_info' => [ - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'username' => [ - 'type' => 'string', - ], - 'password' => [ - 'type' => 'string', - ], - 'use_cookie_session_key' => [ - 'type' => 'boolean', - ], - 'grant_type' => [ - 'type' => 'string', - ], - 'client_id' => [ - 'type' => 'string', - ], - 'client_secret' => [ - 'type' => 'string', - ], - 'scopes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'scopes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', + 'Labels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Labels' => [ + 'description' => 'The tags of the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the alert rule.', 'type' => 'string', 'example' => 'cmsRuleKey', 'title' => ''], + 'Value' => ['description' => 'The tag value of the alert rule.', 'type' => 'string', 'example' => 'cmsRuleValue', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'token_url' => [ - 'type' => 'string', - ], - 'auth_style' => [ - 'type' => 'string', - ], - 'access_key_id' => [ - 'type' => 'string', - ], - 'access_key_secret' => [ - 'type' => 'string', - ], - 'region_id' => [ - 'type' => 'string', - ], - 'api_action' => [ - 'type' => 'string', - ], - 'api_version' => [ - 'type' => 'string', - ], - 'with_addon_resources' => [ - 'type' => 'boolean', - ], - 'service_name' => [ - 'type' => 'string', - ], - 'session_token' => [ - 'type' => 'string', - ], - ], - ], - 'blocked_url_list' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'blocked_url_list' => [ - 'description' => 'The blocked URLs. Wildcards are supported in paths.', - 'type' => 'array', - 'items' => [ - 'description' => 'The blocked URLs. Wildcards are supported in paths.', - 'type' => 'string', - 'example' => 'www.taobao.com/**', - ], - ], - ], - ], - 'browser_headers' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'browser_headers' => [ - 'description' => 'The custom headers. Format: {"key": "somekey", "value":"somevalue"}.', - 'type' => 'array', - 'items' => [ - 'description' => 'The custom headers. Format: {"key": "somekey", "value":"somevalue"}.', - 'type' => 'object', - 'example' => '{"key":"value"}', - ], - ], - ], - ], - 'browser_hosts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'browser_hosts' => [ - 'description' => 'The custom hosts. Format: {"key": "somekey", "value":"somevalue"}.', - 'type' => 'array', - 'items' => [ - 'description' => 'The custom hosts. Format: {"key": "somekey", "value":"somevalue"}.', - 'type' => 'string', - 'example' => '{"url":"www.taobao.com","ip":"127.0.0.1"}', - ], - ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'browser_info' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'browser_info' => [ - 'description' => 'The browser information.', - 'type' => 'array', - 'items' => [ - 'description' => 'The browser information.', + 'Prometheus' => [ + 'description' => 'Prometheus alerts.'."\n" + ."\n" + .'> This parameter is required only when you create Prometheus alert rules for Enterprise Cloud Monitor.', + 'type' => 'object', + 'properties' => [ + 'PromQL' => ['description' => 'The PromQL query statement.'."\n" + ."\n" + .'> The data obtained by the PromQL query statement is the alert data. Include the alert threshold in the statement.', 'type' => 'string', 'example' => 'CpuUsage{instanceId="xxxx"}[1m]>90', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL: Critical.'."\n" + .'- WARN: Warning.'."\n" + .'- INFO: Information.', 'type' => 'string', 'example' => 'CRITICAL', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert condition must be met before an alert notification is sent.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Annotations' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'browser' => [ - 'description' => 'The browser type.', - 'type' => 'string', - 'example' => 'Chrome', - ], - 'device' => [ - 'description' => 'The device type.', - 'type' => 'string', - 'example' => 'laptop', + 'Annotations' => [ + 'description' => 'When Prometheus alerts are triggered, the annotation keys and values are rendered to make it easier for you to understand the metrics or alert rules.'."\n" + .'> This feature is equivalent to Prometheus Annotations.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The annotation key.', 'type' => 'string', 'example' => 'summary', 'title' => ''], + 'Value' => ['description' => 'The annotation value.', 'type' => 'string', 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'SendOK' => ['title' => '', 'description' => 'Specifies whether to disable recovery alerts. Valid values: true (yes) and false (no).', 'type' => 'boolean', 'example' => 'true'], + 'ProductCategory' => ['description' => 'The type of the cloud service.', 'type' => 'string', 'example' => 'slb', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the rule was created. The value is a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760432061000', 'title' => ''], + 'GmtUpdate' => ['description' => 'The time when the rule was last updated. The value is a Unix timestamp.', 'type' => 'string', 'example' => '1760432061000', 'title' => ''], ], - 'browser_insecure' => [ - 'description' => 'Indicates whether certificate errors are ignored. Valid values:'."\n" - .'- false: Certificate errors are not ignored.'."\n" - .'- true: Certificate errors are ignored.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'browser_task_version' => [ - 'description' => 'The version of the browser test task. Valid values:'."\n" - .'- 1: browser test for a single page'."\n" - .'- 2: browser test for multiple pages', - 'type' => 'string', - 'example' => '1', - ], - 'cookie' => [ - 'description' => 'The cookie of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'lang=en', - ], - 'diagnosis_mtr' => [ - 'description' => 'Indicates whether the automatic MTR diagnostics feature is enabled for a failed task. Valid values:'."\n" - .'- false: The automatic MTR diagnostics feature is disabled for a failed task.'."\n" - .'- true: The automatic MTR diagnostics feature is enabled for a failed task.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'diagnosis_ping' => [ - 'description' => 'Indicates whether the automatic ping latency detection feature is enabled for a failed task. Valid values:'."\n" - .'- false: The automatic ping latency detection feature is disabled for a failed task.'."\n" - .'- true: The automatic ping latency detection feature is enabled for a failed task.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'dns_hijack_whitelist' => [ - 'description' => 'The DNS hijack whitelist.', - 'type' => 'string', - 'example' => 'www.taobao.com:www.taobao.com.danuoyi.tbcache.com', - ], - 'dns_match_rule' => [ - 'description' => 'The relationship between the list of expected aliases or IP addresses and the list of DNS results. Valid values:'."\n" - ."\n" - .'* IN_DNS: The list of expected values is a subset of the list of DNS results.'."\n" - .'* DNS_IN: The list of DNS results is a subset of the list of expected values.'."\n" - .'* EQUAL: The list of DNS results is the same as the list of expected values.'."\n" - .'* ANY: The list of DNS results intersects with the list of expected values.'."\n", - 'type' => 'string', - 'example' => 'IN_DNS', - ], - 'dns_server' => [ - 'description' => 'The IP address of the DNS server.'."\n" - ."\n" - .'> This parameter is returned only if the TaskType parameter is set to DNS.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'dns_type' => [ - 'description' => 'The type of the DNS record. This parameter is returned only if the TaskType parameter is set to DNS. Valid values:'."\n" - ."\n" - .'* A (default): a record that specifies an IP address related to the specified host name or domain name.'."\n" - .'* CNAME: a record that maps multiple domain names to a domain name.'."\n" - .'* NS: a record that specifies a DNS server used to parse domain names.'."\n" - .'* MX: a record that links domain names to the address of a mail server.'."\n" - .'* TXT: a record that stores the text information of host name or domain names. The text must be 1 to 512 bytes in length. The TXT record serves as a Sender Policy Framework (SPF) record to fight against spam.'."\n", - 'type' => 'string', - 'example' => 'A', - ], - 'empty_message' => [ - 'description' => 'Indicates whether the WebSocket task is allowed to return no response or return an empty response. Default value: false. Valid values: false and true.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'expect_exist_string' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'expect_exist_string' => [ - 'description' => 'The string that is expected to exist on the page.', - 'type' => 'array', - 'items' => [ - 'description' => 'The string that is expected to exist on the page.', - 'type' => 'string', - 'example' => 'expected string', - ], - ], - ], - ], - 'expect_non_exist_string' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'expect_non_exist_string' => [ - 'description' => 'The string that is not expected to exist on the page.', - 'type' => 'array', - 'items' => [ - 'description' => 'The string that is not expected to exist on the page.', - 'type' => 'string', - 'example' => 'unexpected string', - ], - ], - ], - ], - 'expect_value' => [ - 'description' => 'The domain name or alias to be parsed.'."\n" - ."\n" - .'> This parameter is returned only if the TaskType parameter is set to DNS.'."\n", - 'type' => 'string', - 'example' => 'dns_server', - ], - 'failure_rate' => [ - 'description' => 'The packet loss rate.'."\n" - ."\n" - .'> This parameter is returned only if the TaskType parameter is set to PING.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.4', - ], - 'header' => [ - 'description' => 'The header of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'testKey:testValue', - ], - 'http_method' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* get'."\n" - .'* post'."\n" - .'* head'."\n", - 'type' => 'string', - 'example' => 'get', - ], - 'ip_network' => [ - 'description' => 'ip_network indicates the network type of the task. Valid values: v4, v6, and auto. Default value: v4.'."\n", - 'type' => 'string', - 'example' => 'v4', - 'enum' => [], - ], - 'isBase64Encode' => [ - 'description' => 'Indicates whether to perform Base64 decoding and then store the password. Valid values: true and false.', - 'type' => 'string', - 'example' => 'true', - ], - 'match_rule' => [ - 'description' => 'Indicates whether the alert rule is included. Valid values:'."\n" - ."\n" - .'* 0: The alert rule is included.'."\n" - .'* 1: The alert rule is excluded.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'min_tls_version' => [ - 'description' => 'The minimum TLS version. By default, TLS 1.2 and later versions are supported. TLS 1.0 and 1.1 are disabled. If you still require TLS 1.0 or 1.1, you can change the configuration.', - 'type' => 'string', - 'example' => 'tlsv1.2', - ], - 'password' => [ - 'description' => 'The password of the SMTP, POP3, or FTP protocol.'."\n", - 'type' => 'string', - 'example' => '123****', - ], - 'ping_num' => [ - 'description' => 'The heartbeat of the PING protocol.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '29', - ], - 'ping_port' => [ - 'description' => 'The port number for TCP pings.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'ping_type' => [ - 'description' => 'The PING protocol type. Valid values:'."\n" - ."\n" - .'* icmp'."\n" - .'* tcp'."\n" - .'* udp'."\n", - 'type' => 'string', - 'example' => 'icmp,tcp,udp', - 'default' => 'icmp', - ], - 'port' => [ - 'description' => 'The port number of the TCP, UDP, SMTP, or POP3 protocol.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '110', - ], - 'protocol' => [ - 'description' => 'The protocol that is used to send the request.'."\n", - 'type' => 'string', - 'example' => 'TCP', - ], - 'quic_enabled' => [ - 'description' => 'Indicates whether the Quick UDP Internet Connections (QUIC) protocol is used for browser detection. Valid values: true false Default value: false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'quic_target' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'quic_target' => [ - 'description' => 'The sites for which the QUIC protocol is forcibly used.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The format is url:port for the sites for which the QUIC protocol is forcibly used. You can leave the port number empty. The default port number of 443.'."\n", - 'type' => 'string', - 'example' => 'www.taobao.com', - ], - ], - ], - ], - 'request_content' => [ - 'description' => 'The content of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'aa=bb', - ], - 'request_format' => [ - 'description' => 'The format of the HTTP request. Valid values:'."\n" - ."\n" - .'* hex: hexadecimal'."\n" - .'* txt: text'."\n", - 'type' => 'string', - 'example' => 'txt', - ], - 'response_content' => [ - 'description' => 'The response to the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'txt', - ], - 'response_format' => [ - 'description' => 'The format of the HTTP response. Valid values:'."\n" - ."\n" - .'* hex: hexadecimal'."\n" - .'* txt: text'."\n", - 'type' => 'string', - 'example' => 'txt', - ], - 'retry_delay' => [ - 'description' => 'The number of retries for failed detections.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'screen_shot' => [ - 'description' => 'Indicates whether page screenshot is enabled.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'time_out' => [ - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'traffic_hijack_element_blacklist' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'traffic_hijack_element_blacklist' => [ - 'description' => 'The traffic hijacking blacklist. When redirection occurs, if the URL of the resource loaded by the browser matches the expression in the blacklist, traffic hijacking is considered to have occurred.', - 'type' => 'array', - 'items' => [ - 'description' => 'The traffic hijacking blacklist. When redirection occurs, if the URL of the resource loaded by the browser matches the expression in the blacklist, traffic hijacking is considered to have occurred.', - 'type' => 'string', - 'example' => 'www.taobao.com', - ], - ], - ], - ], - 'traffic_hijack_element_count' => [ - 'description' => 'When redirection occurs, if the browser loads more than the specified number of resources, traffic hijacking is considered to have occurred. If you set the value to 0, no validation is performed. Default value: 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'traffic_hijack_element_whitelist' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'traffic_hijack_element_whitelist' => [ - 'description' => 'The traffic hijacking whitelist. When redirection occurs, if the URL of the resource loaded by the browser does not match any expression in the whitelist, traffic hijacking is considered to have occurred.', - 'type' => 'array', - 'items' => [ - 'description' => 'The traffic hijacking whitelist. When redirection occurs, if the URL of the resource loaded by the browser does not match any expression in the whitelist, traffic hijacking is considered to have occurred.', - 'type' => 'string', - 'example' => 'www.taobao.com', - ], - ], - ], - ], - 'username' => [ - 'description' => 'The username of the FTP, SMTP, or POP3 protocol.'."\n", - 'type' => 'string', - 'example' => 'testUser', - ], - 'waitTime_after_completion' => [ - 'description' => 'The additional waiting time after a page is opened in a browser test task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'scroll_end' => [ - 'description' => 'Indicates whether to scroll to the bottom of the page after opening the page. This parameter is valid for a browser test task.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'host_binding' => [ - 'description' => 'The custom hosts for the HTTP test task. Format: ip1,ip2:address. You can specify values in multiple lines. Specify the A record or CNAME record that can be resolved by the domain name at the left of the colon. Separate multiple records with commas (,). Specify the domain name at the right of the colon.', - 'type' => 'string', - 'example' => '127.0.0.1:www.aliyun.com', - ], - 'host_binding_type' => [ - 'description' => 'The host binding type. Valid values: 0 and 1. 0 indicates random. 1 indicates polling.', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '0', - '1', - ], - 'example' => '0', - ], - 'hops' => [ - 'description' => 'The number of hops to perform traceroute diagnostics if the PING task fails.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'icmp_timeout_millis' => [ - 'description' => 'The timeout period of a PING task that uses ICMP. Unit: milliseconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], - 'config_variables' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'config_variables' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - 'secure' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - 'steps' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'steps' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - 'deprecated' => true, - ], - 'step_type' => [ - 'type' => 'string', - ], - 'url' => [ - 'type' => 'string', - ], - 'allow_failure' => [ - 'type' => 'boolean', - ], - 'is_critical' => [ - 'type' => 'boolean', - ], - 'wait_time_in_secs' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'extracted_variables' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'extracted_variables' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - ], - 'parser' => [ - 'type' => 'object', - 'properties' => [ - 'parser_type' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - ], - ], - 'field' => [ - 'type' => 'string', - ], - 'extracted_type' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'option' => [ - 'type' => 'string', - ], - 'step_name' => [ - 'type' => 'string', - ], - 'use_generated_cookie' => [ - 'type' => 'boolean', - ], - 'auto_extract_cookie' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - 'trace_region' => [ - 'type' => 'string', - ], - 'trace_type' => [ - 'type' => 'string', - ], - 'safe_link' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'enable_packet_capture' => [ - 'type' => 'boolean', - ], - 'use_private_crt' => [ - 'title' => '是否使用私有证书', - 'type' => 'boolean', - ], - 'private_crt_file_name' => [ - 'title' => '私有证书文件名', - 'type' => 'string', - 'example' => 'cert.pem', - ], - 'use_ssl' => [ - 'title' => '执行TCP任务时是否进行SSL连接', - 'type' => 'boolean', - ], - 'max_tls_version' => [ - 'title' => '最高TLS版本', - 'type' => 'string', - ], - 'server_name' => [ - 'title' => '服务器名称指示', - 'type' => 'string', - ], - 'supported_cipher_suits' => [ - 'title' => '支持的加密套件', - 'type' => 'string', - ], - ], - ], - 'TaskId' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', - ], - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'test123', - ], - 'TaskState' => [ - 'description' => 'The status of the site monitoring task. Valid values:'."\n" - ."\n" - .'* 1: The task is enabled.'."\n" - .'* 2: The task is disabled.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TaskType' => [ - 'description' => 'The protocol that is used by the site monitoring task. Valid values: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'VpcConfig' => [ - 'description' => 'The VPC configurations of the synthetic test task.', - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'description' => 'The region of the website for synthetic monitoring.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.', - 'type' => 'string', - 'example' => 'sg-xxxxxx', - ], - 'VpcId' => [ - 'description' => 'The ID of the VPC used by the synthetic test task.', - 'type' => 'string', - 'example' => 'vpc-xxxxxx', - ], - 'VswitchId' => [ - 'description' => 'The ID of the vSwitch used by the synthetic test task.', - 'type' => 'string', - 'example' => 'vsw-xxxxxx', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'The parameter is missing or invalid. %s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => 'Parameter error'], ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - [ - '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.', + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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} notification(${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 \\"SendOK\\": true,\\n \\"ProductCategory\\": \\"slb\\",\\n \\"GmtCreate\\": 1760432061000,\\n \\"GmtUpdate\\": \\"1760432061000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query all rules in the alert rule list', + 'description' => 'This topic provides an example on how to query all alert rules in the alert rule list under the current Alibaba Cloud account. The response shows that the alert rule list contains only one alert rule. The name of the alert rule is `Rule_01` and the ID is `applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2025-08-05T09:36:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-18T05:44:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-29T09:45:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tGreaterThanYesterday\\r\\n\\t\\t\\tbf071ae_7b7aec3817b0fdf****\\r\\n\\t\\t\\t15s\\r\\n\\t\\t\\t3\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcc641dff-c19d-45f3-ad0a-818a0c4f****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tAvailability\\r\\n\\t\\t\\tacs_networkmonitor\\r\\n\\t\\t\\tCloudMonitor\\r\\n\\t\\t\\tAvailability\\r\\n\\t\\t\\tCloudMonitor\\r\\n\\t\\t\\t$Availability=30\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tOK\\r\\n\\t\\t\\t2\\r\\n\\t\\t\\trule1\\r\\n\\t\\t\\t30\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tsuccessful\\r\\n\\tD17DF650-7EBD-54D0-903A-1D4E624D7402\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t30000\\r\\n\\t\\t\\tget\\r\\n\\t\\t\\r\\n\\t\\tcc641dff-c19d-45f3-ad0a-818a0c4f****\\r\\n\\t\\t
https://aliyun.com
\\r\\n\\t\\ttest123\\r\\n\\t\\tHTTP\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t阿里巴巴\\r\\n\\t\\t\\t\\t465\\r\\n\\t\\t\\t\\t北京市\\r\\n\\t\\t\\t\\t738\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t1\\r\\n\\t\\t1\\r\\n\\t\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeSiteMonitorAttribute', - 'description' => 'This topic provides an example on how to query the details of a site monitoring task whose ID is `cc641dff-c19d-45f3-ad0a-818a0c4f****`. The returned result indicates that the task name is `test123`, the URL that is monitored by the task is `https://aliyun.com`, and the name of the carrier is `Alibaba`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DescribeSiteMonitorISPCityList' => [ - 'summary' => 'Queries the detection points that are provided by carriers.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMetricRuleTargets' => [ + 'summary' => 'Queries the notification channels of a specified alert rule by calling the DescribeMetricRuleTargets operation.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Isp', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name or ID of the carrier.'."\n" - ."\n" - .'> Carrier names support fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'City', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name or ID of the city.'."\n" - ."\n" - .'> City names support fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'IPV6', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query IPv6 probes. Valid values:'."\n" - ."\n" - .'* true (default): IPv6 probes are queried.'."\n" - .'* false: IPv6 probes are not queried.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'IPV4', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query IPv4 probes. Valid values:'."\n" - ."\n" - .'* true (default): IPv4 probes are queried.'."\n" - .'* false: IPv4 probes are not queried.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'ViewAll', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return all detection points. Valid values:'."\n" - ."\n" - .'* true (default): returns all detection points.'."\n" - .'* false: returns only available detection points.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n\n" + .'For information about how to obtain the alert rule ID, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ae06917_75a8c43178ab66****', 'title' => ''], ], ], 'responses' => [ @@ -17454,540 +14809,438 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B35D7D84-547B-4E61-B909-48A1F8A0C756', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IspCityList' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Targets' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'IspCity' => [ - 'description' => 'The queried detection points.'."\n", + 'Target' => [ + 'description' => 'The alert trigger targets.', 'type' => 'array', 'items' => [ - 'description' => 'The queried detection point.'."\n", + 'description' => 'The alert trigger targets.', 'type' => 'object', 'properties' => [ - 'CityName.en' => [ - 'description' => 'The city name.'."\n", - 'type' => 'string', - 'example' => 'Guiyang', - ], - 'IPV4ProbeCount' => [ - 'description' => 'The number of IPv4 probes.'."\n", - 'type' => 'string', - 'example' => '4', - ], - 'City' => [ - 'description' => 'The city ID.'."\n", - 'type' => 'string', - 'example' => '4', - ], - 'Isp' => [ - 'description' => 'The carrier ID.'."\n", - 'type' => 'string', - 'example' => '232', - ], - 'CityName.zh_CN' => [ - 'description' => 'The city name.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Region.zh_CN' => [ - 'description' => 'The name of the province.'."\n" - ."\n" - .'> This parameter can be returned only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'IspName.zh_CN' => [ - 'description' => 'The carrier name.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Country.en' => [ - 'description' => 'The name of the country.'."\n", - 'type' => 'string', - 'example' => 'China', - ], - 'IPV6ProbeCount' => [ - 'description' => 'The number of IPv6 probes.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Region' => [ - 'description' => 'The province name.'."\n", - 'type' => 'string', - 'example' => '264', - ], - 'Country' => [ - 'description' => 'The country name.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '629', - ], - 'IspName.en' => [ - 'description' => 'The carrier name.'."\n", - 'type' => 'string', - 'example' => 'China-Unicom', - ], - 'Region.en' => [ - 'description' => 'The name of the province.'."\n", - 'type' => 'string', - 'example' => 'Guizhou', - ], - 'Country.zh_CN' => [ - 'description' => 'The name of the country.'."\n" - ."\n" - .'> This parameter can be returned only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Area.zh_CN' => [ - 'description' => 'The area name.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Area.en' => [ - 'description' => 'The area name.'."\n", - 'type' => 'string', - 'example' => 'XiNan', - ], - 'IPPool' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'IPPool' => [ - 'description' => 'The IP address pool.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address pool.'."\n", - 'type' => 'string', - 'example' => '["192.68.XX.XX","192.68.XX.XX"]', - ], - ], - ], - ], + 'Id' => ['description' => 'The ID of the alert trigger target.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: `acs:{AbbreviatedServiceName}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. The following services are supported: Simple Message Queue (formerly MNS), elastic scaling (ESS), Simple Log Service (SLS), and Function Compute (FC). Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The parameter description for the ARN of Simple Message Queue (formerly MNS) is as follows:'."\n" + ."\n" + .'- {AbbreviatedServiceName}: mns'."\n" + ."\n" + .'- {userId}: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: the region where the Simple Message Queue (formerly MNS) queue or topic resides.'."\n" + ."\n" + .'- {ResourceType}: the type of the resource that accepts alert notifications. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {ResourceName}: the resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'example' => 'INFO', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'InvalidParameterValue', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\tsuccessful\\r\\n\\tB35D7D84-547B-4E61-B909-48A1F8A0C756\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t中国\\r\\n\\t\\t\\t西南\\r\\n\\t\\t\\tGuiyang\\r\\n\\t\\t\\t4\\r\\n\\t\\t\\t232\\r\\n\\t\\t\\t4\\r\\n\\t\\t\\tChina-Unicom\\r\\n\\t\\t\\tChina\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t贵阳市\\r\\n\\t\\t\\tXiNan\\r\\n\\t\\t\\t贵州省\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t264\\r\\n\\t\\t\\t629\\r\\n\\t\\t\\t联通\\r\\n\\t\\t\\tGuizhou\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t192.168.XX.XX\\r\\n\\t\\t\\t\\t192.168.XX.XX\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\r\\n","errorExample":""}]', - 'title' => 'DescribeSiteMonitorISPCityList', - 'description' => 'This topic provides an example on how to query the detection points that are provided by China Unicom in Guiyang.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query notification channels of a specified alert rule', + 'description' => '## Usage notes'."\n" + .'This topic provides an example to query the target resources associated with the alert rule `ae06917_75a8c43178ab66****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSiteMonitorData' => [ - 'summary' => 'Queries the fine-grained monitoring data of a site monitoring task.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-03-21T06:36:40.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTargets'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMetricRuleTemplateAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the monitored object whose monitoring data is to be queried. Valid values:'."\n" - ."\n" - .'* metric'."\n" - .'* event'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'metric', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. Valid values:'."\n" - ."\n" - .'* Availability'."\n" - .'* ResponseTime'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Availability', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1551579637000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1551581437000', - ], - ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period. The value is an integral multiple of 60. Unit: seconds.'."\n" - ."\n" - .'> The default value equals the minimum interval at which detection requests are sent to the monitored address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - ], - [ - 'name' => 'NextToken', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****', - ], + 'schema' => ['description' => 'The name of the alert template. You must set either `Name` or `TemplateId`.'."\n" + ."\n" + .'For information about how to obtain the alert template name, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Template1', 'title' => ''], ], [ - 'name' => 'Length', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of data points to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The ID of the alert template. You must set either `Name` or `TemplateId`.'."\n" + ."\n" + .'For information about how to obtain the alert template ID, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => false, 'example' => '70****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The pagination token.'."\n", - 'type' => 'string', - 'example' => 'ea42e5220930ea42e522****', - ], - 'Data' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'string', - 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3febb181-0d98-4af9-8b04-7faf36b048b9', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - ], - 'description' => '', - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8F3A82AD-DA92-52B0-8EC6-C059D1C3839F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'description' => 'The details of the alert template.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the alert template.', 'type' => 'string', 'example' => 'ECS template', 'title' => ''], + 'Name' => ['description' => 'The name of the alert template.', 'type' => 'string', 'example' => 'ECS_Template1', 'title' => ''], + 'RestVersion' => ['description' => 'The version of the alert template.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the alert template.', 'type' => 'string', 'example' => '70****', 'title' => ''], + 'AlertTemplates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertTemplate' => [ + 'description' => 'The alert templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert template.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Selector' => ['description' => 'The extended options of the alert dimension.', 'type' => 'string', 'example' => '{"disk":"/"}', 'title' => ''], + 'Webhook' => ['description' => 'The URL that triggers an alert callback.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the Alibaba Cloud service name.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'ECS_Rule', 'title' => ''], + 'NoDataPolicy' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + .'- KEEP_LAST_STATE (default): No action is performed.'."\n" + .'- INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.', 'type' => 'string', 'example' => 'KEEP_LAST_STATE', 'title' => ''], + 'Escalations' => [ + 'description' => 'The threshold and alert level.', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'The conditions that trigger Info-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week'."\n" + .'- LessThanLastWeek: less than the value at the same time last week'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Times' => ['description' => 'The number of retries for Info-level alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Info-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Info-level alerts.'."\n" + ."\n" + .'The valid values of `Statistics` vary based on the Alibaba Cloud service. For more information, see [Alibaba Cloud service metrics](~~163515~~).', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Warn' => [ + 'description' => 'The conditions that trigger Warn-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week'."\n" + .'- LessThanLastWeek: less than the value at the same time last week'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Times' => ['description' => 'The number of retries for Warn-level alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Warn-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Warn-level alerts.'."\n" + ."\n" + .'The valid values of `Statistics` vary based on the Alibaba Cloud service. For more information, see [Alibaba Cloud service metrics](~~163515~~).', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'The conditions that trigger Critical-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week'."\n" + .'- LessThanLastWeek: less than the value at the same time last week'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Times' => ['description' => 'The number of retries for Critical-level alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Critical-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Critical-level alerts.'."\n" + ."\n" + .'The valid values of `Statistics` vary based on the Alibaba Cloud service. For more information, see [Alibaba Cloud service metrics](~~163515~~).', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Labels' => [ + 'description' => 'The labels of the alert template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label of the alert template.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the alert template label.', 'type' => 'string', 'example' => 'label1', 'title' => ''], + 'Value' => ['description' => 'The value of the alert template label.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SilenceTime' => ['description' => 'The mute period. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'Query alert template details', + 'summary' => 'Queries the details of an alert template by calling the DescribeMetricRuleTemplateAttribute operation.', + 'description' => 'This topic provides an example on how to query the details of the alert template `70****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-23T06:00:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-04-23T03:08:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-27T11:46:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-26T09:11:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-22T02:14:37.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleTemplateAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t1551581040000\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t100\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t123****\\r\\n\\t\\t\\t2\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t49f7b317-7645-4cc9-94fd-1****\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t1551581100000\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t100\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t12345\\r\\n\\t\\t\\t2\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t49f7b317-7645-4cc9-94fd-1****\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\r\\n\\t\\tDBDEAC51-EA3C-4853-8F25-6B48D38A28A9\\r\\n\\t\\ttrue\\r\\n\\t\\t200\\r\\n","errorExample":""}]', - 'title' => 'DescribeSiteMonitorData', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The returned data contains a JSON string that may consist of several or all of the following parameters:'."\n" - ."\n" - .'* Error4XXRate: the percentage of detection results with 4XX status codes.'."\n" - .'* Error6XXRate: the percentage of detection results with 6XX status codes.'."\n" - .'* Error5XXRate: the percentage of detection results with 5XX status codes.'."\n" - .'* Error4XXNumber: the number of detection results with 4XX status codes.'."\n" - .'* Error5XXNumber: the number of detection results with 5XX status codes.'."\n" - .'* Error6XXNumber: the number of detection results with 6XX status codes.'."\n" - .'* Over5totalTime: the percentage of detection requests to which the response time exceeds 5,000 ms.'."\n" - .'* Over3totalTime: the percentage of detection requests to which the response time exceeds 3,000 ms.'."\n" - .'* Over2totalTime: the percentage of detection requests to which the response time exceeds 2,000 ms.'."\n" - .'* Over10FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 10%.'."\n" - .'* Over100FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 99%.'."\n" - .'* Over30FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 30%.'."\n" - .'* Over50FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 50%.'."\n" - .'* Over80FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 80%.'."\n" - .'* Over90FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 90%.'."\n" - .'* Over400NumberRate: the percentage of detection results with status codes that are greater than 400.'."\n" - .'* Over400NumberRate: the percentage of detection results with status codes that are greater than 500.'."\n" - .'* AvailableNumber: the number of available detection points.'."\n" - .'* UnavailableNumber: the number of unavailable detection points.'."\n" - .'* Availability: the availability rate.'."\n" - .'* Unavailability: the unavailability rate.'."\n" - .'* ErrorCodeMaximum: the maximum error code in the detection results that were returned in a specific period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the maximum error code is 404.'."\n" - .'* ErrorCodeMinimum: the minimum error code in the detection results returned in a monitoring period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the minimum error code is 200.'."\n" - ."\n" - .'> We recommend that you use the AvailableNumber, UnavailableNumber, Availability, Unavailability, ErrorCodeMaximum, or ErrorCodeMinimum metric, whose value is easy to calculate.'."\n", - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","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 template\\",\\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}","type":"json"}]', ], - 'DescribeSiteMonitorStatistics' => [ - 'summary' => 'Queries the statistics of a specified metric for a specified site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMetricRuleTemplateList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task.'."\n" - ."\n" - .'For more information about how to obtain the ID of a site monitoring task, see [DescribeSiteMonitorList](~~115052~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ef4cdc8b-9dc7-43e7-810e-f950e56c****', - ], + 'schema' => ['description' => 'The name of the alert template.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Template1', 'title' => ''], ], [ - 'name' => 'TimeRange', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period.'."\n" - ."\n" - .'Unit: minutes. Default value: 1440 (one day). Maximum value: 43200 (30 days).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1440', - ], + 'schema' => ['description' => 'The keyword of the alert template name.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Unit: milliseconds. The default value is 1 hour ahead of the current time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1576142850527', - ], + 'schema' => ['description' => 'The ID of the alert template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70****', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. Valid values:'."\n" - ."\n" - .'* Availability'."\n" - .'* ErrorRate'."\n" - .'* ResponseTime'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Availability', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'History', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display the history of applying the alert templates to application groups. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sorting order. Valid values:'."\n" + ."\n" + .'- true (default): ascending order'."\n" + ."\n" + .'- false: descending order', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The sorting basis. Valid values:'."\n" + ."\n" + .'- gmtMotified: sorts alert templates by modification time'."\n" + ."\n" + .'- gmtCreate (default): sorts alert templates by creation time', 'type' => 'string', 'required' => false, 'example' => 'gmtCreate', 'title' => ''], ], ], 'responses' => [ @@ -17995,1988 +15248,2133 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Succcessful', - ], - 'Data' => [ - 'description' => 'The statistics.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3AD2724D-E317-4BFB-B422-D6691D071BE1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '659401C0-6214-5C02-972A-CFA929D717B7', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Templates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => 'The queried alert templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the alert template.', 'type' => 'string', 'example' => 'ECS的CPU使用率', 'title' => ''], + 'GmtCreate' => ['description' => 'The timestamp when the alert template was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646018798000', 'title' => ''], + 'Name' => ['description' => 'The name of the alert template.', 'type' => 'string', 'example' => 'ECS_Template1', 'title' => ''], + 'RestVersion' => ['description' => 'The version of the alert template.'."\n" + ."\n" + .'Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'GmtModified' => ['description' => 'The timestamp when the alert template was modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646054798000', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the alert template.', 'type' => 'integer', 'format' => 'int64', 'example' => '70****', 'title' => ''], + 'ApplyHistories' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApplyHistory' => [ + 'description' => 'The history of applying the alert templates to application groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '3607****', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'ApplyTime' => ['description' => 'The timestamp when the alert template was applied to the application group.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646055898000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 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.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\tsuccessful\\n\\t3AD2724D-E317-4BFB-B422-D6691D071BE1\\n\\t100\\n\\t200\\n\\ttrue\\n\\t","errorExample":""}]', - 'title' => 'DescribeSiteMonitorStatistics', - 'description' => 'This topic provides an example on how to query the statistics of the `Availability` metric for a site monitoring task whose ID is `ef4cdc8b-9dc7-43e7-810e-f950e56c****`. The result indicates that the availability rate of the site is `100%`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeMetricRuleTemplateList', + 'summary' => 'Queries alert templates.', + 'description' => 'This topic provides an example on how to query alert templates. In this example, the following alert templates are returned in the response: `ECS_Template1` and `ECS_Template2`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSiteMonitorList' => [ - 'summary' => 'Queries site monitoring tasks.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-03-22T08:53:07.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTemplateList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleTemplateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMetricTop' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a1ecd34a-8157-44d9-b060-14950837****', - ], + 'schema' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.'."\n" + ."\n" + .'- Statistical periods vary based on the metrics that are specified by `MetricName`. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol that is used by the site monitoring task. Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword to be matched.'."\n" - ."\n" - .'> You can search for tasks by name or address. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'site', - ], + 'schema' => ['description' => 'The metric that is used to monitor the cloud service.'."\n" + ."\n" + .'For more information about metric names, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_idle', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The start of the time range to query monitoring data.'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.\\`\\`'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.\\`\\`\\`\\`'."\n" + ."\n" + .' - If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" + ."\n" + .'The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" + ."\n" + .'- Time format: YYYY-MM-DDThh:mm:ssZ'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You must set the `StartTime` parameter to a point in time that is later than 00:00:00 Thursday, January 1, 1970. Otherwise, this parameter is invalid.'."\n" + ."\n" + .'- We recommend that you use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '2021-05-08 08:00:00', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end of the time range to query monitoring data.'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.\\`\\`'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.\\`\\`\\`\\`'."\n" + ."\n" + .' - If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" + ."\n" + .'The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" + ."\n" + .'- Time format: YYYY-MM-DDThh:mm:ssZ'."\n" + ."\n" + .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '2021-05-08 10:00:00', 'title' => ''], ], [ - 'name' => 'TaskState', + 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The task status. Valid values:'."\n" - ."\n" - .'* 1: The task is enabled.'."\n" - .'* 2: The task is disabled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The monitoring dimensions of the specified resource.'."\n" + ."\n" + .'Set the value to a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` or `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> You can query a maximum of 50 instances in each request.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId": "i-2ze2d6j5uhg20x47****"}]', 'title' => ''], ], [ - 'name' => 'AgentGroup', + 'name' => 'Orderby', + 'in' => 'query', + 'schema' => ['description' => 'The field based on which data is sorted. Valid values:'."\n" + ."\n" + .'- Average'."\n" + ."\n" + .'- Minimum'."\n" + ."\n" + .'- Maximum', 'type' => 'string', 'required' => true, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'OrderDesc', + 'in' => 'query', + 'schema' => ['description' => 'The order in which data is sorted. Valid values:'."\n" + ."\n" + .'- True: sorts data in ascending order.'."\n" + ."\n" + .'- False (default): sorts data in descending order.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.'."\n" + ."\n" + .'> The maximum value of the Length parameter in a request is 1440.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Express', 'in' => 'query', + 'schema' => ['description' => 'The expression that is used to compute the query results in real time.'."\n" + ."\n" + .'> Only the `groupby` expression is supported. This expression is similar to the GROUP BY statement used in databases.', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Task network type. Valid values:'."\n" - ."\n" - .'- PC: Cable Network'."\n" - ."\n" - .'- MOBILE: Mobile Cellular Network'."\n" - ."\n" - .'- FC: Alibaba Cloud VPC Network', - 'type' => 'string', - 'required' => false, - 'example' => 'PC', - 'enum' => [ - 'PC', - 'MOBILE', - 'FC', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', 'title' => ''], + 'Datapoints' => ['description' => 'The monitoring data.', '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}]', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the monitoring data. Unit: seconds. Valid values: 15, 60, 900, and 3600.', 'type' => 'string', 'example' => '60', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeMetricTop', + 'summary' => 'Queries the latest monitoring data of a metric for a cloud service. The data can be sorted by a specified order.', + 'description' => '### [](#)Limits'."\n" + ."\n" + .'- The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. After the free quota is used up, you are charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" + ."\n" + .'- Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" + ."\n" + .'### [](#)Precautions'."\n" + ."\n" + .'The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:'."\n" + ."\n" + .'- The storage duration is 7 days if the value of the `Period` parameter is less than 60 seconds.'."\n" + ."\n" + .'- The storage duration is 31 days if the value of the `Period` parameter is 60 seconds.'."\n" + ."\n" + .'- The storage duration is 91 days if the value of the `Period` is greater than or equal to 300 seconds.'."\n" + ."\n" + .'### [](#)Operation description'."\n" + ."\n" + .'This topic provides an example on how to query the monitoring data of the `cpu_idle` metric in the last 60 seconds for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The monitoring data is sorted in descending order based on the `Average` field.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricTop'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:QueryMetricTop', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + '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' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SiteMonitors' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9E0347B0-EBC3-4769-A78D-D96F21C6BB52', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MonitorGroupCategories' => [ + 'description' => 'The cloud services to which the resources in the application group belong and the number of resources that belong to the cloud service.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'SiteMonitor' => [ - 'description' => 'The site monitoring tasks that are returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskType' => [ - 'description' => 'The protocol that is used by the site monitoring task. Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n", - 'type' => 'string', - 'example' => 'TCP', - ], - 'UpdateTime' => [ - 'description' => 'The time when the site monitoring task was updated.'."\n", - 'type' => 'string', - 'example' => '2022-03-08 17:14:31', - ], - 'Interval' => [ - 'description' => 'The interval at which detection requests are sent. Unit: minutes.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TaskState' => [ - 'description' => 'The task status. Valid values:'."\n" - ."\n" - .'* 1: The task is enabled.'."\n" - .'* 2: The task is disabled.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CreateTime' => [ - 'description' => 'The time when the site monitoring task was created.'."\n", - 'type' => 'string', - 'example' => '2021-11-01 11:05:18', - ], - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => '域名检测_example.com.cn', - ], - 'Address' => [ - 'description' => 'The URL or IP address that is monitored by the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'https://aliyun.com', - ], - 'TaskId' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'f5783760-1b39-4b6b-80e8-453d962a****', - ], - 'OptionsJson' => [ - 'description' => 'The extended options of the site monitoring task. The options vary based on the specified protocol. For more information, see [CreateSiteMonitor](~~115048~~).'."\n", + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'MonitorGroupCategory' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CategoryItem' => [ + 'description' => 'The cloud services to which the resources in the application group belong and the number of resources that belong to the cloud service.', + 'type' => 'array', + 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'password' => [ - 'description' => 'The password of the SMTP, POP3, or FTP protocol.'."\n", - 'type' => 'string', - 'example' => '123****', - ], - 'request_format' => [ - 'description' => 'The format of the HTTP request. Valid values:'."\n" - ."\n" - .'* hex: hexadecimal'."\n" - .'* txt: text'."\n", - 'type' => 'string', - 'example' => 'hex', - ], - 'response_content' => [ - 'description' => 'The response to the HTTP request.'."\n" - ."\n" - .'* Hexadecimal format: If the request content is a byte string and cannot be represented in printable characters, you can convert the byte string to printable characters in the hexadecimal format. If you convert the byte string to printable characters in the hexadecimal format, one byte is converted to two hexadecimal characters. For example, (byte)1 is converted to `01` and (byte)27 is converted to `1B`. If the request content is a binary array in the Java format, for example, `{(byte)1, (byte)27}`, you can convert the binary array to `011b` or `011B`. Hexadecimal characters are not case-sensitive in site monitoring tasks. You can enter `011B` in the request content and set the request_format parameter to hex.'."\n" - .'* Text format: Common text refers to strings that consist of printable characters.'."\n", - 'type' => 'string', - 'example' => 'cf0f85', - ], - 'failure_rate' => [ - 'description' => 'The packet loss rate.'."\n" - ."\n" - .'> This parameter is returned only if the TaskType parameter is set to PING.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'time_out' => [ - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000', - ], - 'header' => [ - 'description' => 'The header of the HTTP request. An HTTP header is a key-value pair in which the key and the value are separated by a colon (:). The format is `key1:value1`. Each HTTP header occupies a line.'."\n", - 'type' => 'string', - 'example' => 'testKey:testValue', - ], - 'cookie' => [ - 'description' => 'The cookie of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'lang=en', - ], - 'port' => [ - 'description' => 'The port number of the TCP, UDP, SMTP, or POP3 protocol.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'ping_num' => [ - 'description' => 'The number of hops for the PING protocol.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'authentication' => [ - 'description' => 'Indicates whether the security authentication feature is enabled. Valid values:'."\n" - ."\n" - .'* 0: The feature is enabled.'."\n" - .'* 1: The feature is disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'http_method' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* get'."\n" - .'* post'."\n" - .'* head'."\n", - 'type' => 'string', - 'example' => 'get', - ], - 'match_rule' => [ - 'description' => 'Indicates whether the alert rule is included. Valid values:'."\n" - ."\n" - .'* 0: The alert rule is included.'."\n" - .'* 1: The alert rule is not included.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'dns_match_rule' => [ - 'description' => 'The relationship between the list of expected aliases or IP addresses and the list of DNS results. Valid values:'."\n" - ."\n" - .'* IN_DNS: The list of expected values is a subset of the list of DNS results.'."\n" - .'* DNS_IN: The list of DNS results is a subset of the list of expected values.'."\n" - .'* EQUAL: The list of DNS results is the same as the list of expected values.'."\n" - .'* ANY: The list of DNS results intersects with the list of expected values.'."\n", - 'type' => 'string', - 'example' => 'IN_DNS', - ], - 'request_content' => [ - 'description' => 'The content of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'cf0f85', - ], - 'username' => [ - 'description' => 'The username of the FTP, SMTP, or POP3 protocol.'."\n", - 'type' => 'string', - 'example' => 'testUser', - ], - 'response_format' => [ - 'description' => 'The format of the HTTP response. Valid values:'."\n" - ."\n" - .'* hex: hexadecimal'."\n" - .'* txt: text'."\n", - 'type' => 'string', - 'example' => 'hex', - ], - 'dns_type' => [ - 'description' => 'The type of the DNS record. This parameter is returned only if the TaskType parameter is set to DNS. Valid values:'."\n" - ."\n" - .'* A (default): a record that specifies an IP address related to the specified host name or domain name.'."\n" - .'* CNAME: a record that maps multiple domain names to a domain name.'."\n" - .'* NS: a record that specifies a DNS server used to parse domain names.'."\n" - .'* MX: a record that links domain names to the address of a mail server.'."\n" - .'* TXT: a record that stores the text information of host name or domain names. The text must be 1 to 512 bytes in length. The TXT record serves as a Sender Policy Framework (SPF) record to fight against spam.'."\n" - .'* AAAA: a record that maps a domain name to the relevant IPv6 address.'."\n", - 'type' => 'string', - 'example' => 'A', - ], - 'dns_server' => [ - 'description' => 'The domain name or IP address of the DNS server.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'enable_operator_dns' => [ - 'description' => 'Indicates whether the DNS server of the carrier is used.'."\n" - ."\n" - .'* true (default): The DNS server of the carrier is used.'."\n" - .'* false: The DNS server of the carrier is not used. The default DNS server or the specified DNS server is used.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'attempts' => [ - 'description' => 'The number of retries after a DNS failure occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'protocol' => [ - 'description' => 'The protocol type of DNS detection. Valid values:'."\n" - ."\n" - .'* udp (default)'."\n" - .'* tcp'."\n" - .'* tcp-tls'."\n", - 'type' => 'string', - 'example' => 'udp', - ], - 'proxy_protocol' => [ - 'description' => 'Indicates whether the PROXY protocol is enabled. Valid values:'."\n" - ."\n" - .'* false (default): The PROXY protocol is disabled.'."\n" - .'* true: The PROXY protocol is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'acceptable_response_code' => [ - 'description' => 'The acceptable status code.'."\n" - ."\n" - .'> We recommend that you configure assertions.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'isBase64Encode' => [ - 'description' => 'Indicates whether the password is decoded by using the Base64 algorithm. Valid values:'."\n" - ."\n" - .'* true: The password is decoded by using the Base64 algorithm.'."\n" - .'* false (default): The password is not decoded by using the Base64 algorithm.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'cert_verify' => [ - 'description' => 'Indicates whether the certificate is verified. Valid values:'."\n" - ."\n" - .'* false (default): The certificate is not verified.'."\n" - .'* true: The certificate is verified.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'unfollow_redirect' => [ - 'description' => 'Indicates whether redirects are followed if the status code 301 or 302 is returned. Valid values:'."\n" - ."\n" - .'* true: Redirects are not followed.'."\n" - .'* false (default): Redirects are followed.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'diagnosis_mtr' => [ - 'description' => 'Indicates whether MTR is automatically used to diagnose network issues if a task fails. Valid values:'."\n" - ."\n" - .'* false (default): MTR is not automatically used to diagnose network issues if a task fails.'."\n" - .'* true: MTR is automatically used to diagnose network issues if a task fails.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'diagnosis_ping' => [ - 'description' => 'Indicates whether ping requests are automatically sent to detect network latency if a detection task fails. Valid values:'."\n" - ."\n" - .'* false (default): Ping requests are not automatically sent to detect network latency if a detection task fails.'."\n" - .'* true: Ping requests are automatically sent to detect network latency if a detection task fails.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'retry_delay' => [ - 'description' => 'The number of times a failed detection request is retried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'assertions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'assertions' => [ - 'description' => 'The assertions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'property' => [ - 'description' => 'The parsing path of the assertion.'."\n" - ."\n" - .'* If the assertion type is `body_json`, the path is `json path`.'."\n" - .'* If the assertion type is `body_xml`, the path is `xml path`.'."\n", - 'type' => 'string', - 'example' => 'json path', - ], - 'type' => [ - 'description' => 'The assertion type. Valid values:'."\n" - ."\n" - .'* response_time: checks whether the response time meets expectations.'."\n" - .'* status_code: checks whether the HTTP status code meets expectations.'."\n" - .'* header: checks whether the fields in the response header meet expectations.'."\n" - .'* body_text: checks whether the content in the response body meets expectations by using text matching.'."\n" - .'* body_json: checks whether the content in the response body meets expectations by using JSON parsing (JSONPath).'."\n" - .'* body_xml: checks whether the content in the response body meets expectations by using XML parsing (XPath).'."\n", - 'type' => 'string', - 'example' => 'response_time', - ], - 'operator' => [ - 'description' => 'The comparison operator of the assertion. Valid values:'."\n" - ."\n" - .'* contains: contains'."\n" - .'* doesNotContain: does not contain'."\n" - .'* matches: matches regular expressions'."\n" - .'* doesNotMatch: does not match regular expressions'."\n" - .'* is: equal to a numeric value or matches a character'."\n" - .'* isNot: not equal to'."\n" - .'* lessThan: less than'."\n" - .'* moreThan: greater than'."\n", - 'type' => 'string', - 'example' => 'lessThan', - ], - 'target' => [ - 'description' => 'The numeric value or character used for matching.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - ], - ], - ], - ], - ], + 'Count' => ['description' => 'The number of resources that belong to the cloud service.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'AgentGroup' => [ - 'description' => 'The detection point type. Valid values:'."\n" - ."\n" - .'* PC'."\n" - .'* MOBILE'."\n", - 'type' => 'string', - 'example' => 'PC', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t1\\r\\n\\tA80DB41C-AF6C-50E1-ADB5-66DCBA3D266B\\r\\n\\tsuccessful\\r\\n\\t10\\r\\n\\t1\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tf5783760-1b39-4b6b-80e8-453d962a****\\r\\n\\t\\t\\t
https://aliyun.com
\\r\\n\\t\\t\\t\\r\\n\\t\\t\\ttest123\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\thex\\r\\n\\t\\t\\t\\thex\\r\\n\\t\\t\\t\\tcf0f85\\r\\n\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tTCP\\r\\n\\t\\t\\t2021-11-01 11:05:18\\r\\n\\t\\t\\t2022-03-08 17:14:31\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeSiteMonitorList', - 'description' => 'This topic provides an example on how to query all the site monitoring tasks of your Alibaba Cloud account. In this example, the returned result indicates that the Alibaba Cloud account has one site monitoring task named `HanZhou_ECS2`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeMonitorGroupCategories', + 'summary' => 'Queries the cloud services to which the resources in an application group belong and the number of resources that belong to each cloud service in the application group.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSiteMonitorLog' => [ - 'summary' => 'Queries the logs of one or more instant test tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupCategories'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupCategories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroup', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMonitorGroupDynamicRules' => [ + 'summary' => 'Queries the dynamic rules of an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskIds', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the instant test tasks. Separate multiple task IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'afa5c3ce-f944-4363-9edb-ce919a29****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], - [ - 'name' => 'Isp', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The carrier identification code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '465', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2170B94A-1576-4D65-900E-2093037CDAF3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The resources that are associated with the application group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'The type of the cloud service to which the dynamic rule belongs. Valid values:'."\n" + ."\n" + .'- ecs: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'FilterRelation' => ['description' => 'The filter condition. Valid values:'."\n" + ."\n" + .'- and: queries the instances that meet all alert rules.'."\n" + ."\n" + .'- or: queries the instances that meet any alert rule.', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'Filters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Filter' => [ + 'description' => 'The dynamic rules of the application group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value of the dynamic rule.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Function' => ['description' => 'The method that is used to filter the instances. Valid values:'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix', 'type' => 'string', 'example' => 'contains', 'title' => ''], + 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'hostName', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], + ], [ - 'name' => 'City', - 'in' => 'query', - 'schema' => [ - 'description' => 'The city identification code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '546', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'Only the `ProbeLog` metric is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ProbeLog', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The specified time range includes the end time and excludes the start time. The start time must be earlier than the end time.\\'."\n" - .' We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1638422474389', + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DescribeMonitorGroupDynamicRules', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupDynamicRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupDynamicRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMonitorGroupInstanceAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'EndTime', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Valid values:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format'."\n" - ."\n" - .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1638422475687', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.``'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IWBjqMYSy0is7zSMGu16****', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Valid values: 1 to 1000000000.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Length', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values: 1 to 1440.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 1000000000.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'Total', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition.'."\n" - ."\n" - .'You can specify a simple expression, for example, `TotalTime>100`. In this case, the operation returns only the data for instant test tasks whose total response time exceeds 100 milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TotalTime>100', - ], + 'schema' => ['description' => 'Specifies whether to return the total number of resources in the specified application group. Valid values:'."\n" + ."\n" + .'- true (default)'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'BrowserInfo', + 'name' => 'Category', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~2513265~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'Browser', + 'name' => 'Keyword', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - ' Chrome' => ' Chrome', - 'Safari' => 'Safari', - 'Edge' => 'Edge', - 'Firefox' => 'Firefox', - ], - 'example' => 'Chrome', - ], + 'schema' => ['description' => 'The keyword that is used to search for resources.', 'type' => 'string', 'required' => false, 'example' => 'portal', 'title' => ''], ], [ - 'name' => 'Device', + 'name' => 'InstanceIds', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'tablet' => 'tablet', - 'mobile' => 'mobile', - 'laptop' => 'laptop', - ], - 'example' => 'laptop', - ], + 'schema' => ['description' => 'The resource ID. Separate multiple resource IDs with commas (,). You can query the details about a maximum of 20 resources at a time.', 'type' => 'string', 'required' => false, 'example' => 'i-m5e0k0bexac8tykr****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'IWBjqMYSy0is7zSMGu16****', - ], - 'Data' => [ - 'description' => 'The logs of the instant test tasks.'."\n", - 'type' => 'string', - 'example' => '\\[{\\\\"redirectCount\\\\":0.0,\\\\"SSLConnectTime\\\\":0.0,\\\\"pingDetail\\\\":\\\\"\\\\",\\\\"HTTPConnectTime\\\\":0.0,\\\\"isp\\\\":\\\\"465\\\\",\\\\"errorCode\\\\":611,\\\\"ispCN\\\\":\\\\"Alibaba\\\\",\\\\"resolution\\\\":\\\\"\\\\",\\\\"areaEN\\\\":\\\\"HuaBei\\\\",\\\\"taskEndTimestamp\\\\":1638422475687,\\\\"targetIspEN\\\\":\\\\"\\\\",\\\\"TotalTime\\\\":1.0,\\\\"taskStartTimestamp\\\\":1638422474389,\\\\"countryCN\\\\":\\\\"China\\\\",\\\\"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\\\\":\\\\"North China\\\\",\\\\"city\\\\":\\\\"546\\\\",\\\\"expection\\\\":\\\\"\\\\",\\\\"suorceIp\\\\":\\\\"192.168.XX.XX \\\\",\\\\"ispEN\\\\":\\\\"Alibaba\\\\",\\\\"HTTPDNSTime\\\\":1.0,\\\\"targetIsp\\\\":\\\\"\\\\",\\\\"curlStarttransferTime\\\\":0.0,\\\\"provinceCN\\\\":\\\\"Beijing\\\\",\\\\"timestamp\\\\":1638422474000,\\\\"redirectTime\\\\":0.0,\\\\"targetCity\\\\":\\\\"\\\\", \\\\"expect\\\\":\\\\"\\\\",\\\\"HTTPDownloadSize\\\\":0.0,\\\\"localDns\\\\":\\\\"192.168.XX.XX\\\\",\\\\"cityCN\\\\":\\\\"Beijing\\\\",\\\\"taskId\\\\":\\\\"afa5c3ce-f944-4363-9edb-ce919a29\\*\\*\\*\\*\\\\"}]'."\n", - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '67F646FA-ED8A-58C2-B461-451DB52C8B14', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Description** The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9FB8EA79-7279-4482-8D6D-3D28EEDD871A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The resources that are associated with the application group.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'hostName', 'title' => ''], + 'Dimension' => ['description' => 'The dimensions of the resource that is associated with the application group.', 'type' => 'string', 'example' => '{"instanceId":"i-m5e0k0bexac8tykr****"}', 'title' => ''], + 'Category' => ['description' => 'The name of the cloud service.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-m5e0k0bexac8tykr****', 'title' => ''], + 'NetworkType' => ['description' => 'The network type.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'Desc' => ['description' => 'The resource description.', 'type' => 'string', 'example' => 'desc_test', 'title' => ''], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tag of the resource.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'instanceNetworkType', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Region' => [ + 'description' => 'The region.', + 'type' => 'object', + 'properties' => [ + 'AvailabilityZone' => ['description' => 'The zone.', 'type' => 'string', 'example' => 'cn-hangzhou-f', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Vpc' => [ + 'description' => 'The VPC description.', + 'type' => 'object', + 'properties' => [ + 'VswitchInstanceId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-2ze36seq79n992****', 'title' => ''], + 'VpcInstanceId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-2zew7etgiceg21****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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' => 'DescribeSiteMonitorLog', - 'description' => 'You can create an instant test task only by using the Alibaba Cloud account that you used to enable Network Analysis and Monitoring.'."\n" - ."\n" - .'This topic provides an example to show how to query the logs of an instant test task whose ID is `afa5c3ce-f944-4363-9edb-ce919a29****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - ], - 'DescribeMetricLast' => [ - 'summary' => 'Queries the latest monitoring data of a metric.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DescribeMonitorGroupInstanceAttribute', + 'summary' => 'Queries the resources in an application group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupInstanceAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroupInstances', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMonitorGroupInstances' => [ + 'summary' => 'Queries the resources in an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about metric names, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Valid values: 15, 60, 900, and 3600.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported. The statistical period of metrics (`MetricName`) varies for each cloud service. The statistical period of metrics is displayed in the `MinPeriods` column on the **Metrics** page for each cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123****', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query monitoring data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:00:00', - ], + 'schema' => ['description' => 'The abbreviation of the cloud service name. Valid values of N: 1 to 200.'."\n" + ."\n" + .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query monitoring data.'."\n" - ."\n" - .'* For second-level data, the start time is obtained by comparing the time that is specified by the StartTime parameter and 20 minutes earlier of the time that is specified by the EndTime parameter. The earlier one of the compared points in time is used as the start time.'."\n" - .'* For minute-level data, the start time is obtained by comparing the time that is specified by the StartTime parameter and 2 hours earlier of the time that is specified by the EndTime parameter. The earlier one of the compared points in time is used as the start time.'."\n" - .'* For hour-level data, the start time is obtained by comparing the time that is specified by the StartTime parameter and two days earlier of the time that is specified by the EndTime parameter. The earlier one of the compared points in time is used as the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:10:00', - ], + 'schema' => ['description' => 'The keyword used to search for instances. Fuzzy search based on instance names is supported.', 'type' => 'string', 'required' => false, 'example' => 'test-s1', 'title' => ''], ], [ - 'name' => 'Dimensions', + 'name' => 'InstanceIds', 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can query multiple instances by specifying multiple IDs.', 'type' => 'string', 'required' => false, 'example' => 'i-bp12g4xbl4i0brkn****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The monitoring dimensions of the specified resource.'."\n" - ."\n" - .'Set the value to a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` or `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> You can query a maximum of 50 instances in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId":"i-abcdefgh12****"}]', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '97F2A410-9412-499C-9AD1-76EF7EC02DF2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The information about the resources in the application group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'The abbreviation of the service name.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-bp12g4xbl4i0brkn****', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test-s1', 'title' => ''], + 'Id' => ['description' => 'The resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123****', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], + ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token.'."\n" - ."\n" - .'* If the number of results exceeds the maximum number of entries allowed on a single page, a pagination token is returned.'."\n" - .'* This token can be used as an input parameter to obtain the next page of results. If all results are obtained, no token is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '15761432850009dd70bb64cff1f0fff6c0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DescribeMonitorGroupInstances', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMonitorGroupNotifyPolicyList' => [ + 'summary' => 'Queries the list of alert notification pause policies for an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Length', + 'name' => 'PolicyType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 1000. This value indicates that a maximum of 1,000 entries of monitoring data can be returned on each page.'."\n" + 'description' => 'The type of the pause notification policy.'."\n" ."\n" - .'> The maximum value of the Length parameter for each request is 1440.'."\n", + .'Currently, only PauseNotify is supported.', 'type' => 'string', - 'required' => false, - 'example' => '1000', + 'required' => true, + 'enum' => ['PauseNotify'], + 'example' => 'PauseNotify', + 'title' => '', ], ], [ - 'name' => 'Express', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The expression that is used to calculate the query results in real time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '6780****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The pagination token.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Datapoints' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'string', - 'example' => '[{"timestamp":1548777660000,"userId":"123456789876****","instanceId":"i-abcdefgh12****","Minimum":93.1,"Average":99.52,"Maximum":100}]', - ], - '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.', - ], - 'Period' => [ - 'description' => 'The time interval.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6072F026-C441-41A6-B114-35A1E8F8FDD3', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'NotifyPolicyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NotifyPolicy' => [ + 'description' => 'The list of pause notification policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end timestamp.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1551761781273', 'title' => ''], + 'Type' => ['description' => 'The disable type.', 'type' => 'string', 'example' => 'PauseNotify', 'title' => ''], + 'StartTime' => ['description' => 'The start timestamp.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1551761781273', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '6780****', 'title' => ''], + 'Id' => ['description' => 'The ID of the pause notification policy.', 'type' => 'string', 'example' => '123****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t60\\r\\n\\t\\r\\n\\t\\t1548777660000\\r\\n\\t\\t100\\r\\n\\t\\t123456789876****\\r\\n\\t\\t93.1\\r\\n\\t\\ti-abcdefgh12****\\r\\n\\t\\t99.52\\r\\n\\t\\r\\n\\t6A5F022D-AC7C-460E-94AE-B9E75083D027\\r\\n\\ttrue\\r\\n\\t200\\r\\n","errorExample":""}]', - 'title' => 'DescribeMetricLast', - 'description' => '### [](#)Limits'."\n" - ."\n" - .'* The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. After the free quota is used up, you are charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" - .'* Each API operation can be called up to 50 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" - ."\n" - .'> If `Throttling.User` or `Request was denied due to user flow control` is returned when you call an API operation, the API operation is throttled. For more information about how to handle the issue, see [How do I handle the throttling of a query API?](~~2615031~~)'."\n" - ."\n" - .'### [](#)Precautions'."\n" - ."\n" - .'The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:'."\n" - ."\n" - .'* The storage duration is 7 days if the value of the `Period` parameter is less than 60 seconds.'."\n" - .'* The storage duration is 31 days if the value of the `Period` parameter is 60 seconds.'."\n" - .'* The storage duration is 91 days if the value of the `Period` parameter is greater than or equal to 300 seconds.'."\n" - ."\n" - .'### [](#)Operation description'."\n" - ."\n" - .'This topic provides an example on how to query the latest monitoring data of the `CPUUtilization` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The returned result indicates that the monitoring data for the instance `i-abcdefgh12****` of the account `123456789876****` is queried at an interval of 60 seconds. The maximum, minimum, and average values of the metric are 100, 93.1, and 99.52.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query alert notification pause policies for an application group', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricList' => [ - 'summary' => 'Queries the monitoring data of a metric for a specified cloud service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupNotifyPolicyList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupNotifyPolicyList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeMonitorGroups' => [ + 'summary' => 'You can call the DescribeMonitorGroups operation to query a list of application groups.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'SelectContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service. Format: acs_service name.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'Specifies whether to include alert contact groups in the response. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'For more information about metric names, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_idle', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which the monitoring data is queried.'."\n" - ."\n" - .'Valid values: 60, 300, and 900.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> Configure this parameter based on your business scenario.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Pages start from page 1. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format'."\n" - ."\n" - .'> The specified period includes the end time and excludes the start time. The start time must be earlier than the end time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:00:00', - ], + 'schema' => ['description' => 'The keyword for the search.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:10:00', - ], + 'schema' => ['description' => 'The ID of the instance. This parameter is used to query the application group to which the specified instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'i-abcdefgh12****', 'title' => ''], ], [ - 'name' => 'Dimensions', + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => false, 'example' => 'testGroup124', 'title' => ''], + ], + [ + 'name' => 'IncludeTemplateHistory', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include the history of alert templates that are applied to the application group in the response. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The dimensions that specify the resources whose monitoring data you want to query.'."\n" + 'description' => 'The type of the application group. Valid values:'."\n" + ."\n" + .'- custom: a custom application group.'."\n" ."\n" - .'Set the value to a collection of key-value pairs. A typical key-value pair is `instanceId:i-2ze2d6j5uhg20x47****`.'."\n" + .'- ehpc\\_cluster: an application group that is synchronized from an E-HPC cluster.'."\n" ."\n" - .'> You can query a maximum of 50 instances in a single request.'."\n", + .'- kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster.', 'type' => 'string', 'required' => false, - 'example' => '[{"instanceId": "i-abcdefgh12****"}]', + 'enum' => ['custom', 'ehpc_cluster', 'kubernetes', 'tag', 'aone_group', 'resMgr', 'ess'], + 'example' => 'custom', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'DynamicTagRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The paging token.'."\n" - ."\n" - .'> If this parameter is not specified, the data on the first page is returned. A return value other than Null of this parameter indicates that not all entries have been returned. You can use this value as an input parameter to obtain entries on the next page. The value Null indicates that all query results have been returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****', - ], + 'schema' => ['description' => 'The ID of the dynamic tag rule.', 'type' => 'string', 'required' => false, 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', 'title' => ''], ], [ - 'name' => 'Length', + 'name' => 'GroupFounderTagKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'> The maximum value of the Length parameter in a request is 1440.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The tag key of the application group that is created using a dynamic tag rule.', 'type' => 'string', 'required' => false, 'example' => 'GroupKey1', 'title' => ''], ], [ - 'name' => 'Express', + 'name' => 'GroupFounderTagValue', + 'in' => 'query', + 'schema' => ['description' => 'The tag value of the application group that is created using a dynamic tag rule.', 'type' => 'string', 'required' => false, 'example' => 'GroupValue1', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the application groups. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '92****', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The expression that is used to compute the query results in real time.'."\n" - ."\n" - .'> Only the groupby expression is supported. This expression is similar to the GROUP BY statement that is used in databases.'."\n", - 'type' => 'string', + 'description' => 'The tags of the application group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags of the application group.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of tag N. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'tagKey1', 'title' => ''], + 'Value' => ['description' => 'The value of tag N. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'tagValue1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Types', + 'in' => 'query', + 'schema' => ['description' => 'The type of the application group. Valid values:'."\n" + ."\n" + .'- custom: a custom application group.'."\n" + ."\n" + .'- ehpc\\_cluster: an application group that is synchronized from an E-HPC cluster.'."\n" + ."\n" + .'- kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster.'."\n" + ."\n" + .'- tag: an application group that is automatically created based on tags.'."\n" + ."\n" + .'- resMgr: an application group that is created based on a resource group.'."\n" + ."\n" + .'- ess: an application group that is synchronized from Auto Scaling (ESS).', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''], + ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The paging token.'."\n", - 'type' => 'string', - 'example' => '15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Datapoints' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'string', - 'example' => '[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'Period' => [ - 'description' => 'The interval at which the monitoring data is queried. Unit: seconds. Valid values: 60, 300, and 900.'."\n", - 'type' => 'string', - 'example' => '60', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F02B299A-D374-4595-9F55-7534D604F132', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the operation was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The resources that are associated with the monitor group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the linked instance.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the application group. Valid values:'."\n" + ."\n" + .'- custom: a custom application group.'."\n" + ."\n" + .'- ehpc\\_cluster: an application group that is synchronized from an E-HPC cluster.'."\n" + ."\n" + .'- kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster.', 'type' => 'string', 'example' => 'custom', 'title' => ''], + 'GroupFounderTagValue' => ['description' => 'The tag value of the application group that is created using a dynamic tag rule.', 'type' => 'string', 'example' => 'GroupValue1', 'title' => ''], + 'BindUrl' => ['description' => 'The URL that is synchronized from the ACK cluster.', 'type' => 'string', 'example' => 'https://aliyun.com', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'test123', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'ServiceId' => ['description' => 'The ID of the Alibaba Cloud service.', 'type' => 'string', 'example' => '49****', 'title' => ''], + 'DynamicTagRuleId' => ['description' => 'The ID of the dynamic tag rule.', 'type' => 'string', 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', 'title' => ''], + 'GmtCreate' => ['description' => 'The timestamp when the application group was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603181891000', 'title' => ''], + 'GroupFounderTagKey' => ['description' => 'The tag key of the application group that is created using a dynamic tag rule.', 'type' => 'string', 'example' => 'GroupKey1', 'title' => ''], + 'GmtModified' => ['description' => 'The timestamp when the application group was modified. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603181891000', 'title' => ''], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'The alert contact groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'An alert contact group.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are attached to the application group.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag that is attached to the application group.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the application group.', 'type' => 'string', 'example' => 'tagKey1', 'title' => ''], + 'Value' => ['description' => 'The tag value of the application group.', 'type' => 'string', 'example' => 'tagValue1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TemplateIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateId' => [ + 'description' => 'The IDs of the alert templates.', + 'type' => 'array', + 'items' => ['description' => 'The alert template applied to the application group.', 'type' => 'string', 'example' => '92****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aek2hopjh*******', 'title' => ''], + 'TemplateInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EffectTime' => ['description' => 'The effective period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603181891000', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the alert template.', 'type' => 'string', 'example' => '123***', 'title' => ''], + 'Ver' => ['description' => 'The version of the alert template.', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'description' => 'The information about an alert template.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The information about the alert templates.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t60\\r\\n\\t\\r\\n\\t\\t1490152860000\\r\\n\\t\\t100\\r\\n\\t\\t120886317861****\\r\\n\\t\\t93.1\\r\\n\\t\\ti-abcdefgh12****\\r\\n\\t\\t99.52\\r\\n\\t\\r\\n\\t6A5F022D-AC7C-460E-94AE-B9E75083D027\\r\\n\\ttrue\\r\\n\\t200\\r\\n","errorExample":""}]', - 'title' => 'DescribeMetricList', - 'description' => '## Limits'."\n" - ."\n" - .'Each API operation can be called up to 50 times per second. An Alibaba Cloud account and the RAM users within the account share the quota. '."\n" - ."\n\n" - .'>This topic provides an example to show how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The returned result indicates that the monitoring data for the instance `i-abcdefgh12****` of the account `120886317861****` is queried at an interval of 60 seconds. The maximum, minimum, and average values of the metric are 100, 93.1, and 99.52.', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeMonitorGroups', + 'description' => 'This topic provides an example of how to query a list of application groups. The response shows that two application groups are returned: `testGroup124` and `test123`.', + 'requestParamsDescription' => 'For more information about common parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricData' => [ - 'summary' => 'Queries the monitoring data of a metric for a cloud service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-01-10T03:06:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-14T08:13:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-21T09:50:30.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroups'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMonitorResourceQuotaAttribute' => [ + 'summary' => 'Queries the quotas of various CloudMonitor resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about the metrics of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_idle', - ], - ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the metric.'."\n" - ."\n" - .'Valid values: 15, 60, 900, and 3600.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.'."\n" - ."\n" - .'* For more information about the statistical period of a metric that is specified by the `MetricName` parameter, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'ShowUsed', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query monitoring data.'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.``'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.```` The following examples demonstrate how to determine the period in which monitoring data is queried:'."\n" - ."\n" - .' * If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" - .' * If you set the `Period` to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 3600, the specified time range must be less than or equal to 2 days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" - ."\n" - .'The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You must set the `StartTime` parameter to a point in time that is later than 00:00:00 UTC on Thursday, January 1, 1970. Otherwise, this parameter is invalid.'."\n" - ."\n" - .'* We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1618368900000', - ], + 'schema' => ['description' => 'Specifies whether the response includes used quotas. Valid values:'."\n" + .'- true (default): Included.'."\n" + .'- false: Not included.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The end of the time range to query monitoring data.'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.``'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.```` The following examples demonstrate how to determine the period in which monitoring data is queried:'."\n" - ."\n" - .' * If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" - .' * If you set the `Period` to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 3600, the specified time range must be less than or equal to 2 days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" - ."\n" - .'The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n" - ."\n" - .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1618368960000', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31BC7201-00F2-47B2-B7B9-6A173076ACE', 'title' => ''], + 'ResourceQuota' => [ + 'description' => 'The quota details of CloudMonitor.', + 'type' => 'object', + 'properties' => [ + 'SuitInfo' => ['description' => 'The current edition of CloudMonitor. Valid values:'."\n" + .'- free: Free Edition.'."\n" + .'- pro: Pro Edition.'."\n" + .'- cms_post: pay-as-you-go.', 'type' => 'string', 'example' => 'pro', 'title' => ''], + 'InstanceId' => ['description' => 'The subscription plan ID.', 'type' => 'string', 'example' => 'cms_edition-cn-n6w20rn****', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the plan.', 'type' => 'string', 'example' => '2021-02-28', 'title' => ''], + 'SiteMonitorEcsProbe' => [ + 'description' => 'The quota for site monitoring ECS detection points.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for site monitoring ECS detection points.'."\n" + ."\n" + .'> The maximum number of ECS detection points that can be selected for a single site monitoring task.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for site monitoring ECS detection points included in the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for site monitoring ECS detection points in the plan.'."\n" + ."\n" + .'> The total number of ECS detection points across all site monitoring tasks that have been created.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SiteMonitorOperatorProbe' => [ + 'description' => 'The quota for site monitoring carrier detection points.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for site monitoring carrier detection points.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for site monitoring carrier detection points included in the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for site monitoring carrier detection points in the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SiteMonitorTask' => [ + 'description' => 'The quota for site monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for site monitoring tasks. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for site monitoring tasks included in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for site monitoring tasks in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SiteMonitorBrowser' => [ + 'description' => 'The quota for browser-based monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for browser-based monitoring tasks. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for browser-based monitoring tasks included in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for browser-based monitoring tasks in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SiteMonitorMobile' => [ + 'description' => 'The quota for mobile monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for mobile monitoring tasks. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for mobile monitoring tasks included in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for mobile monitoring tasks in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CustomMonitor' => [ + 'description' => 'The quota for custom monitoring.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for custom monitoring time series. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1200', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for custom monitoring time series included in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for custom monitoring time series in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EventMonitor' => [ + 'description' => 'The quota for event monitoring.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for event monitoring. Unit: 10,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for event monitoring included in the plan. Unit: 10,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for event monitoring in the plan. Unit: 10,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'LogMonitor' => [ + 'description' => 'The quota for Log Monitoring.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for Log Monitoring. Unit: MB/min.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for Log Monitoring included in the plan. Unit: MB/min.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for Log Monitoring in the plan. Unit: MB/min.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Api' => [ + 'description' => 'The API quota.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total API quota. Unit: 10,000 calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'QuotaPackage' => ['description' => 'The API quota included in the plan. Unit: 10,000 calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used API quota in the plan. Unit: calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '9987', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SMS' => [ + 'description' => 'The quota for alert text message packages.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for alert text messages. Unit: messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '550', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for alert text message packages. Unit: messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for alert text message packages. Unit: messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '38', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Phone' => [ + 'description' => 'The quota for alert phone call packages.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for alert phone calls. Unit: calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '550', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for alert phone call packages. Unit: calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for alert phone call packages. Unit: calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EnterpriseQuota' => [ + 'description' => 'The quota details of Hybrid Cloud Monitoring.', + 'type' => 'object', + 'properties' => [ + 'SuitInfo' => ['description' => 'The description of Hybrid Cloud Monitoring.', 'type' => 'string', 'example' => 'ENTERPRISE', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID of Hybrid Cloud Monitoring.', 'type' => 'string', 'example' => 'cms_enterprise_public_cn-7mz27pd****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'Dimensions', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions based on which the resources are queried.'."\n" - ."\n" - .'Set the value to a collection of key-value pairs. A typical key-value pair is `instanceId:i-2ze2d6j5uhg20x47****`.'."\n" - ."\n" - .'> You can query a maximum of 50 instances in a single request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId": "i-abcdefgh12****"}]', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Query cloudMonitor resource quotas', + 'requestParamsDescription' => ' For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-07T08:33:21.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorResourceQuotaAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'Express', - 'in' => 'query', - 'schema' => [ - 'description' => 'The expression that is used to compute the query results in real time.'."\n" - ."\n" - .'> Only the `groupby` expression is supported. This expression is similar to the `GROUP BY` statement that is used in databases.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorResourceQuotaAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeMonitoringAgentAccessKey' => [ + 'summary' => 'Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a third-party host.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Length', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 1000.'."\n" - ."\n" - .'> The maximum value of the Length parameter in a request is 1440.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'AK' => [], ], ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\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 returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', - ], - 'Datapoints' => [ - 'description' => 'The monitoring data. The value includes the following fields:'."\n" - ."\n" - .'* `timestamp`: the time when the alert was triggered.'."\n" - .'* `userId`: the ID of the user for which the alert was triggered.'."\n" - .'* `instanceId`: the ID of the instance for which the alert was triggered.'."\n" - .'* `Minimum`, `Average`, and `Maximum`: the aggregation methods.'."\n", - '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' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Valid values: 15, 60, 900, and 3600.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60', - ], + 'AccessKey' => ['description' => 'The AccessKey ID that is required to install the agent.', 'type' => 'string', 'example' => 'E7A27f9****', 'title' => ''], + 'SecretKey' => ['description' => 'The AccessKey secret that is required to install the agent.', 'type' => 'string', 'example' => 'sBjNOUhLylrxMX-Xv1****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C0F655E9-D793-51E6-BD78-CABBCCFC1047', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t7598FEED-3B79-4B4A-AD01-435F34DA8EDC\\r\\n\\t60\\t\\r\\n [{\\\\\\"timestamp\\\\\\":1618368900000,\\\\\\"Average\\\\\\":95.8291666666667,\\\\\\"Minimum\\\\\\":65.48,\\\\\\"Maximum\\\\\\":100.0},{\\\\\\"timestamp\\\\\\":1618368960000,\\\\\\"Average\\\\\\":95.8683333333333,\\\\\\"Minimum\\\\\\":67.84,\\\\\\"Maximum\\\\\\":100.0}]\\r\\n\\t200\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeMetricData', - 'description' => '### [](#)Limits'."\n" - ."\n" - .'* The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. If the free quota is used up, you are automatically charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" - .'* Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" - ."\n" - .'### [](#)Description'."\n" - ."\n" - .'> Different from [DescribeMetricList](~~51936~~), the DescribeMetricData operation provides statistical features. You can set the Dimension parameter to `{"instanceId": "i-abcdefgh12****"}` to aggregate all data of your Alibaba Cloud account.'."\n" - ."\n" - .'This topic provides an example on how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeMonitoringAgentAccessKey', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentAccessKey'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentAccessKey', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'DescribeMetricMetaList' => [ - 'summary' => 'Queries the details of metrics that are supported in CloudMonitor.', - 'methods' => [ - 'post', - 'get', + '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' => 'The cloud services for which proactive alerting is enabled.', 'type' => 'string', 'example' => 'redis,rds,ecs', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D', 'title' => ''], + 'AutoInstall' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableInstallAgentNewECS' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed on newly purchased ECS instances. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DescribeMonitoringAgentConfig', + 'summary' => 'Queries the configurations of the CloudMonitor agent.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentConfig'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMonitoringAgentHosts' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'KeyWord', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'acs_kvstore', - ], + 'schema' => ['description' => 'The keyword for a fuzzy search.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'host1'], ], [ - 'name' => 'Labels', + 'name' => 'HostName', 'in' => 'query', - 'schema' => [ - 'description' => 'The tags for filtering metrics. Specify a JSON string.'."\n" - ."\n" - .'Format: ` [{"name":"tag key","value":"tag value"},{"name":"tag key","value":"tag value"}] `. The following tags are available:'."\n" - ."\n" - .'* metricCategory: the category of the metric.'."\n" - .'* alertEnable: specifies whether to report alerts for the metric.'."\n" - .'* alertUnit: the unit of the metric in the alerts.'."\n" - .'* unitFactor: the factor for metric unit conversion.'."\n" - .'* minAlertPeriod: the minimum interval at which the alert is reported.'."\n" - .'* productCategory: the category of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"name":"productCategory","value":"kvstore_old"}]', - ], + 'schema' => ['description' => 'The hostname.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hostNam1'], ], [ - 'name' => 'MetricName', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'i-a3d1q1pm2f9yr29e****'], + ], + [ + 'name' => 'SerialNumbers', + 'in' => 'query', + 'schema' => ['description' => 'The serial number of the host.'."\n" + ."\n" + .'A globally unique serial number is generated after the CloudMonitor agent is successfully installed on a host. Hosts that are not Alibaba Cloud instances do not have an instance ID, but have a serial number.'."\n" + ."\n" + .'> Use this parameter to find a specific monitored host.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'a1ab31a3-1234-40f2-9e95-c8caa8f0****'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- 10'."\n" + ."\n" + .'- 20'."\n" + ."\n" + .'- 50'."\n" + ."\n" + .'- 100'."\n" + ."\n" + .'> Alibaba Cloud does not limit the maximum value of this parameter. However, setting this parameter to a large value may cause a timeout.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0CCE0AF0-053C-4B13-A583-DC9A85785D49', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '12', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ + [ + 'name' => 'InstanceRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'AliyunHost', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to filter for Alibaba Cloud Elastic Compute Service (ECS) instances. Valid values:'."\n" + ."\n" + .'- true (default): Returns only ECS instances.'."\n" + ."\n" + .'- false: Returns only hosts that are not ECS instances.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the host. Valid values:'."\n" + ."\n" + .'- Running: The host is running.'."\n" + ."\n" + .'- Stopped: The host is stopped, the agent is not installed, or the agent installation failed.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Running'], + ], + [ + 'name' => 'SysomStatus', + 'in' => 'query', + 'schema' => ['description' => 'The status of SysOM. Valid values:'."\n" + ."\n" + .'- installing: SysOM is being enabled.'."\n" + ."\n" + .'- running: SysOM is running.'."\n" + ."\n" + .'- stopped: SysOM is stopped.'."\n" + ."\n" + .'- uninstalling: SysOM is being disabled.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'running'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates a successful response.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The Request is not authorization.'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'PageTotal' => ['description' => 'The number of pages.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '50'], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'Hosts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Resource' => [ - 'description' => 'The configuration of the metrics in the resources.'."\n", + 'Host' => [ + 'description' => 'The list of hosts.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The host.', 'type' => 'object', 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'CPUUtilization', - ], - 'Description' => [ - 'description' => 'The metric description.'."\n", - 'type' => 'string', - 'example' => 'CPUUtilization', - ], - 'Labels' => [ - 'description' => 'The tags of the metric, including one or more JSON strings.'."\n" - ."\n" - .'Format: `[{"name":"tag key","value":"tag value"}]`. The `name` can be repeated. The following tags are available:'."\n" - ."\n" - .'* metricCategory: the category of the metric.'."\n" - .'* alertEnable: indicates whether to report alerts for the metric.'."\n" - .'* alertUnit: the unit of the metric in the alerts.'."\n" - .'* unitFactor: the factor for metric unit conversion.'."\n" - .'* minAlertPeriod: the minimum interval at which the alert is reported.'."\n" - .'* productCategory: the category of the service.'."\n", - 'type' => 'string', - 'example' => '[{\\"name\\":\\"alertUnit\\",\\"value\\":\\"Bytes\\"},{\\"name\\":\\"minAlertPeriod\\",\\"value\\":\\"60\\"},{\\"name\\":\\"metricCategory\\",\\"value\\":\\"instanceId\\"},{\\"name\\":\\"instanceType\\",\\"value\\":\\"disaster\\"},{\\"name\\":\\"is_alarm\\",\\"value\\":\\"true\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"kvstore_old\\"}]', - ], - 'Unit' => [ - 'description' => 'The unit of the metric.'."\n", - 'type' => 'string', - 'example' => '%', - ], - 'Dimensions' => [ - 'description' => 'The monitoring dimensions of the resource. Multiple monitoring dimensions are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_kvstore', - ], - 'Periods' => [ - 'description' => 'The statistical periods of the metric. Multiple statistical periods are separated with commas (,).'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60,300', - ], - 'Statistics' => [ - 'description' => 'The statistical method. Multiple statistical methods are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => 'Average,Minimum,Maximum', - ], + 'SerialNumber' => ['description' => 'The serial number of the host. Hosts that are not Alibaba Cloud instances do not have an instance ID, but have a serial number.'."\n" + ."\n" + .'> Use this parameter to find a specific monitored host.', 'type' => 'string', 'title' => '', 'example' => 'x12335-6cc8-4a22-9f21-1a00a719****'], + 'NatIp' => ['description' => 'The NAT IP address.', 'type' => 'string', 'title' => '', 'example' => '192.168.XX.XX'], + 'HostName' => ['description' => 'The hostname.', 'type' => 'string', 'title' => '', 'example' => 'hostIP'], + 'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '103201326074****'], + 'NetworkType' => ['description' => 'The network type.', 'type' => 'string', 'title' => '', 'example' => 'vpc'], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'i-a2d5q7pm3f9yr212****'], + 'isAliyunHost' => ['description' => 'Indicates whether the host is an Alibaba Cloud instance. Valid values:'."\n" + ."\n" + .'- true: The host is an Alibaba Cloud instance.'."\n" + ."\n" + .'- false: The host is not an Alibaba Cloud instance.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EipAddress' => ['description' => 'The elastic IP address (EIP).', 'type' => 'string', 'title' => '', 'example' => '192.168.XX.XX'], + 'AgentVersion' => ['description' => 'The agent version.', 'type' => 'string', 'title' => '', 'example' => '3.4.6'], + 'IpGroup' => ['description' => 'The IP address of the host.'."\n" + ."\n" + .'> Multiple IP addresses are separated by commas (,).', 'type' => 'string', 'title' => '', 'example' => '192.168.XX.XX'], + 'EipId' => ['description' => 'The ID of the EIP.', 'type' => 'string', 'title' => '', 'example' => 'eip-bp16i16k9gcezyfrp****'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'InstanceTypeFamily' => ['description' => 'The ECS instance type family.', 'type' => 'string', 'title' => '', 'example' => 'ecs.n4'], + 'OperatingSystem' => ['description' => 'The operating system.', 'type' => 'string', 'title' => '', 'example' => 'Linux'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t\\t1853\\r\\n\\t\\tCDE9EAFF-D54E-4024-BBFC-B0AAC883143B\\r\\n\\t\\ttrue\\r\\n\\t\\t200\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t磁盘额定容量\\r\\n\\t\\t\\t\\tAverage,Minimum,Maximum\\r\\n\\t\\t\\t\\tads.diskSize\\r\\n\\t\\t\\t\\t[{\\\\\\"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\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,instanceId,tableSchema,workerId\\r\\n\\t\\t\\t\\tacs_ads\\r\\n\\t\\t\\t\\t300\\r\\n\\t\\t\\t\\tMB\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t磁盘已用容量\\r\\n\\t\\t\\t\\tAverage,Minimum,Maximum\\r\\n\\t\\t\\t\\tads.diskUsed\\r\\n\\t\\t\\t\\t[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Mbytes\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"workerId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,instanceId,tableSchema,workerId\\r\\n\\t\\t\\t\\tacs_ads\\r\\n\\t\\t\\t\\t300\\r\\n\\t\\t\\t\\tMB\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t磁盘使用率\\r\\n\\t\\t\\t\\tAverage,Minimum,Maximum\\r\\n\\t\\t\\t\\tads.diskUsedPercent\\r\\n\\t\\t\\t\\t[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"%\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"workerId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,instanceId,tableSchema,workerId\\r\\n\\t\\t\\t\\tacs_ads\\r\\n\\t\\t\\t\\t300\\r\\n\\t\\t\\t\\t%\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tqueue的未消费的消息数目\\r\\n\\t\\t\\t\\tMaximum\\r\\n\\t\\t\\t\\tQueueMessageAccumulation\\r\\n\\t\\t\\t\\t[{\\\\\\"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\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,regionId,vhostName,queueName\\r\\n\\t\\t\\t\\tacs_amqp\\r\\n\\t\\t\\t\\t60,300\\r\\n\\t\\t\\t\\tcount/min\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tqueue每分钟消息生产量\\r\\n\\t\\t\\t\\tValue\\r\\n\\t\\t\\t\\tQueueMessageInput\\r\\n\\t\\t\\t\\t[{\\\\\\"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\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,regionId,vhostName,queueName\\r\\n\\t\\t\\t\\tacs_amqp\\r\\n\\t\\t\\t\\t60,300\\r\\n\\t\\t\\t\\tcount/min\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tqueue的未消费的消息数目\\r\\n\\t\\t\\t\\tValue\\r\\n\\t\\t\\t\\tQueueMessageOutput\\r\\n\\t\\t\\t\\t[{\\\\\\"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\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,regionId,vhostName,queueName\\r\\n\\t\\t\\t\\tacs_amqp\\r\\n\\t\\t\\t\\t60,300\\r\\n\\t\\t\\t\\tcount/min\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t实例每分钟产生的消息数量\\r\\n\\t\\t\\t\\tValue\\r\\n\\t\\t\\t\\tVhostMessageInput\\r\\n\\t\\t\\t\\t[{\\\\\\"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\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,regionId,vhostName\\r\\n\\t\\t\\t\\tacs_amqp\\r\\n\\t\\t\\t\\t60,300\\r\\n\\t\\t\\t\\tcount/min\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t实例每分钟消费的消息数量\\r\\n\\t\\t\\t\\tValue\\r\\n\\t\\t\\t\\tVhostMessageOutput\\r\\n\\t\\t\\t\\t[{\\\\\\"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\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,regionId,vhostName\\r\\n\\t\\t\\t\\tacs_amqp\\r\\n\\t\\t\\t\\t60,300\\r\\n\\t\\t\\t\\tcount/min\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\tLatency\\r\\n\\t\\t\\t\\t[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"ms\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"instanceId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,region,apiUid\\r\\n\\t\\t\\t\\tacs_apigateway_dashboard\\r\\n\\t\\t\\t\\t60,300,900\\r\\n\\t\\t\\t\\tms\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t时间粒度内http返回码4XX占全部返回码的百分比\\r\\n\\t\\t\\t\\tAverage,Minimum,Maximum\\r\\n\\t\\t\\t\\tcode4xx\\r\\n\\t\\t\\t\\t[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"%\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"instanceId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\r\\n\\t\\t\\t\\tuserId,instanceId\\r\\n\\t\\t\\t\\tacs_cdn\\r\\n\\t\\t\\t\\t60,300\\r\\n\\t\\t\\t\\t%\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n","errorExample":""}]', - 'title' => 'DescribeMetricMetaList', - 'description' => 'This operation is used together with DescribeMetricList and DescribeMetricLast. For more information, see [DescribeMetricList](~~51936~~) and [DescribeMetricLast](~~51939~~).'."\n", + 'title' => 'DescribeMonitoringAgentHosts', + 'summary' => 'You can call the DescribeMonitoringAgentHosts operation to query a list of all hosts, regardless of whether the CloudMonitor agent is installed.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeProjectMeta' => [ - 'summary' => 'Queries the information about monitored services in CloudMonitor.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-05-25T09:45:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-29T02:45:43.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentHosts'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentHosts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMonitoringAgentProcesses' => [ + 'summary' => 'Call the DescribeMonitoringAgentProcesses operation to query the list of processes for a specified resource.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tags. Tags are used to filter services.'."\n" - ."\n" - .'You can filter services only by the tag whose `name` is `product`. Example: {"name":"product","value":"ECS"}.'."\n" - ."\n" - .'> We recommend that you do not use the special tags in the CloudMonitor console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"name":"product","value":"ECS"}]', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Valid values: 1 to 100.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Valid values: 1 to 10000.'."\n" - ."\n" - .'Default value: 30.'."\n" - ."\n" - .'> The value of this parameter is not limited. You can view a large number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-hp3hl3cx1pbahzy8****', 'title' => ''], ], ], 'responses' => [ @@ -19984,363 +17382,357 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C2061B2-3B1B-43BF-A4A4-C53426F479C0', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '5', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '12', - ], - 'Resources' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C11C0E85-6862-4F25-8D66-D6A5E0882984', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NodeProcesses' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Resource' => [ - 'description' => 'The details of the cloud service.'."\n", + 'NodeProcess' => [ + 'description' => 'The information about the processes.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace of the cloud service. Format: `acs_Service name abbreviation`. For more information about namespaces, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'acs_cdn', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'CDN', - ], - 'Labels' => [ - 'description' => 'The tags. Tags are used to filter services.'."\n" - ."\n" - .'Tags are returned in the following format: `[{"name":"Tag key","value":"Tag value"}, {"name":"Tag key","value":"Tag value"}]`. The following tags are commonly used:'."\n" - ."\n" - .'* alertUnit: the unit of the metric value in alerts. If the unit is small, the original metric value may be too large. In this case, you can use the `alertUnit` tag to specify an appropriate unit. This tag is used in CloudMonitor.'."\n" - .'* minAlertPeriod: the minimum time interval to report a new alert. The interval at which monitoring data is reported. The value is usually 1 minute.'."\n" - .'* metricCategory: the service specification. Example: kvstore_sharding. Some Alibaba Cloud services have multiple specifications that are defined in the same namespace. This parameter is used to identify the specifications.'."\n" - .'* is_alarm: indicates whether an alert rule can be configured. We recommend that you do not use the special tags in the CloudMonitor console.'."\n", - 'type' => 'string', - 'example' => '[{"groupFlag":true}]', - ], + 'ProcessName' => ['description' => 'The name of the process.', 'type' => 'string', 'example' => 'java', 'title' => ''], + 'ProcessId' => ['description' => 'The ID of the process.', 'type' => 'integer', 'format' => 'int64', 'example' => '4550102', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '239708487', 'title' => ''], + 'Command' => ['description' => 'The command.', 'type' => 'string', 'example' => '/bin/sh', 'title' => ''], + 'ProcessUser' => ['description' => 'The user that runs the process.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'host-gdsmvinvmh6fu', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeMonitoringAgentProcesses', + 'description' => '> Before you call this operation, you must call the CreateMonitoringAgentProcess operation to create a process monitoring task. For more information, see [CreateMonitoringAgentProcess](~~2513212~~).'."\n" + ."\n" + .'This topic provides an example of how to query the list of processes for the resource i-hp3hl3cx1pbahzy8\\*\\*\\*\\*. The response shows the details of the Nginx and HTTP processes.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentProcesses'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentProcesses', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t\\t1\\r\\n\\t\\t5\\r\\n\\t\\t4C2061B2-3B1B-43BF-A4A4-C53426F479C0\\r\\n\\t\\ttrue\\r\\n\\t\\t200\\r\\n\\t\\t12\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t分析型数据库\\r\\n\\t\\t\\t\\t[{\\"name\\":\\"product\\",\\"value\\":\\"ADS\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"ads\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]\\r\\n\\t\\t\\t\\tacs_ads\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t智能推荐\\r\\n\\t\\t\\t\\t[{\\"name\\":\\"product\\",\\"value\\":\\"AIRec\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"airec\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]\\r\\n\\t\\t\\t\\tacs_airec\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tAPI网关\\r\\n\\t\\t\\t\\t[{\\"name\\":\\"product\\",\\"value\\":\\"APIGateway\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"apigateway\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]\\r\\n\\t\\t\\t\\tacs_apigateway_dashboard\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCDN\\r\\n\\t\\t\\t\\t[{\\"name\\":\\"product\\",\\"value\\":\\"CDN\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"cdn\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]\\r\\n\\t\\t\\t\\tacs_cdn\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t云企业网\\r\\n\\t\\t\\t\\t[{\\"name\\":\\"product\\",\\"value\\":\\"CEN\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"cen,cen_flow,cen_vbr\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]\\r\\n\\t\\t\\t\\tacs_cen\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\r\\n","errorExample":""}]', - 'title' => 'DescribeProjectMeta', - 'description' => 'The information obtained by this operation includes the service description, namespace, and tags.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + '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"}]', 'extraInfo' => ' ', ], - 'DeleteExporterOutput' => [ - 'summary' => 'Deletes a configuration set that is used to export monitoring data.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMonitoringAgentStatuses' => [ + 'summary' => 'Queries the running status of the CloudMonitor agent by calling the DescribeMonitoringAgentStatuses operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DestName', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration set.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testName', - ], + 'schema' => ['description' => 'The instance IDs. Separate multiple instance IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'i-hp3dunahluwajv6f****', 'title' => ''], + ], + [ + 'name' => 'HostAvailabilityTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the availability monitoring task.'."\n", 'type' => 'string', 'required' => false, 'example' => '126****', 'title' => ''], ], ], '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. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2DECF751-7AFA-43BB-8C63-2B6B07E51AE1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + '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', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'i-hp3dunahluwajv6f****', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], + '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', 'title' => ''], + 'OsMonitorVersion' => ['description' => 'The SysOM version.'."\n", 'type' => 'string', 'example' => '1.3.0-12', 'title' => ''], + '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}', 'title' => ''], + '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', 'title' => ''], + 'LoongCollectorVersion' => ['description' => 'LoongCollector Version', 'type' => 'string', 'example' => '0.1.0', 'title' => ''], + 'LoongCollectorStatus' => [ + 'description' => 'LoongCollector Status', + 'enumValueTitles' => ['running' => 'Normal', 'stopped' => 'Stopped'], + 'type' => 'string', + 'example' => 'running', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"success\\n296AE90D-153C-4612-AF24-75D0F5921976\\n200\\ntrue","errorExample":""}]', - 'title' => 'DeleteExporterOutput', - 'requestParamsDescription' => ' ', + 'title' => 'Query the running status of the CloudMonitor agent', + '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' => ' ', - ], - 'DeleteExporterRule' => [ - 'summary' => 'Deletes a data export rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-11-24T04:01:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-19T08:42:03.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-05-04T09:06:41.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-29T02:45:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentStatuses', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeMonitoringConfig' => [ + 'summary' => 'Queries the global configurations of the CloudMonitor agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data export rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'myRuleName', - ], - ], - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D023', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F35654DB-0C9D-4FB3-903F-479BA7663061', 'title' => ''], + 'AutoInstall' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableInstallAgentNewECS' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed on new ECS instances. Valid values: Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"success\\n8B524AE2-FBB1-4202-AA17-B3DEAAC8D861\\n200\\ntrue","errorExample":""}]', - 'title' => 'DeleteExporterRule', + 'title' => 'DescribeMonitoringConfig', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeExporterOutputList' => [ - 'summary' => 'Queries configuration sets that are used to export monitoring data.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringConfig'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeProductResourceTagKeyList' => [ + 'summary' => 'Call the DescribeProductResourceTagKeyList operation to query all tag keys of cloud resources in a specified region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - 'default' => '1000', - ], + 'schema' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'dbc2826f237e****', 'title' => ''], ], ], 'responses' => [ @@ -20348,533 +17740,336 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Datapoints' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'NextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'example' => 'dbc2826f237e****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '945ACAA9-89F2-4A62-8913-076FDEDAA8DB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TagKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Datapoint' => [ - 'description' => 'The configuration sets for exporting monitoring data.'."\n", + 'TagKey' => [ + 'description' => 'The tag keys.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ConfigJson' => [ - 'description' => 'The JSON object that contains the details about the destination to which the monitoring data is exported.'."\n", - 'type' => 'object', - 'properties' => [ - 'ak' => [ - 'description' => 'The AccessKey ID.'."\n", - 'type' => 'string', - 'example' => 'LTAIpY33********', - ], - 'endpoint' => [ - 'description' => 'The Log Service endpoint to which the monitoring data is exported.'."\n", - 'type' => 'string', - 'example' => 'http://cn-qingdao-share.log.aliyuncs.com', - ], - 'logstore' => [ - 'description' => 'The Logstore.'."\n", - 'type' => 'string', - 'example' => 'monitorlogstore', - ], - 'project' => [ - 'description' => 'The Log Service project to which the monitoring data is exported.'."\n", - 'type' => 'string', - 'example' => 'exporter', - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The time when the configuration set was created. The value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1584016495498', - ], - 'DestName' => [ - 'description' => 'The name of the configuration set.'."\n", - 'type' => 'string', - 'example' => 'exporterOut', - ], - 'DestType' => [ - 'description' => 'The service to which the monitoring data is exported.'."\n" - ."\n" - .'> Only Log Service is supported. More services will be supported in the future.'."\n", - 'type' => 'string', - 'example' => 'SLS', - ], - ], - ], + 'items' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tag_******', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'sucess', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0E657631-CD6C-4C24-9637-98D000B9272C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeProductResourceTagKeyList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProductResourceTagKeyList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeProductResourceTagKeyList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"BB30C6D9-8D0D-442E-9484-C15BADE76A21\\n1\\n1\\n\\n \\n SLS\\n desctName1\\n 1584016495498\\n \\n http://cn-qingdao-share.log.aliyuncs.com\\n TxHwuJ8yAb3AULcnny******\\n exporter\\n LTAIpY33********\\n exporter\\n \\n \\n\\n200\\ntrue","errorExample":""}]', - 'title' => 'DescribeExporterOutputList', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + '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"}]', 'extraInfo' => ' ', ], - 'DescribeExporterRuleList' => [ - 'summary' => 'Queries data export rules.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeProductsOfActiveMetricRule' => [ + 'summary' => 'Queries the cloud services for which the initiative alert feature is enabled.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1000', - 'default' => '1000', - ], - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Datapoints' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', 'title' => ''], + 'Datapoints' => ['description' => 'The information about the services for which the initiative alert feature is enabled. Services are separated with commas (,). Valid values:'."\n" + ."\n" + .'- ECS: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)'."\n" + ."\n" + .'- redis\\_standard: Redis Open-Source Edition (standard architecture)'."\n" + ."\n" + .'- redis\\_sharding: Redis Open-Source Edition (cluster architecture)'."\n" + ."\n" + .'- redis\\_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" + ."\n" + .'- mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" + ."\n" + .'- mongodb\\_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" + ."\n" + .'- hbase: ApsaraDB for HBase'."\n" + ."\n" + .'- elasticsearch: Elasticsearch'."\n" + ."\n" + .'- opensearch: OpenSearch', 'type' => 'string', 'example' => 'ecs,rds', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AllProductInitMetricRuleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Datapoint' => [ - 'description' => 'The details of the data export rules.'."\n", + 'AllProductInitMetricRule' => [ + 'description' => 'The information about the services for which one-click alert is enabled.', 'type' => 'array', 'items' => [ + 'description' => 'The information about the services for which one-click alert is enabled.', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the rule was created. The value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1584024616228', - ], - 'Describe' => [ - 'description' => 'The description of the rule.'."\n", - 'type' => 'string', - 'example' => 'Export monitoring data'."\n", - ], - 'Dimension' => [ - 'description' => 'The associated dimensions.'."\n", - 'type' => 'string', - 'example' => '{"instanceId":"xxxxx"}', - ], - 'DstName' => [ + 'Product' => ['description' => 'The abbreviation of the service name.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'AlertInitConfigList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DstName' => [ + 'AlertInitConfig' => [ + 'description' => 'The initial alert rules that are generated after one-click alert is enabled for a service.', 'type' => 'array', 'items' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* `true`: The call is successful.'."\n" - .'* `false`: The call fails.'."\n", - 'type' => 'string', - 'example' => 'exporter1', + 'description' => 'The initial alert rules that are generated after one-click alert is enabled for a service.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'EvaluationCount' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the service. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'acs_rds_dashboard', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The method used to calculate metric values that trigger alerts. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of monitoring data. Unit: minutes. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => '1m', 'title' => ''], + 'Level' => [ + 'description' => 'The alert level.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- INFO'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['INFO' => '', 'WARN' => '', 'CRITICAL' => ''], + 'type' => 'string', + 'example' => 'CRITICAL', + 'title' => '', + ], + 'ComparisonOperator' => [ + 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: does not equal to the threshold'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', + 'enumValueTitles' => [ + 'LessThanThreshold' => '', 'GreaterThanLastWeek' => '', 'LessThanOrEqualToThreshold' => '', 'NotEqualToThreshold' => '', 'GreaterThanLastPeriod' => '', 'GreaterThanYesterday' => '', 'LessThanYesterday' => '', 'LessThanLastWeek' => '', 'GreaterThanOrEqualToThreshold' => '', 'GreaterThanThreshold' => '', + 'LessThanLastPeriod' => '', + ], + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'Enabled' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MetricName' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'> For more information, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~28619~~).'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Namespace' => [ - 'description' => 'The namespace of the service.'."\n" - ."\n" - .'> For more information, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~28619~~).'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'RuleName' => [ - 'description' => 'The name of the data export rule.'."\n", - 'type' => 'string', - 'example' => 'myRuleName', - ], - 'TargetWindows' => [ - 'description' => 'The time window of the exported data.\\'."\n" - .'Multiple windows are separated with commas (,).'."\n" - ."\n" - .'> Data in a time window of less than 60 seconds cannot be exported.'."\n", - 'type' => 'string', - 'example' => '60,300', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'susscess', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6BA047CA-8BC6-40BC-BC8F-FBECF35F1993', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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' => 'DescribeExporterRuleList', + 'title' => 'DescribeProductsOfActiveMetricRule', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricTop' => [ - 'summary' => 'Queries the latest monitoring data of a metric for a cloud service. The data can be sorted by a specified order.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-25T07:41:17.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProductsOfActiveMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeProductsOfActiveMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeProjectMeta' => [ + 'summary' => 'Calls the DescribeProjectMeta operation to query the list of cloud services that support time series monitoring metrics in CloudMonitor.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Period', + 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Valid values: 15, 60, 900, and 3600.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.'."\n" - ."\n" - .'* Statistical periods vary based on the metrics that are specified by `MetricName`. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The tags. Tags are used to filter alerts, and each alert can be marked with special tags.'."\n" + ."\n" + .'Currently, only filtering by product is supported. That is, the `name` is `product`. For example: {"name":"product","value":"ECS"}.'."\n" + .'>We do not recommend that you use the special tags for the CloudMonitor console in Alibaba Cloud.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"name":"product","value":"ECS"}]', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about metric names, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_idle', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query monitoring data.'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.``'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.````'."\n" - ."\n" - .' * If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" - ."\n" - .'The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* Time format: YYYY-MM-DDThh:mm:ssZ'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You must set the `StartTime` parameter to a point in time that is later than 00:00:00 Thursday, January 1, 1970. Otherwise, this parameter is invalid.'."\n" - ."\n" - .'* We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-05-08 08:00:00', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query monitoring data.'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.``'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.````'."\n" - ."\n" - .' * If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" - ."\n" - .'The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* Time format: YYYY-MM-DDThh:mm:ssZ'."\n" - ."\n" - .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-05-08 10:00:00', - ], - ], - [ - 'name' => 'Dimensions', - 'in' => 'query', - 'schema' => [ - 'description' => 'The monitoring dimensions of the specified resource.'."\n" - ."\n" - .'Set the value to a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` or `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> You can query a maximum of 50 instances in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId": "i-abcdefgh12****"}]', - ], - ], - [ - 'name' => 'Orderby', - 'in' => 'query', - 'schema' => [ - 'description' => 'The field based on which data is sorted. Valid values:'."\n" - ."\n" - .'* Average'."\n" - .'* Minimum'."\n" - .'* Maximum'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Average', - ], - ], - [ - 'name' => 'OrderDesc', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which data is sorted. Valid values:'."\n" - ."\n" - .'* True: sorts data in ascending order.'."\n" - .'* False (default): sorts data in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'False', - ], - ], - [ - 'name' => 'Length', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 10.'."\n" - ."\n" - .'> The maximum value of the Length parameter in a request is 1440.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Express', - 'in' => 'query', - 'schema' => [ - 'description' => 'The expression that is used to compute the query results in real time.'."\n" - ."\n" - .'> Only the `groupby` expression is supported. This expression is similar to the GROUP BY statement used in databases.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 10000.'."\n" + ."\n" + .'Default value: 30.'."\n" + ."\n" + .'>Currently, Alibaba Cloud does not impose a limit on this parameter. If you need to obtain all results, set the page size to a large value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ @@ -20882,156 +18077,133 @@ 'schema' => [ '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' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', - ], - 'Datapoints' => [ - 'description' => 'The monitoring data.'."\n", - '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' => 'The statistical period of the monitoring data. Unit: seconds. Valid values: 15, 60, 900, and 3600.'."\n", - 'type' => 'string', - 'example' => '60', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C2061B2-3B1B-43BF-A4A4-C53426F479C0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: true and false. The value true indicates success, and the value false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '12', 'title' => ''], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The information about the cloud service.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The namespace that is used to distinguish products. Format: `acs_Service abbreviation`. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'acs_cdn', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'CDN', 'title' => ''], + 'Labels' => ['description' => 'The tags. Tags are used to filter alerts, and each alert can be marked with special tags.'."\n" + ."\n" + .'For example, the tags indicate the specification of the product to which the alert belongs, and whether the alert can be set. Format: `[{"name":"Tag name","value":"Tag value"}、{"name":"Tag name","value":"Tag value"}]​`. The following common tags are supported:'."\n" + ."\n" + .'- alertUnit: the unit of the alert.'."\n" + .' To prevent the unit of the original reported data from being too small, which causes the value entered in an alert rule to be too large, the `alertUnit` tag is added. Currently, this tag is mainly applied to the CloudMonitor console.'."\n" + ."\n" + .'- minAlertPeriod: the minimum reporting period. The time interval at which monitoring data is reported. The default value is 1 minute.'."\n" + ."\n" + .'- metricCategory: the specification of the product. For example, kvstore_sharding.'."\n" + .' Some Alibaba Cloud products have different specifications that are defined in the same namespace, and this parameter is used to distinguish them.'."\n" + ."\n" + .'- is_alarm: indicates whether alert rules can be set.'."\n" + .' We do not recommend that you use the special tags for the CloudMonitor console in Alibaba Cloud.'."\n" + ."\n", 'type' => 'string', 'example' => '[{"metricCategory":ecs}]', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t18DC44ED-B058-49B0-9D49-1D6608328E4D\\r\\n\\t60\\r\\n\\t[{\\\\\\"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}]\\r\\n\\t200\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeMetricTop', - 'description' => '### [](#)Limits'."\n" - ."\n" - .'* The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. After the free quota is used up, you are charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" - .'* Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" - ."\n" - .'### [](#)Precautions'."\n" - ."\n" - .'The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:'."\n" - ."\n" - .'* The storage duration is 7 days if the value of the `Period` parameter is less than 60 seconds.'."\n" - .'* The storage duration is 31 days if the value of the `Period` parameter is 60 seconds.'."\n" - .'* The storage duration is 91 days if the value of the `Period` is greater than or equal to 300 seconds.'."\n" - ."\n" - .'### [](#)Operation description'."\n" - ."\n" - .'This topic provides an example on how to query the monitoring data of the `cpu_idle` metric in the last 60 seconds for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The monitoring data is sorted in descending order based on the `Average` field.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Queries the list of cloud services that support time series monitoring metrics in CloudMonitor', + 'description' => 'Obtains the information about the connected cloud services, including the description, namespace, and tags of each service.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutExporterOutput' => [ - 'summary' => 'Creates or modifies a configuration set for exporting monitoring data.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProjectMeta'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeSiteInstantMonitorLog' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], 'parameters' => [ [ - 'name' => 'DestName', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration set.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'exporterConfig', - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ - 'name' => 'ConfigJson', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration set for exporting monitoring data. It is a JSON object string. The string must include the following fields:'."\n" - ."\n" - .'* endpoint: the endpoint of Log Service.'."\n" - .'* project: the Log Service project to which monitoring data is exported.'."\n" - .'* logstore: the Log Service Logstore to which the monitoring data is exported.'."\n" - .'* ak: the AccessKey ID.'."\n" - .'* as: the AccessKey secret.'."\n", - '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******"}', - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'Desc', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the configuration set.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Export CPU metrics'."\n", - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'DestType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The service to which the monitoring data is exported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'sls', - ], + '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], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -21039,10024 +18211,2795 @@ 'schema' => [ '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 returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'NextToken' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t\\tE5DC60DD-2FDE-488F-942C-424FA3E18BF8\\n\\t\\t200\\n\\t\\ttrue\\n","errorExample":""}]', - 'title' => 'PutExporterOutput', - 'description' => '> The monitoring data can be exported only to Log Service. More services will be supported in the future.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PutExporterRule' => [ - 'summary' => 'Creates or modifies a data export rule.', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2021-12-01T09:57:02.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n}","type":"json"}]', + ], + 'DescribeSiteMonitorAttribute' => [ + 'summary' => 'Queries the details of a site monitoring task by calling the DescribeSiteMonitorAttribute operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the rule.'."\n" - ."\n" - .'> If the specified rule exists, the existing rule is modified. Otherwise, a rule is created.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'MyRuleName', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'> For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'TargetWindows', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time window of the exported data. Unit: seconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* Separate multiple time windows with commas (,).'."\n" - ."\n" - .'* Data in a time window of less than 60 seconds cannot be exported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '60,300', - ], + 'schema' => ['description' => 'The ID of the monitoring task.', 'type' => 'string', 'required' => true, 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', 'title' => ''], ], [ - 'name' => 'Describe', + 'name' => 'IncludeAlert', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the data export rule.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Export CPU metrics'."\n", - ], + 'schema' => ['description' => 'Specifies whether the returned task details include alert rules.'."\n" + ."\n" + .'- true: Alert rules are returned.'."\n" + .'- false (default): Alert rules are not returned.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - [ - 'name' => 'DstNames', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The destination to which the data is exported. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => 'distName1', - 'maxItems' => 20, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - '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 returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\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' => 'PutExporterRule', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeAlertHistoryList' => [ - 'summary' => 'Queries historical alerts.', - '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' => 'The ID of the alert rule.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'For information about how to query the name of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Rule', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For information about how to query the namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For information about how to query the name of a metric, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7671****', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether alerts are muted. Valid values:'."\n" - ."\n" - .'* 2 (default value): Alerts are muted and are not triggered within the mute period, even if the condition specified in the alert rule is met.'."\n" - .'* 0: Alerts are triggered or cleared.'."\n" - .'* 1: The alert rule is ineffective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'State', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* ALARM (default value): Alerts are triggered.'."\n" - .'* OK: No alerts are triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALARM', - ], - ], - [ - 'name' => 'Ascending', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order of alerts. Valid values:'."\n" - ."\n" - .'* true (default value): reverse chronological order'."\n" - .'* false: chronological order'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp of the historical alerts that you want to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640237400000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp of the historical alerts that you want to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640608200000', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Page', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlarmHistoryList' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'MetricRules' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AlarmHistory' => [ - 'description' => 'The details of historical alerts.'."\n", + 'MetricRule' => [ + 'description' => 'The alert rules of the monitoring task.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The alert rules of the monitoring task.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether alerts are muted. Valid values:'."\n" - ."\n" - .'* 2 (default): Alerts are muted and are not triggered within the mute period, even if the condition specified in the alert rule is met.'."\n" - .'* 0: Alerts are triggered or cleared.'."\n" - .'* 1: The alert rule is ineffective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', + 'ActionEnable' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'AlarmActions' => ['description' => 'The alert contact group to which alert notifications are sent.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator used in the alert rule. Valid values:'."\n" + ."\n" + .'- `>=`'."\n" + .'- `>`'."\n" + .'- `<=`'."\n" + .'- `<`'."\n" + .'- `=`'."\n" + .'- `!=`'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'example' => 'GreaterThanYesterday', 'title' => ''], + 'Dimensions' => ['description' => 'The dimensions associated with the alert rule.', 'type' => 'string', 'example' => '[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]', 'title' => ''], + 'EvaluationCount' => ['description' => 'The number of alert retries.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Expression' => ['description' => 'The expression of the alert rule.', 'type' => 'string', 'example' => '$Availability=30', 'title' => ''], + 'Level' => ['description' => 'The severity level of the alert rule. Valid values:'."\n" + ."\n" + .'- 1: Critical.'."\n" + ."\n" + .'- 2: Warning.'."\n" + ."\n" + .'- 3: Information.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'Availability', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_networkmonitor', 'title' => ''], + 'OkActions' => ['description' => 'The alert contact group that receives alert notifications.', 'type' => 'string', 'example' => '[ "CloudMonitor"]', 'title' => ''], + 'Period' => ['description' => 'The time interval, which is typically the reporting period of the metric. Unit: seconds.'."\n" + ."\n" + .'>If you set a statistical period, data is queried based on the specified period.', 'type' => 'string', 'example' => '15s', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'bf071ae_7b7aec3817b0fdf****', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'rule1', 'title' => ''], + 'StateValue' => ['description' => 'The alert status. Valid values:'."\n" + ."\n" + .'- OK: Normal.'."\n" + ."\n" + .'- ALARM: Alerting.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method used for alerting. Valid values:'."\n" + ."\n" + .'- Availability: the percentage of available detection points.'."\n" + .'- AvailableNumber: the number of available detection points.'."\n" + .'- ErrorCodeMaximum: any status code (independent alert).'."\n" + .'- ErrorCodeMinimum: all status codes (combined alert).'."\n" + .'- Average: response time.', 'type' => 'string', 'example' => 'Availability', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D17DF650-7EBD-54D0-903A-1D4E624D7402', 'title' => ''], + 'SiteMonitors' => [ + 'description' => 'The details of the monitoring task.', + 'type' => 'object', + 'properties' => [ + 'Address' => ['description' => 'The monitored address of the monitoring task.', 'type' => 'string', 'example' => 'https://aliyun.com', 'title' => ''], + 'AgentGroup' => ['description' => 'The type of detection point. Default value: PC.'."\n" + .'Valid values:'."\n" + ."\n" + .'- PC: wired network.'."\n" + ."\n" + .'- MOBILE: mobile network.', 'type' => 'string', 'example' => 'PC', 'title' => ''], + 'CustomSchedule' => [ + 'description' => 'The custom monitoring schedule. You can select a time range from Monday to Sunday for monitoring.', + 'type' => 'object', + 'properties' => [ + 'days' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'days' => [ + 'description' => 'The monitoring day.', + 'type' => 'array', + 'items' => ['description' => 'The monitoring day.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'end_hour' => ['description' => 'The custom monitoring end time.'."\n" + ."\n" + .'Unit: hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '18', 'title' => ''], + 'start_hour' => ['description' => 'The custom monitoring start time.'."\n" + ."\n" + .'Unit: hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'time_zone' => ['description' => 'The time zone for custom monitoring.', 'type' => 'string', 'example' => 'local', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Interval' => ['description' => 'The monitoring interval. Unit: minutes. Valid values: 1, 5, 15, 30, and 60.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IspCities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IspCity' => [ + 'description' => 'The carrier and city of the detection point.', + 'type' => 'array', + 'items' => [ + 'description' => 'The carrier and city of the detection point.', + 'type' => 'object', + 'properties' => [ + 'City' => ['description' => 'The city ID.', 'type' => 'string', 'example' => '738', 'title' => ''], + 'CityName' => ['description' => 'The city name.', 'type' => 'string', 'example' => '北京市', 'title' => ''], + 'Isp' => ['description' => 'The carrier ID.', 'type' => 'string', 'example' => '465', 'title' => ''], + 'IspName' => ['description' => 'The carrier name.', 'type' => 'string', 'example' => '阿里巴巴', 'title' => ''], + 'Type' => ['description' => 'The network type of the detection point. Valid values:'."\n" + .'IDC: IDC data center.'."\n" + .'LASTMILE: residential broadband.'."\n" + .'MOBILE: mobile cellular network.', 'type' => 'string', 'example' => 'IDC', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'EvaluationCount' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'OptionJson' => [ + 'description' => 'The extended options. Each monitoring type has different extended options. For more information, see [CreateSiteMonitor](~~115048~~).', + 'type' => 'object', + 'properties' => [ + 'assertions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'assertions' => [ + 'description' => 'The assertion configuration group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The assertion configuration group.', + 'type' => 'object', + 'properties' => [ + 'operator' => ['description' => 'The assertion comparison operator. Valid values:'."\n" + .'- contains: Contains.'."\n" + .'- doesNotContain: Does not contain.'."\n" + .'- matches: Matches a regular expression.'."\n" + .'- doesNotMatch: Does not match a regular expression.'."\n" + .'- is: Equals a numeric value or matches a string.'."\n" + .'- isNot: Does not equal.'."\n" + .'- lessThan: Less than.'."\n" + .'- moreThan: Greater than.', 'type' => 'string', 'example' => 'lessThan', 'title' => ''], + 'property' => ['description' => 'The parsing path for the assertion content.'."\n" + ."\n" + .'- If the assertion type is `body_json`, the path is a `json path`.'."\n" + ."\n" + .'- If the assertion type is `body_xml`, the path is an `xml path`.', 'type' => 'string', 'example' => 'json path', 'title' => ''], + 'target' => ['description' => 'The target value or string for assertion comparison.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'type' => ['description' => 'The assertion type. Valid values:'."\n" + .'- response_time: Checks whether the response time meets expectations.'."\n" + .'- status_code: Checks whether the HTTP response status code meets expectations.'."\n" + .'- header: Checks whether a field in the response header meets expectations.'."\n" + .'- body_text: Checks whether the response body content meets expectations through text matching.'."\n" + .'- body_json: Checks whether the response body content meets expectations through JSON parsing (JSON Path).'."\n" + .'- body_xml: Checks whether the response body content meets expectations through XML parsing (XPath).', 'type' => 'string', 'example' => 'response_time', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'State' => [ - 'description' => 'The alert status. Valid values:'."\n" - ."\n" - .'* ALARM: Alerts are triggered.'."\n" - .'* OK: No alerts are triggered.'."\n", - 'type' => 'string', - 'example' => 'ALARM', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'Webhooks' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'ECS_Rule', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', - ], - 'LastTime' => [ - 'description' => 'The duration of the alert. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '360133', - ], - 'Value' => [ - 'description' => 'The threshold of the metric value to trigger or clear an alert.'."\n", - 'type' => 'string', - 'example' => '10.58', - ], - 'Expression' => [ - 'description' => 'The expression that is used to trigger alerts.'."\n", - 'type' => 'string', - 'example' => '$Average>=10', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'attempts' => ['description' => 'The number of retries after a DNS failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'auth_info' => [ + 'description' => 'The authentication information.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The authentication type. HTTP Basic Authentication is supported. Valid values: basic.', 'type' => 'string', 'example' => 'basic', 'title' => ''], + 'username' => ['description' => 'The username used for HTTP Basic Authentication.', 'type' => 'string', 'example' => 'test_username', 'title' => ''], + 'password' => ['description' => 'The password used for HTTP Basic Authentication.', 'type' => 'string', 'example' => 'test_password', 'title' => ''], + 'use_cookie_session_key' => ['description' => 'Specifies whether the key is stored in the client cookie for digest authentication.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'grant_type' => ['description' => 'The grant type used in OAuth 2.0 authentication. Valid values: client_credentials and password.', 'type' => 'string', 'example' => 'password', 'title' => ''], + 'client_id' => ['description' => 'The client ID used for client authentication in OAuth 2.0.', 'type' => 'string', 'example' => 'client_id', 'title' => ''], + 'client_secret' => ['description' => 'The client secret used for client authentication in OAuth 2.0.', 'type' => 'string', 'example' => 'client_secret', 'title' => ''], + 'scopes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'scopes' => [ + 'description' => 'The permission scopes requested in OAuth 2.0.', + 'type' => 'array', + 'items' => ['description' => 'A single permission scope requested in OAuth 2.0.', 'type' => 'string', 'example' => 'test_operation', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'token_url' => ['description' => 'The authorization server URL in OAuth 2.0.', 'type' => 'string', 'example' => 'https://www.example.com', 'title' => ''], + 'auth_style' => ['description' => 'The OAuth 2.0 authentication style. Valid values: ROA and RPC.', 'type' => 'string', 'example' => 'ROA', 'title' => ''], + 'access_key_id' => ['description' => 'Supported only in multi-step monitoring. The AccessKey ID used for Alibaba Cloud authentication. We recommend that you use encrypted storage.', 'type' => 'string', 'example' => 'testAk', 'title' => ''], + 'access_key_secret' => ['description' => 'Supported only in multi-step monitoring. The AccessKey secret used for Alibaba Cloud authentication. We recommend that you use encrypted storage.', 'type' => 'string', 'example' => 'testSk', 'title' => ''], + 'region_id' => ['description' => 'Supported only in multi-step monitoring. The region ID of the request when using Alibaba Cloud authentication.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'api_action' => ['description' => 'Supported only in multi-step monitoring. The API action of the request when using Alibaba Cloud operations.', 'type' => 'string', 'example' => 'example_api', 'title' => ''], + 'api_version' => ['description' => 'Supported only in multi-step monitoring. The API version of the request when using Alibaba Cloud operations.', 'type' => 'string', 'example' => '2019-01-01', 'title' => ''], + 'with_addon_resources' => ['description' => 'Supported only in multi-step monitoring. Specifies whether additional resources exist when using Alibaba Cloud authentication for this step.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'service_name' => ['description' => 'The service name of the request when using AWS authentication.', 'type' => 'string', 'example' => 'example_service_name', 'title' => ''], + 'session_token' => ['description' => 'The session token used for AWS authentication.', 'type' => 'string', 'example' => 'example_token', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'blocked_url_list' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'blocked_url_list' => [ + 'description' => 'The list of blocked resource URLs. Path wildcards are supported.', + 'type' => 'array', + 'items' => ['description' => 'The list of blocked resource URLs. Path wildcards are supported.', 'type' => 'string', 'example' => 'www.taobao.com/**', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '7671****', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'browser_headers' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_headers' => [ + 'description' => 'The custom headers. The structure is `{"key": "somekey", "value":"somevalue"}`.', + 'type' => 'array', + 'items' => ['description' => 'The custom headers. The structure is `{"key": "somekey", "value":"somevalue"}`.', 'type' => 'object', 'example' => '{"key":"value"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'AlertTime' => [ - 'description' => 'The timestamp when the alert was triggered. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640586600000', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'browser_hosts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_hosts' => [ + 'description' => 'The custom hosts. The structure is `{"url":"someurl", "ip":"someip"}`.', + 'type' => 'array', + 'items' => ['description' => 'The custom hosts. The structure is `{"url":"someurl", "ip":"someip"}`.', 'type' => 'string', 'example' => '{"url":"www.taobao.com","ip":"127.0.0.1"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'i-bp1cqhiw1za2****', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'browser_info' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_info' => [ + 'description' => 'The browser information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The browser information.', + 'type' => 'object', + 'properties' => [ + 'browser' => ['description' => 'The type of the browser.', 'type' => 'string', 'example' => 'Chrome', 'title' => ''], + 'device' => ['description' => 'The screen type.', 'type' => 'string', 'example' => 'laptop', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'Dimensions' => [ - 'description' => 'The resources that are monitored.'."\n", - 'type' => 'string', - 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'browser_insecure' => ['description' => 'Specifies whether to ignore certificate errors. Valid values:'."\n" + ."\n" + .'- false: Does not ignore certificate errors.'."\n" + .'- true: Ignores certificate errors.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'browser_task_version' => ['description' => 'The browser monitoring version. Valid values:'."\n" + ."\n" + .'- 1: Single-page monitoring.'."\n" + .'- 2: Multi-page monitoring.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'cookie' => ['description' => 'The cookie for the HTTP request.', 'type' => 'string', 'example' => 'lang=en', 'title' => ''], + 'diagnosis_mtr' => ['description' => 'Specifies whether to enable automatic MTR network diagnostics after a task failure. Valid values:'."\n" + .'- false: Disabled.'."\n" + .'- true: Enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'diagnosis_ping' => ['description' => 'Specifies whether to enable automatic PING network latency detection after a task failure. Valid values:'."\n" + .'- false: Disabled.'."\n" + .'- true: Enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'dns_hijack_whitelist' => ['description' => 'The DNS hijacking configuration list.', 'type' => 'string', 'example' => 'www.taobao.com:www.taobao.com.danuoyi.tbcache.com', 'title' => ''], + 'dns_match_rule' => ['description' => 'The DNS matching rule. Valid values:'."\n" + ."\n" + .'- IN_DNS: The expected aliases or IP addresses are all included in the DNS response.'."\n" + .'- DNS_IN: All DNS responses are included in the expected aliases or IP addresses.'."\n" + .'- EQUAL: The DNS response exactly matches the expected aliases or IP addresses.'."\n" + .'- ANY: The DNS response and the expected aliases or IP addresses have an intersection.', 'type' => 'string', 'example' => 'IN_DNS', 'title' => ''], + 'dns_server' => ['description' => 'The IP address of the DNS server.'."\n" + ."\n" + .'> This parameter applies only to the DNS monitoring type.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'dns_type' => ['description' => 'The DNS resolution type. This parameter applies only to the DNS monitoring type. Valid values:'."\n" + .'- A: Specifies the IP address corresponding to a hostname or domain name.'."\n" + .'- CNAME: Maps multiple domain names to another domain name.'."\n" + .'- NS: Specifies the DNS server that resolves a domain name.'."\n" + .'- MX: Points a domain name to a mail server address.'."\n" + .'- TXT: A description of the hostname or domain name. The text length is limited to 512 bytes and is typically used for SPF (Sender Policy Framework) records for anti-spam purposes.', 'type' => 'string', 'example' => 'A', 'title' => ''], + 'empty_message' => ['description' => 'Specifies whether the WebSocket task is allowed to return no message or an empty message. Valid values:'."\n" + .'- false (default): Not allowed.'."\n" + .'- true: Allowed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'expect_exist_string' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'expect_exist_string' => [ + 'description' => 'The list of strings expected to exist on the page.', + 'type' => 'array', + 'items' => ['description' => 'The list of strings expected to exist on the page.', 'type' => 'string', 'example' => 'expected string', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'Level' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'example' => 'P4', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'expect_non_exist_string' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'expect_non_exist_string' => [ + 'description' => 'The list of strings expected not to exist on the page.', + 'type' => 'array', + 'items' => ['description' => 'The list of strings expected not to exist on the page.', 'type' => 'string', 'example' => 'unexpected string', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'Contacts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Contact' => [ - 'description' => 'The alert contacts that receive alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact that receives alert notifications.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'expect_value' => ['description' => 'The alias or address to be resolved.'."\n" + ."\n" + .'> This parameter applies only to the DNS monitoring type.', 'type' => 'string', 'example' => 'dns_server', 'title' => ''], + 'failure_rate' => ['description' => 'The packet loss rate.'."\n" + ."\n" + .'> This parameter applies only to the PING monitoring type.', 'type' => 'number', 'format' => 'float', 'example' => '0.4', 'title' => ''], + 'header' => ['description' => 'The HTTP request header.', 'type' => 'string', 'example' => 'testKey:testValue', 'title' => ''], + 'http_method' => ['description' => 'The HTTP request method. Valid values:'."\n" + .'- get '."\n" + .'- post'."\n" + .'- head.', 'type' => 'string', 'example' => 'get', 'title' => ''], + 'ip_network' => [ + 'description' => 'The network type of the task. Valid values: v4, v6, and auto. Default value: v4.', + 'type' => 'string', + 'enum' => [], + 'example' => 'v4', + 'title' => '', + ], + 'isBase64Encode' => ['description' => 'Specifies whether to decode and store the password using Base64. Valid values:'."\n" + .'- true: The password is decoded and stored using Base64.'."\n" + .'- false: The password is not decoded and stored using Base64.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'match_rule' => ['description' => 'Specifies whether alert rules are included. Valid values:'."\n" + .'- 0: Yes.'."\n" + .'- 1: No.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'min_tls_version' => ['description' => 'The minimum TLS version. TLS 1.2 and later are supported by default. TLS 1.0 and 1.1 are disabled. To support these versions, modify the configuration.', 'type' => 'string', 'example' => 'tlsv1.2', 'title' => ''], + 'password' => ['description' => 'The password for SMTP, POP3, or FTP monitoring types.', 'type' => 'string', 'example' => '123****', 'title' => ''], + 'ping_num' => ['description' => 'The number of PING packets for the PING monitoring type.', 'type' => 'integer', 'format' => 'int32', 'example' => '29', 'title' => ''], + 'ping_port' => ['description' => 'The PING port. This parameter applies to TCP PING.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'ping_type' => ['description' => 'The PING protocol type. Valid values:'."\n" + ."\n" + .'- icmp'."\n" + ."\n" + .'- tcp'."\n" + ."\n" + .'- udp.', 'type' => 'string', 'example' => 'icmp', 'default' => 'icmp', 'title' => ''], + 'port' => ['description' => 'The port for TCP, UDP, SMTP, or POP3 monitoring types.', 'type' => 'integer', 'format' => 'int32', 'example' => '110', 'title' => ''], + 'protocol' => ['description' => 'The monitoring protocol.', 'type' => 'string', 'example' => 'TCP', 'title' => ''], + 'quic_enabled' => ['description' => 'Specifies whether the browser monitoring task uses the QUIC protocol. Valid values:'."\n" + .'- true: Uses the QUIC protocol.'."\n" + .'- false: Does not use the QUIC protocol.'."\n" + .'Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'quic_target' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'quic_target' => [ + 'description' => 'The list of sites that are forced to use the QUIC protocol.', + 'type' => 'array', + 'items' => ['description' => 'A site that is forced to use the QUIC protocol. The format is url:port. The port is optional and defaults to 443.', 'type' => 'string', 'example' => 'www.taobao.com', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'ContactALIIMs' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactALIIM' => [ - 'description' => 'The TradeManager IDs of the alert contacts.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'request_content' => ['description' => 'The request content for the HTTP monitoring type.', 'type' => 'string', 'example' => 'aa=bb', 'title' => ''], + 'request_format' => ['description' => 'The format of the HTTP request content. Valid values:'."\n" + .'- hex: hexadecimal.'."\n" + .'- txt: text.', 'type' => 'string', 'example' => 'txt', 'title' => ''], + 'response_content' => ['description' => 'The expected response content to match.', 'type' => 'string', 'example' => 'txt', 'title' => ''], + 'response_format' => ['description' => 'The format of the HTTP response content. Valid values:'."\n" + .'- hex: hexadecimal.'."\n" + .'- txt: text.', 'type' => 'string', 'example' => 'txt', 'title' => ''], + 'retry_delay' => ['description' => 'The number of retries after a monitoring failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'screen_shot' => ['description' => 'Specifies whether to enable page screenshots.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'strict_mode' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'time_out' => ['description' => 'The timeout period. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'traffic_hijack_element_blacklist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'traffic_hijack_element_blacklist' => [ + 'description' => 'When a redirect occurs, if the URL of a resource loaded by the browser matches an expression in this list, traffic hijacking is considered to have occurred.', + 'type' => 'array', + 'items' => ['description' => 'When a redirect occurs, if the URL of a resource loaded by the browser matches an expression in this list, traffic hijacking is considered to have occurred.', 'type' => 'string', 'example' => 'www.taobao.com', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'ContactMails' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactMail' => [ - 'description' => 'The email addresses of the alert contacts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'traffic_hijack_element_count' => ['description' => 'When a redirect occurs, if the number of resources loaded by the browser exceeds this value, traffic hijacking is considered to have occurred. When this value is 0, no verification is performed. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'traffic_hijack_element_whitelist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'traffic_hijack_element_whitelist' => [ + 'description' => 'When a redirect occurs, if the URL of a resource loaded by the browser does not match any expression in this list, traffic hijacking is considered to have occurred.', + 'type' => 'array', + 'items' => ['description' => 'When a redirect occurs, if the URL of a resource loaded by the browser does not match any expression in this list, traffic hijacking is considered to have occurred.', 'type' => 'string', 'example' => 'www.taobao.com', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'ContactSmses' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactSms' => [ - 'description' => 'The mobile numbers of the alert contacts.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The mobile number of the alert contact.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '13900009999', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'username' => ['description' => 'The username for FTP, SMTP, or POP3.', 'type' => 'string', 'example' => 'testUser', 'title' => ''], + 'waitTime_after_completion' => ['description' => 'The additional wait time after the page is opened in a browser monitoring task.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'scroll_end' => ['description' => 'For browser monitoring tasks, specifies whether to scroll to the bottom of the page after it is opened.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'host_binding' => ['description' => 'The custom host for HTTP tasks. The format is ip1,ip2:address. Multiple mappings can be configured. The left side of the colon contains A records or CNAMEs that the domain name can be resolved to, separated by commas. The right side of the colon is the domain name.', 'type' => 'string', 'example' => '127.0.0.1:www.aliyun.com', 'title' => ''], + 'host_binding_type' => [ + 'description' => 'Specifies how the custom host takes effect. Valid values: 0 (random) and 1 (round-robin).', + 'enumValueTitles' => ['0', '1'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'hops' => ['description' => 'The number of hops for traceroute diagnostics when a PING task fails.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'icmp_timeout_millis' => ['description' => 'The timeout period for a single PING request using the ICMP protocol. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''], + 'config_variables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'config_variables' => [ + 'description' => 'The environment variable configuration. This parameter takes effect for multi-step monitoring.', + 'type' => 'array', + 'items' => [ + 'description' => 'Environment variables can be referenced in parameters of different test steps by using the placeholder {{$.variable_name}}. They can also be updated by parsing the response of a test step and referenced in subsequent steps. For sensitive information such as API keys, enable encrypted storage.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the environment variable.', 'type' => 'string', 'example' => 'variable_name', 'title' => ''], + 'value' => ['description' => 'The value of the variable.', 'type' => 'string', 'example' => 'variable_value', 'title' => ''], + 'secure' => ['description' => 'Specifies whether to use encrypted storage.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'The alert contact groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'steps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'steps' => [ + 'description' => 'The step configurations for multi-step monitoring. This parameter takes effect for multi-step monitoring.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of a single step in multi-step monitoring.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The step name (deprecated).', 'type' => 'string', 'deprecated' => true, 'example' => 'step1', 'title' => ''], + 'step_type' => ['description' => 'The monitoring type of this step. Valid values:'."\n" + .'- http'."\n" + .'- ping'."\n" + .'- tcp'."\n" + .'- udp'."\n" + .'- dns'."\n" + .'- smtp'."\n" + .'- pop3'."\n" + .'- ftp'."\n" + .'- wait'."\n" + ."\n" + .'The wait type represents a wait step.', 'type' => 'string', 'example' => 'http', 'title' => ''], + 'url' => ['description' => 'The URL for a single step in multi-step monitoring.', 'type' => 'string', 'example' => 'https://aliyun.com', 'title' => ''], + 'allow_failure' => ['description' => 'Specifies whether to continue to the next step if the current step fails. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'is_critical' => ['description' => 'Specifies whether to mark the entire monitoring task as failed if the current step fails. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'wait_time_in_secs' => ['description' => 'The wait time. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'extracted_variables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'extracted_variables' => [ + 'description' => 'The variable extraction configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration for extracting a single variable.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The variable name.', 'type' => 'string', 'example' => 'test_variable', 'title' => ''], + 'parser' => [ + 'description' => 'The variable extraction method settings.', + 'type' => 'object', + 'properties' => [ + 'parser_type' => ['description' => 'The extraction mode. Valid values: 0 (JSON), 1 (XML), and 2 (regular expression).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'value' => ['description' => 'The variable extraction expression.'."\n" + .'When the extraction method is JSON or XML, the expression supports XML format.'."\n" + .'When the extraction method is regular expression, the string matching this value is extracted.', 'type' => 'string', 'example' => 'x.testkey.arrayvalue[0].innerkey', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'field' => ['description' => 'This parameter takes effect when the variable location is HTTP header. Extracts the key specified by this parameter from the header.', 'type' => 'string', 'example' => 'request_id', 'title' => ''], + 'extracted_type' => ['description' => 'The location from which the variable is extracted. Valid values: 0 (HTTP body) and 1 (HTTP header).', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'option' => ['description' => 'The extended options for this step. Each monitoring type has different extended options. For more information, see [CreateSiteMonitor](~~115048~~).', 'type' => 'string', 'example' => '{"enable_operator_dns": true}', 'title' => ''], + 'step_name' => ['description' => 'The step name.', 'type' => 'string', 'example' => 'step1', 'title' => ''], + 'use_generated_cookie' => ['description' => 'Specifies whether to use the cookies extracted from previous steps. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'auto_extract_cookie' => ['description' => 'Specifies whether to automatically extract cookies. The set-cookie header in the HTTP response of this step is parsed, and the cookies are available in subsequent monitoring steps. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + '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', - ], - ], - ], - '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 \\"username@example.com\\"\\n ]\\n },\\n \\"ContactMails\\": {\\n \\"ContactMail\\": [\\n \\"username@example.com\\"\\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":"\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t2\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tECS_Group\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tapplyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****\\r\\n\\t\\t\\t{\\\\\\"instanceId\\\\\\":\\\\\\"i-bp1cqhiw1za2****\\\\\\"}\\r\\n\\t\\t\\t3\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tacs_ecs_dashboard\\r\\n\\t\\t\\t1640586600000\\r\\n\\t\\t\\t7671****\\r\\n\\t\\t\\ti-bp1cqhiw1za2****\\r\\n\\t\\t\\tcpu_total\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t$Average>=10\\r\\n\\t\\t\\tALARM\\r\\n\\t\\t\\t10.58\\r\\n\\t\\t\\tP4\\r\\n\\t\\t\\tP4\\r\\n\\t\\t\\t360133\\r\\n\\t\\t\\tECS_Rule\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tECS_Group\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tapplyTemplate61dc81b5-d357-4cf6-a9b7-9f83****\\r\\n\\t\\t\\t{\\\\\\"instanceId\\\\\\":\\\\\\"i-bp1cqhiw1za2807s****\\\\\\"}\\r\\n\\t\\t\\t3\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tacs_ecs_dashboard\\r\\n\\t\\t\\t1640586540000\\r\\n\\t\\t\\t7671****\\r\\n\\t\\t\\ti-bp1cqhiw1za2807s****\\r\\n\\t\\t\\tcpu_total\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t$Average>=10\\r\\n\\t\\t\\tALARM\\r\\n\\t\\t\\t10.13\\r\\n\\t\\t\\tP4\\r\\n\\t\\t\\t300085\\r\\n\\t\\t\\tECS_Rule\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\\\\\"username@example.com\\\\\\"\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tC3C69FBE-2262-541F-A409-C52F380BAE63\\r\\n\\t2\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeAlertHistoryList', - 'description' => 'This API operation is no longer maintained. We recommend that you call the [DescribeAlertLogList](~~201087~~) operation.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeAlertLogCount' => [ - 'summary' => 'Queries the statistics of alert logs.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogCount` parameter is empty.'."\n" - ."\n" - .'> The interval between the start time (StartTime) and end time (EndTime) must be less than or equal to 15 days. The start time and end time must be specified or left empty at the same time. If you do not specify the start time and end time, the alert logs within the last 15 minutes are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1609988009694', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogCount` parameter is empty.'."\n" - ."\n" - .'> The interval between the start time (StartTime) and end time (EndTime) must be less than or equal to 15 days. The start time and end time must be specified or left empty at the same time. If you do not specify the start time and end time, the alert logs within the last 15 minutes are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1610074409694', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" - ."\n" - .'* `product`: aggregates data by cloud service.'."\n" - .'* `level`: aggregates data by alert level.'."\n" - .'* `groupId`: aggregates data by application group.'."\n" - .'* `contactGroup`: aggregates data by alert contact group.'."\n" - .'* `product,metricName`: aggregates data both by cloud service and by metric.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SearchKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword based on which the alert logs to be counted are searched.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'> For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', - ], - ], - [ - 'name' => 'Product', - 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The level and notification method of the alert. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P4', - ], - ], - [ - 'name' => 'SendStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* 0: The alert is triggered or cleared.'."\n" - .'* 1: The alert is generated not during the effective period.'."\n" - .'* 2: The alert is muted and not triggered in a specified period.'."\n" - .'* 3: The host is restarting.'."\n" - .'* 4: Notifications are not sent for the alert.'."\n" - ."\n" - .'When the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ContactGroup', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'LastMin', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of alert logs. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '360', - ], - ], - [ - 'name' => 'GroupBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is similar to the Group By clause of SQL statements. Valid values:'."\n" - ."\n" - .'* `product`: aggregates data by cloud service.'."\n" - .'* `level`: aggregates data by alert level.'."\n" - .'* `groupId`: aggregates data by application group.'."\n" - .'* `contactGroup`: aggregates data by alert group.'."\n" - .'* `product,metricName`: aggregates data both by cloud service and by metric.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'product', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'None'."\n", - ], - ], - [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert event. Valid values:'."\n" - ."\n" - .'* TRIGGERED: The alert is triggered.'."\n" - .'* RESOLVED: The alert is resolved.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TRIGGERED', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bfae2ca5b4e07d2c7278772e***********', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - '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' => '1C4A3709-BF52-42EE-87B5-7435F0929585', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertLogCount' => [ - 'description' => 'The statistics of alert logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The number of alert logs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Logs' => [ - 'description' => 'The details about alert logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the dimension field based on which alert logs are aggregated.'."\n", - 'type' => 'string', - 'example' => 'product', - ], - 'Value' => [ - 'description' => 'The value of the dimension field based on which alert logs are aggregated.'."\n", - '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":"\\r\\n\\t0BA67F6D-B699-4E3F-B205-93A5C38A0A2E\\r\\n\\t\\r\\n\\t\\t1\\r\\n\\t\\t\\r\\n\\t\\t\\tECS\\r\\n\\t\\t\\tproduct\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeAlertLogCount', - 'description' => 'Queries the statistics of alert logs.'."\n" - ."\n" - .'This topic provides an example on how to query the statistics of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeAlertLogList' => [ - 'summary' => 'Queries alert logs.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogList` parameter is empty.'."\n" - ."\n" - .'> The time period between the start time specified by `StartTime` and the end time specified by `EndTime` must be less than or equal to 15 days. You must specify StartTime and EndTime at the same time, or leave StartTime and EndTime empty at the same time. If you do not specify this parameter, the alert logs within the last 15 minutes are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1609988009694', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogList` parameter is empty.'."\n" - ."\n" - .'> The time period between the start time specified by `StartTime` and end time specified by `EndTime` must be less than or equal to 15 days. You must specify StartTime and EndTime at the same time, or leave StartTime and EndTime empty at the same time. If you do not specify this parameter, the alert logs within the last 15 minutes are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1610074409694', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SearchKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword that is used to query alert logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alert', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'> For information about how to query the namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'Product', - 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the service name.'."\n" - ."\n" - .'For information about how to obtain the abbreviation of a cloud service name, see [DescribeProductsOfActiveMetricRule](~~114930~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P4', - ], - ], - [ - 'name' => 'SendStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* 0: The alert is triggered or cleared.'."\n" - .'* 1: The alert is ineffective.'."\n" - .'* 2: The alert is muted.'."\n" - .'* 3: The host is restarting.'."\n" - .'* 4: No alert notification is sent.'."\n" - ."\n" - .'If the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ContactGroup', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IntranetInRate', - ], - ], - [ - 'name' => 'LastMin', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of alert logs. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '360', - ], - ], - [ - 'name' => 'GroupBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" - ."\n" - .'* `product`: aggregates data by cloud service.'."\n" - .'* `level`: aggregates data by alert level.'."\n" - .'* `groupId`: aggregates data by application group.'."\n" - .'* `contactGroup`: aggregates data by alert contact group.'."\n" - .'* `product,metricName`: aggregates data both by cloud service and by metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'product', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bc369e8_30f87e517ed2fc****', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert rule. Valid value: METRIC. This value indicates an alert rule for time series metrics.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'METRIC', - ], - ], - [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert event. Valid values:'."\n" - ."\n" - .'* TRIGGERED: The alert is triggered.'."\n" - .'* RESOLVED: The alert is resolved.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TRIGGERED', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - '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.', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'AlertLogList' => [ - 'description' => 'The queried alert logs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EventName' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => 'IOHang', - ], - 'Product' => [ - 'description' => 'The identifier of the cloud service. Valid values:'."\n" - ."\n" - .'* If the cloud service is provided by Alibaba Cloud, the abbreviation of the service name is returned. Example: ECS.'."\n" - .'* If the cloud service is not provided by Alibaba Cloud, a value in the `acs_Service keyword` format is returned. Example: acs_networkmonitor.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'BlackListUUID' => [ - 'description' => 'The ID of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => '8410dbbd-7d30-41c5-94cb-*****', - ], - 'Message' => [ - 'description' => 'The alert information in a JSON string.'."\n", - 'type' => 'string', - 'example' => '{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'LevelChange' => [ - 'description' => 'Indicates whether the alert level was changed. Valid values:'."\n" - ."\n" - .'* `P4->OK`: The alert level was changed from P4 to OK.'."\n" - .'* `P4->P4`: The alert level was still P4.'."\n", - 'type' => 'string', - 'example' => 'P4->OK', - ], - 'InstanceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'i-m5e1qg6uo38rztr4****', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'd582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime', - ], - 'BlackListName' => [ - 'description' => 'The name of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => '{"id":123,"metricProject":"acs_ecs_dashboard","userId":1736511134389110,"uuid":"8410dbbd-7d30-41c5-94cb-***","name":"alert-***","productCategory":"ecs","instances":[{"instanceId":"host-***"}],"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"}', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Instances', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '7301****', - ], - 'AlertTime' => [ - 'description' => 'The timestamp that was generated when the alert was triggered.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1610043776621', - ], - 'InstanceName' => [ - 'description' => 'The resource name.'."\n", - 'type' => 'string', - 'example' => 'portalHost', - ], - 'BlackListDetail' => [ - 'description' => 'The details of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => 'BlackListDetail', - ], - 'Level' => [ - 'description' => 'The alert level and the methods that are used to send alert notifications. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'example' => 'P4', - ], - 'SendStatus' => [ - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* 0: The alert is triggered or cleared.'."\n" - .'* 1: The alert is ineffective.'."\n" - .'* 2: The alert is muted.'."\n" - .'* 3: The host is restarting.'."\n" - .'* 4: No alert notification is sent.'."\n" - ."\n" - .'If the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ExtendedInfo' => [ - 'description' => 'The extended fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the extended field.'."\n", - 'type' => 'string', - 'example' => 'userId', - ], - 'Value' => [ - 'description' => 'The value of the extended field.'."\n", - 'type' => 'string', - 'example' => '120886317861****', - ], - ], - ], - ], - 'Dimensions' => [ - 'description' => 'The dimensions of the resource that triggered alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the dimension.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], - 'Value' => [ - 'description' => 'The value of the dimension.'."\n", - 'type' => 'string', - 'example' => 'i-m5e1qg6uo38rztr4****', - ], - ], - ], - ], - 'WebhookList' => [ - 'description' => 'The callback URLs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => 'The status code of the alert callback.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'url' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com/webhook.html', - ], - 'message' => [ - 'description' => 'The message returned for the alert callback.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], - ], - 'DingdingWebhookList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The webhook URL of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****', - ], - 'description' => '', - ], - 'ContactOnCallList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The phone number of the alert contact that receives alert phone calls.'."\n" - ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '1368888****', - ], - 'description' => '', - ], - 'ContactMailList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'description' => '', - ], - 'ContactGroups' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'description' => '', - ], - 'ContactALIIWWList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n" - ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'description' => '', - ], - 'ContactSMSList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The phone number of the alert contact that receives alert text messages.'."\n" - ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '1368888****', - ], - 'description' => '', - ], - 'ContactDingList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The DingTalk chatbot of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'description' => '', - ], - 'SendDetail' => [ - 'description' => 'The details about the sending results of alert notifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResultCode' => [ - 'description' => 'Indicates whether the alert notifications are sent.'."\n" - ."\n" - .'* If the alert notifications are sent, the value "success" is returned.'."\n" - .'* If the configuration is invalid, no alert notification is sent and an error code is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ChannelResultList' => [ - 'description' => 'The list of sending results that are categorized by notification method.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Channel' => [ - 'description' => 'The method that is used to send alert notifications. Valid values:'."\n" - ."\n" - .'* MAIL: email'."\n" - .'* SMS: text message'."\n" - .'* WEBHOOK: alert callback'."\n" - .'* SLS: Simple Log Service'."\n" - .'* ONCALL: phone call'."\n" - .'* FC: Function Compute'."\n" - .'* MNS: Message Service queue'."\n", - 'type' => 'string', - 'example' => 'MAIL', - ], - 'ResultList' => [ - 'description' => 'The sending results of alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'* If the value of the `Channel` parameter is `WEBHOOK`, the status code is 200 or 500.'."\n" - .'* If the value of the `Channel` parameter is `MAIL`, `SMS`, `SLS`, `ONCALL`, `FC`, or `MNS`, this parameter is empty or not returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID returned when CloudMonitor calls another cloud service.'."\n", - 'type' => 'string', - 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C4****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Detail' => [ - 'description' => 'The details of the returned results.'."\n", - 'type' => 'string', - 'example' => '{ }', - ], - 'notifyTargetList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The list of notification methods.'."\n", - 'type' => 'string', - 'example' => '1270676********', - ], - 'description' => '', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - ], - 'Escalation' => [ - 'description' => 'The alert rule based on which the alert is triggered.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expression' => [ - 'description' => 'The description of the alert rule.'."\n" - ."\n" - .'> The content of the alert rule. This parameter indicates the conditions that trigger an alert.'."\n", - 'type' => 'string', - 'example' => '$Average<90', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Level' => [ - 'description' => 'The alert level and the methods that are used to send alert notifications. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'example' => 'P4', - ], - ], - ], - 'SendResultList' => [ - 'description' => 'The sending results of alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The category of the alert notification method. Valid values:'."\n" - ."\n" - .'* MAIL: email'."\n" - .'* ALIIM: TradeManager'."\n" - .'* SMS: text message'."\n" - .'* CALL: phone call'."\n" - .'* DING: DingTalk chatbot'."\n" - .'* Merged: alert merging'."\n", - 'type' => 'string', - 'example' => 'Mail', - ], - 'Value' => [ - 'description' => 'The notification object corresponding to the alert notification method.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The notification object corresponding to the alert notification method.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - ], - ], - ], - ], - 'LogId' => [ - 'description' => 'The log ID.'."\n", - 'type' => 'string', - 'example' => '7818361[1523]@1671593992[1]', - ], - ], - ], - ], - ], - ], - ], - ], - '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 \\"username@example.com\\"\\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 \\"username@example.com\\"\\n ]\\n }\\n ],\\n \\"LogId\\": \\"7510****::e8a472a0-46ae-4ac0-84b1-e46be368****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t{\\\\\\"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}\\r\\n\\t\\td582b9e9-b1c1-4f17-9279-0fe7****_ResponseTime\\r\\n\\t\\t\\r\\n\\t\\t\\t$Average>=800\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\tP4\\r\\n\\t\\t\\r\\n\\t\\t0\\r\\n\\t\\tacs_ecs_dashboard\\r\\n\\t\\tcpu_total\\r\\n\\t\\tCPU使用率\\r\\n\\t\\tECS_Group\\r\\n\\t\\t\\r\\n\\t\\tP4->OK\\r\\n\\t\\t\\r\\n\\t\\t\\t100931896542****\\r\\n\\t\\t\\tuserId\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\ti-abcdefgh12****\\r\\n\\t\\t\\tinstanceId\\r\\n\\t\\t\\r\\n\\t\\tAlertOk\\r\\n\\t\\t\\r\\n\\t\\t\\ti-hp34y1eiszazu49y****\\r\\n\\t\\t\\tinstanceId\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t12706****\\r\\n\\t\\t\\tuserId\\r\\n\\t\\t\\r\\n\\t\\tacs_ecs_dashboard\\r\\n\\t\\t1610085521564\\r\\n\\t\\t7301****\\r\\n\\t\\tportalHost\\r\\n\\t\\tOK\\r\\n\\t\\r\\n\\t6FCB1AB7-57F7-4DDA-B14E-6468FAFE79D9\\r\\n\\t10\\r\\n\\t1\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeAlertLogList', - 'description' => 'You can call the operation to query only the alert logs within the last year.'."\n" - ."\n" - .'This topic provides an example to show how to query the alert logs of Elastic Compute Service (ECS) based on the `product` dimension.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeAlertLogHistogram' => [ - 'summary' => 'Queries the number of alert logs that are generated during each interval within a period of time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can query only the alert logs within the last year.'."\n" - ."\n" - .'* The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1609988009694', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can query only the alert logs within the last year.'."\n" - ."\n" - .'* The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1609989009694', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SearchKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to query alert logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alert', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', - ], - ], - [ - 'name' => 'Product', - 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the Alibaba Cloud service.'."\n" - ."\n" - .'> For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P4', - ], - ], - [ - 'name' => 'SendStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert status. Valid values:'."\n" - ."\n" - .'* 0: The alert is triggered or cleared.'."\n" - .'* 1: The alert is ineffective.'."\n" - .'* 2: The alert is muted and not triggered in a specified period.'."\n" - .'* 3: The host is restarting.'."\n" - .'* 4: No alert notification is sent.'."\n" - ."\n" - .'If the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ContactGroup', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'LastMin', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of alert logs. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '360', - ], - ], - [ - 'name' => 'GroupBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" - ."\n" - .'* `product`: aggregates data by cloud service.'."\n" - .'* `level`: aggregates data by alert level.'."\n" - .'* `groupId`: aggregates data by application group.'."\n" - .'* `contactGroup`: aggregates data by alert contact group.'."\n" - .'* `product,metricName`: aggregates data both by cloud service and by metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'product', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'None'."\n", - ], - ], - [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert event. Valid values:'."\n" - ."\n" - .'* TRIGGERED: The alert is triggered.'."\n" - .'* RESOLVED: The alert is resolved.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RESOLVED', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ae06917_75a8c43178ab66****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response 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' => '1C4A3709-BF52-42EE-87B5-7435F0929585', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertLogHistogramList' => [ - 'description' => 'The number of alert logs that were generated during each interval of a time period.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'From' => [ - 'description' => 'The start timestamp of the queried alert logs.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1610074791', - ], - 'To' => [ - 'description' => 'The end timestamp of the queried alert logs.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1610074800', - ], - 'Count' => [ - 'description' => 'The number of alert logs.'."\n", - '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":"\\n 200\\n The specified resource is not found.\\n 1C4A3709-BF52-42EE-87B5-7435F0929585\\n true\\n \\n 1610074791\\n 1610074800\\n 20\\n \\n","errorExample":""}]', - 'title' => 'DescribeAlertLogHistogram', - 'description' => 'This topic provides an example on how to query the number of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeProductsOfActiveMetricRule' => [ - 'summary' => 'Queries the cloud services for which the initiative alert feature is enabled.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', - ], - 'Datapoints' => [ - 'description' => 'The information about the services for which the initiative alert feature is enabled. Services are separated with commas (,). Valid values:'."\n" - ."\n" - .'* ECS: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n" - .'* redis_standard: Redis Open-Source Edition (standard architecture)'."\n" - .'* redis_sharding: Redis Open-Source Edition (cluster architecture)'."\n" - .'* redis_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" - .'* mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" - .'* mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" - .'* hbase: ApsaraDB for HBase'."\n" - .'* elasticsearch: Elasticsearch'."\n" - .'* opensearch: OpenSearch'."\n", - 'type' => 'string', - 'example' => 'ecs,rds', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AllProductInitMetricRuleList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AllProductInitMetricRule' => [ - 'description' => 'The information about the services for which one-click alert is enabled.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the services for which one-click alert is enabled.', - 'type' => 'object', - 'properties' => [ - 'Product' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'AlertInitConfigList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AlertInitConfig' => [ - 'description' => 'The initial alert rules that are generated after one-click alert is enabled for a service.', - 'type' => 'array', - 'items' => [ - 'description' => 'The initial alert rules that are generated after one-click alert is enabled for a service.', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EvaluationCount' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Namespace' => [ - 'description' => 'The namespace of the service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'acs_rds_dashboard', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The method used to calculate metric values that trigger alerts. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'Period' => [ - 'description' => 'The aggregation period of monitoring data. Unit: minutes. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => '1m', - ], - 'Level' => [ - 'description' => 'The alert level.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INFO'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* WARN'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CRITICAL'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'INFO' => '', - 'WARN' => '', - 'CRITICAL' => '', - ], - 'example' => 'CRITICAL', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LessThanThreshold: less than the threshold'."\n" - ."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - ."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - ."\n" - .'* NotEqualToThreshold: does not equal to the threshold'."\n" - ."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - ."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - ."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - ."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - ."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - ."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle', - '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":"\\r\\n\\t\\tA4FFAEFF-4225-4EF6-8F63-FAAA8F58289D\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tCPUUtilization\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t1m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_ecs_dashboard\\r\\n\\t\\t\\t\\t\\t\\t95\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tvm.DiskUtilization\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t1m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_ecs_dashboard\\r\\n\\t\\t\\t\\t\\t\\t95\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tvm.MemoryUtilization\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t1m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_ecs_dashboard\\r\\n\\t\\t\\t\\t\\t\\t95\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tInternetOutRate_Percent\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t1m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_ecs_dashboard\\r\\n\\t\\t\\t\\t\\t\\t95\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tecs\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tCpuUsage\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t5m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tDiskUsage\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t5m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tIOPSUsage\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t5m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tConnectionUsage\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t5m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tDataDelay\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\t5m\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\trds\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tDocSizeRatiobyApp\\r\\n\\t\\t\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\t\\t\\t10m\\r\\n\\t\\t\\t\\t\\t\\tMaximum\\r\\n\\t\\t\\t\\t\\t\\tacs_opensearch\\r\\n\\t\\t\\t\\t\\t\\t85\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tlossqpsbyapp\\r\\n\\t\\t\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\t\\t\\t10m\\r\\n\\t\\t\\t\\t\\t\\tMaximum\\r\\n\\t\\t\\t\\t\\t\\tacs_opensearch\\r\\n\\t\\t\\t\\t\\t\\t0\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tComputeResourceRatiobyApp\\r\\n\\t\\t\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\t\\t\\t10m\\r\\n\\t\\t\\t\\t\\t\\tMaximum\\r\\n\\t\\t\\t\\t\\t\\tacs_opensearch\\r\\n\\t\\t\\t\\t\\t\\t85\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tapp_realtime_write_latency\\r\\n\\t\\t\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\t\\t\\t20m\\r\\n\\t\\t\\t\\t\\t\\tMaximum\\r\\n\\t\\t\\t\\t\\t\\tacs_opensearch\\r\\n\\t\\t\\t\\t\\t\\t1800000\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\topensearch\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\trds,redis_standard\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeProductsOfActiveMetricRule', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeActiveMetricRuleList' => [ - 'summary' => 'Queries the details of initiative alert rules.', - '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' => 'The abbreviation of the cloud service that supports initiative alert rules.'."\n" - ."\n" - .'For more information about how to obtain the name of a cloud service, see [DescribeProductsOfActiveMetricRule](~~114930~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'None.'."\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 returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Datapoints' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Alarm' => [ - 'description' => 'The details of the alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EvaluationCount' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'State' => [ - 'description' => 'Indicates whether the alert rule is enabled.'."\n", - 'type' => 'string', - 'example' => 'Enable', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'SystemDefault_acs_rds_dashboard_CpuUsage', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', - ], - 'Period' => [ - 'description' => 'The aggregation period of monitoring data.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used in the alert rule. Valid values:'."\n" - ."\n" - .'* `>`'."\n" - .'* `<`'."\n" - .'* `>=`'."\n" - .'* `<=`'."\n" - .'* `=`'."\n" - .'* `=`'."\n", - 'type' => 'string', - 'example' => '>', - ], - 'EndTime' => [ - 'description' => 'The end of the time period during which the alert rule is effective.'."\n" - ."\n" - .'Unit: hours. For example, the value 23 indicates `23:59:59`.'."\n", - 'type' => 'string', - 'example' => '24', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time period during which the alert rule is effective.'."\n" - ."\n" - .'Unit: hours. For example, the value 00 indicates `00:00:00`.'."\n", - 'type' => 'string', - 'example' => '00', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical method.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'Enable' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - 'AlertList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Alert' => [ - 'description' => 'The details of the alert rules. The result is in the same structure as that returned by the DescribeMetricRuleList operation.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'MetricName' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'Namespace' => [ - 'description' => 'The namespace of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n", - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'example' => '00:00-06:00', - ], - 'MailSubject' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'example' => 'ECS_Bucket', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'myAlert', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'ruleIdxxxx', - ], - 'Period' => [ - 'description' => 'The aggregation period of monitoring data.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'AlertState' => [ - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* OK: The alert rule has no active alerts.'."\n" - .'* ALARM: The alert rule has active alerts.'."\n" - .'* INSUFFICIENT_DATA: No data is found.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Dimensions' => [ - 'description' => 'The monitoring data of the specified resource.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'EnableState' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ - 'description' => 'The resources that are associated with the alert rule.'."\n", - 'type' => 'string', - 'example' => '[{"resource":"_ALL"}]', - ], - 'Escalations' => [ - 'description' => 'The conditions for triggering different levels of alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Info' => [ - 'description' => 'The conditions for triggering Info-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times'."\n" - ."\n" - .'for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => '95', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Warn' => [ - 'description' => 'The conditions for triggering Warn-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times'."\n" - ."\n" - .'for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => '80', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Critical' => [ - 'description' => 'The trigger condition for Critical-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => '99', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Critical-level alerts.'."\n", - '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":"\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t86400\\r\\n\\t\\t\\t\\tECS_Group\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t${serviceType}-${metricName}-${levelDescription}\\r\\n\\t\\t\\t\\tSystemDefault_acs_rds_dashboard_IOPSUsage\\r\\n\\t\\t\\t\\t300\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\tINSUFFICIENT_DATA\\r\\n\\t\\t\\t\\tIOPSUsage\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tGreaterThanThreshold\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]\\r\\n\\t\\t\\t\\tSystemDefault_acs_rds_dashboard_IOPSUsage\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t86400\\r\\n\\t\\t\\t\\tECS_Group\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t${serviceType}-${metricName}-${levelDescription}\\r\\n\\t\\t\\t\\tSystemDefault_acs_rds_dashboard_CpuUsage\\r\\n\\t\\t\\t\\t300\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\tINSUFFICIENT_DATA\\r\\n\\t\\t\\t\\tCpuUsage\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tGreaterThanThreshold\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]\\r\\n\\t\\t\\t\\tSystemDefault_acs_rds_dashboard_CpuUsage\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t86400\\r\\n\\t\\t\\t\\t[\\\\\\"Alice\\\\\\"]\\r\\n\\t\\t\\t\\tGreaterThanThreshold\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tSystemDefault_acs_rds_dashboard_IOPSUsage\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t300\\r\\n\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\tIOPSUsage\\r\\n\\t\\t\\t\\tINSUFFICIENT_DATA\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tSystemDefault_acs_rds_dashboard_IOPSUsage\\r\\n\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t86400\\r\\n\\t\\t\\t\\t[\\\\\\"Jim\\\\\\"]\\r\\n\\t\\t\\t\\tGreaterThanThreshold\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tSystemDefault_acs_rds_dashboard_CpuUsage\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t300\\r\\n\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\tacs_rds_dashboard\\r\\n\\t\\t\\t\\tCpuUsage\\r\\n\\t\\t\\t\\tINSUFFICIENT_DATA\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tSystemDefault_acs_rds_dashboard_CpuUsage\\r\\n\\t\\t\\t\\t80\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeActiveMetricRuleList', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'EnableActiveMetricRule' => [ - 'summary' => 'Enables the initiative alert feature for a cloud service.', - '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' => 'The cloud service for which you want to enable initiative alert. Valid values:'."\n" - ."\n" - .'* ECS: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n" - .'* redis_standard: Redis Open-Source Edition (standard architecture)'."\n" - .'* redis_sharding: Redis Open-Source Edition (cluster architecture)'."\n" - .'* redis_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" - .'* mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" - .'* mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" - .'* hbase: ApsaraDB for HBase'."\n" - .'* elasticsearch: Elasticsearch'."\n" - .'* opensearch: OpenSearch'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - '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":"\\n 200\\n true\\n 55850888-9CCE-4FD5-B949-5F8947D63929\\n","errorExample":""}]', - 'title' => 'EnableActiveMetricRule', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DisableActiveMetricRule' => [ - 'summary' => 'Disables the initiative alert feature for a cloud service.', - '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' => 'The cloud service for which you want to disable proactive alerting. Valid values:'."\n" - ."\n" - .'* ECS: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n" - .'* redis_standard: Redis Open-Source Edition (standard architecture)'."\n" - .'* redis_sharding: Redis Open-Source Edition (cluster architecture)'."\n" - .'* redis_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" - .'* mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" - .'* mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" - .'* hbase: ApsaraDB for HBase'."\n" - .'* elasticsearch: Elasticsearch'."\n" - .'* opensearch: OpenSearch'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - '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' => 'DisableActiveMetricRule', - ], - 'CreateMetricRuleTemplate' => [ - 'summary' => 'Creates an alert template.', - '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' => 'The name of the alert template.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Template1', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Template1', - ], - ], - [ - 'name' => 'AlertTemplates', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The details of the alert template.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Escalations.Info.Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://ww.aliyun.com', - ], - 'Escalations.Warn.Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - 'Period' => [ - 'description' => 'The aggregation period of monitoring data. Unit: seconds.'."\n" - ."\n" - .'The default value is the minimum aggregation period. Generally, you do not need to specify the minimum aggregation period.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Rule1', - ], - 'Escalations.Critical.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'Selector' => [ - 'description' => 'The dimension of the alert. It is an extended field.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied.'."\n" - ."\n" - .'> For more information about the values of extended fields, see [DescribeMetricRuleTemplateAttribute](~~114979~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"disk":"/"}', - ], - 'Escalations.Info.Statistics' => [ - 'description' => 'The statistical method for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Escalations.Info.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Category' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - 'Escalations.Critical.Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Escalations.Critical.Statistics' => [ - 'description' => 'The statistical method for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Critical.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Warn.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Info.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Escalations.Warn.Statistics' => [ - 'description' => 'The statistical method for the Warn-level alert.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9763ED1A-4D09-41BF-851E-310421750204', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The ID of the alert template.'."\n", - '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":"\\n\\t\\t9763ED1A-4D09-41BF-851E-310421750204\\n\\t\\t12345\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'CreateMetricRuleTemplate', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMetricRuleTemplate' => [ - 'summary' => 'Deletes an alert template.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123****', - 'docRequired' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B63F8CF-D48D-4608-A402-04FB5B2B4B6A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'description' => 'The template information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'description' => 'The ID of the template.'."\n", - 'type' => 'string', - 'example' => '123****', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - '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":"\\r\\n \\r\\n 123****\\r\\n \\r\\n 7B63F8CF-D48D-4608-A402-04FB5B2B4B6A\\r\\n true\\r\\n 200\\r\\n","errorExample":""}]', - 'title' => 'DeleteMetricRuleTemplate', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyMetricRuleTemplate' => [ - 'summary' => 'Modifies an alert template.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert template.'."\n" - ."\n" - .'For information about how to obtain the name of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_template1', - ], - ], - [ - 'name' => 'RestVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the alert template. The version changes with the number of times that the alert template is modified.'."\n" - ."\n" - .'For information about how to obtain the version of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'AlertTemplates', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The details of the alert template.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The version of the alert template. The version changes with the number of times that the alert template is modified.'."\n" - ."\n" - .'For information about how to obtain the version of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'Escalations.Info.Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain metrics, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://apiwebhook.hipac.cn/api/v1/alarm/aly/eregfeeferrtbnmkdszp', - ], - 'Escalations.Warn.Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - 'Period' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> If the value is set to 300 seconds, the monitoring data is collected every 300 seconds. If the monitoring data is reported every 1 minute, the alert system calculates the average, maximum, and minimum values of the monitoring data of 5 minutes and checks whether the aggregated values exceed the threshold. To prevent unexpected alerts, we recommend that you set this parameter together with other parameters.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule1', - ], - 'Escalations.Critical.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'Selector' => [ - 'description' => 'The dimension of the alert. It is an extended field.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied.'."\n" - ."\n" - .'> For more information about the values of extended fields, see [DescribeMetricRuleTemplateAttribute](~~114979~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"disk":"/"}', - ], - 'Escalations.Info.Statistics' => [ - 'description' => 'The statistical method for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Escalations.Info.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Category' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], - 'Escalations.Critical.Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Escalations.Critical.Statistics' => [ - 'description' => 'The statistical method for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Critical.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Warn.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Info.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Escalations.Warn.Statistics' => [ - 'description' => 'The statistical method for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9E07117F-F6AE-4F1C-81E8-36FBB4892235', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - '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":"\\n\\t\\t97EAC0E2-CD54-4183-95AC-F0C113024E18\\n\\t\\t200\\n\\t\\ttrue\\n","errorExample":""}]', - 'title' => 'ModifyMetricRuleTemplate', - 'description' => 'This topic provides an example on how to modify an alert template whose version is `1` and ID is `123456`. The alert level is changed to `Critical`. The statistical method is changed to `Average`. The alert threshold comparator is changed to `GreaterThanOrEqualToThreshold`. The alert threshold is changed to `90`. The number of alert retries is changed to `3`. The response shows that the alert template is modified.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMetricRuleTemplateAttribute' => [ - 'summary' => 'Queries the details of an alert template.', - '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' => 'The name of the alert template. You must specify at least one of the `Name` and `TemplateId` parameters.'."\n" - ."\n" - .'For information about how to obtain the name of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Template1', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template. You must specify at least one of the `Name` and `TemplateId` parameters.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '70****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8F3A82AD-DA92-52B0-8EC6-C059D1C3839F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'description' => 'The details of the alert template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the alert template.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Name' => [ - 'description' => 'The name of the alert template.'."\n", - 'type' => 'string', - 'example' => 'ECS_Template1', - ], - 'RestVersion' => [ - 'description' => 'The version of the alert template.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TemplateId' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'string', - 'example' => '70****', - ], - 'AlertTemplates' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AlertTemplate' => [ - 'description' => 'The queried alert templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Selector' => [ - 'description' => 'The dimension of the alert. It is an extended field.'."\n", - 'type' => 'string', - 'example' => '{"disk":"/"}', - ], - 'Webhook' => [ - 'description' => 'The callback URL to which a request is sent when an alert is triggered.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'Namespace' => [ - 'description' => 'The namespace of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'Category' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'ECS_Rule', - ], - 'NoDataPolicy' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n", - 'type' => 'string', - 'example' => 'KEEP_LAST_STATE', - ], - 'Escalations' => [ - 'description' => 'The threshold and the alert level.'."\n", - 'type' => 'object', - 'properties' => [ - 'Info' => [ - 'description' => 'The conditions for triggering Info-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical method for Info-level alerts.'."\n" - ."\n" - .'The value of the `Statistics` parameter varies with the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Warn' => [ - 'description' => 'The conditions for triggering Warn-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical method for Warn-level alerts.'."\n" - ."\n" - .'The value of the `Statistics` parameter varies with the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Critical' => [ - 'description' => 'The conditions for triggering Critical-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical method for Critical-level alerts.'."\n" - ."\n" - .'The value of the `Statistics` parameter varies with the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - ], - ], - 'Labels' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Labels' => [ - 'description' => 'The tags of the alert template.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the alert template.'."\n", - 'type' => 'string', - 'example' => 'label1', - ], - 'Value' => [ - 'description' => 'The tag value of the alert template.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - ], - 'SilenceTime' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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":"\\r\\n\\t8F3A82AD-DA92-52B0-8EC6-C059D1C3839F\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcpu_total\\r\\n\\t\\t\\t\\tecs\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\tGreaterThanOrEqualToThreshold\\r\\n\\t\\t\\t\\t\\t\\t5\\r\\n\\t\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t\\t90\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tacs_ecs_dashboard\\r\\n\\t\\t\\t\\tECS_Rule\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t1\\r\\n\\t\\t70****\\r\\n\\t\\tECS_Template1\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeMetricRuleTemplateAttribute', - 'description' => 'This topic provides an example on how to query the details of an alert template whose ID is `70****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMetricRuleTemplateList' => [ - 'summary' => 'Queries alert templates.', - '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' => 'The name of the alert template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Template1', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword of the alert template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '70****', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'History', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to display the history of applying the alert templates to application groups. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false (default)'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order. Valid values:'."\n" - ."\n" - .'* true (default): ascending order'."\n" - .'* false: descending order'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting basis. Valid values:'."\n" - ."\n" - .'* gmtMotified: sorts alert templates by modification time'."\n" - .'* gmtCreate (default): sorts alert templates by creation time'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gmtCreate', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '659401C0-6214-5C02-972A-CFA929D717B7', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Templates' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Template' => [ - 'description' => 'The queried alert templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the alert template.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GmtCreate' => [ - 'description' => 'The timestamp when the alert template was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1646018798000', - ], - 'Name' => [ - 'description' => 'The name of the alert template.'."\n", - 'type' => 'string', - 'example' => 'ECS_Template1', - ], - 'RestVersion' => [ - 'description' => 'The version of the alert template.'."\n" - ."\n" - .'Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GmtModified' => [ - 'description' => 'The timestamp when the alert template was modified.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1646054798000', - ], - 'TemplateId' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70****', - ], - 'ApplyHistories' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApplyHistory' => [ - 'description' => 'The history of applying the alert templates to application groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3607****', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'ApplyTime' => [ - 'description' => 'The timestamp when the alert template was applied to the application group.'."\n" - ."\n" - .'Unit: milliseconds.'."\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":"\\r\\n\\t659401C0-6214-5C02-972A-CFA929D717B7\\r\\n\\t2\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeMetricRuleTemplateList', - 'description' => 'This topic provides an example on how to query alert templates. In this example, the following alert templates are returned in the response: `ECS_Template1` and `ECS_Template2`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ApplyMetricRuleTemplate' => [ - 'summary' => 'Applies an alert template to an application group to generate an alert rule.', - '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' => 'The mute period during which notifications are not repeatedly sent for an alert. Unit: seconds. Default value: 86400.'."\n" - ."\n" - .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group to which the alert template is applied.'."\n" - ."\n" - .'For more information about how to query the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'TemplateIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template.'."\n" - ."\n" - .'For more information about how to query the IDs of alert templates, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '700****', - ], - ], - [ - 'name' => 'EnableStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time period during which the alert rule is effective. Valid values: 00 to 23. A value of 00 indicates 00:00 and a value of 23 indicates 23:00.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '00', - ], - ], - [ - 'name' => 'EnableEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time period during which the alert rule is effective. Valid values: 00 to 23. A value of 00 indicates 00:59 and a value of 23 indicates 23:59.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '23', - ], - ], - [ - 'name' => 'NotifyLevel', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'Set the value to 4. A value of 4 indicates that alert notifications are sent by using TradeManager and DingTalk chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4', - ], - ], - [ - 'name' => 'ApplyMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mode in which the alert template is applied. Valid values:'."\n" - ."\n" - .'* GROUP_INSTANCE_FIRST: The metrics in the application group take precedence. If a metric specified in the alert template does not exist in the application group, the system does not generate an alert rule for the metric based on the alert template.'."\n" - .'* ALARM_TEMPLATE_FIRST: The metrics specified in the alert template take precedence. If a metric specified in the alert template does not exist in the application group, the system still generates an alert rule for the metric based on the alert template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GROUP_INSTANCE_FIRST', - ], - ], - [ - 'name' => 'Webhook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - ], - [ - 'name' => 'AppendMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The template application policy. Valid values:'."\n" - ."\n" - .'* all (default): deletes all the rules that are created by using the alert template from the selected application group, and then creates alert rules based on the template.'."\n" - .'* append: deletes the rules that are created by using the alert template from the selected application group, and then creates alert rules based on the existing template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3F897F3C-020A-4993-95B4-63ABB84F83E6', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'description' => 'The resources that are affected by the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'AlertResults' => [ - 'description' => 'The details of the generated alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'alert rule is creating, please wait a few minutes.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'test123', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - '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":"\\r\\n\\t37D4037E-827E-4E66-87DF-F56A22F2884D\\r\\n\\t\\r\\n\\t\\t123456\\r\\n\\t\\t\\r\\n\\t\\t\\talert rule is creating, please wait a few minutes.\\r\\n\\t\\t\\tapplyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****\\r\\n\\t\\t\\t202\\r\\n\\t\\t\\ttest123\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'ApplyMetricRuleTemplate', - 'description' => 'In this example, the `700****` alert template is applied to the `123456` application group. For the generated alert rule, the ID is `applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****`, and the name is `test123`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMetricRuleList' => [ - 'summary' => 'Queries alert rules.', - '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' => 'The name of the metric.'."\n" - ."\n" - .'For information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'EnableState', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query enabled or disabled alert rules. Valid values:'."\n" - ."\n" - .'* true: queries enabled alert rules.'."\n" - .'* false: queries disabled alert rules.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'Page', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return.'."\n" - ."\n" - .'Minimum value: 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Minimum value: 1. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'AlertState', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* OK: The alert rule has no active alerts.'."\n" - .'* ALARM: The alert rule has active alerts.'."\n" - .'* INSUFFICIENT_DATA: No data is available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OK', - ], - ], - [ - 'name' => 'Dimensions', - 'in' => 'query', - 'schema' => [ - 'description' => 'The monitoring dimensions of the specified resource.'."\n" - ."\n" - .'Set the value to a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` or `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"instanceId":"i-2ze2d6j5uhg20x47****"}', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'This parameter supports fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Rule_01', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', - ], - ], - [ - 'name' => 'RuleIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can specify up to 20 IDs at a time. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '386C6712-335F-5054-930A-CC92B851ECBA', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Alarms' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Alarm' => [ - 'description' => 'The queried alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400. Minimum value: 3600.'."\n" - ."\n" - .'Only one alert is reported during each mute period even if the metric value consecutively exceeds the alert rule threshold several times.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'MetricName' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Webhook' => [ - 'description' => 'The callback URL. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Alarm', - ], - 'SourceType' => [ - 'description' => 'The type of the alert rule. Valid value: METRIC. This value indicates an alert rule for time series metrics.'."\n", - 'type' => 'string', - 'example' => 'METRIC', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'MailSubject' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'example' => '"${serviceType}-${metricName}-${levelDescription}Notification(${dimensions})"'."\n", - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'example' => '00:00-05:30', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n", - 'type' => 'string', - 'example' => '05:31-23:59', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Rule_01', - ], - 'AlertState' => [ - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* OK: The alert rule has no active alerts.'."\n" - .'* ALARM: The alert rule has active alerts.'."\n" - .'* INSUFFICIENT_DATA: No data is available.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Period' => [ - 'description' => 'The statistical period.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n" - ."\n" - .'> If the alert rule is associated with an application group, the name of the application group is returned in this parameter.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '7301****', - ], - 'Dimensions' => [ - 'description' => 'The dimensions of the alert rule.'."\n", - 'type' => 'string', - 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', - ], - 'EnableState' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ - 'description' => 'The resources that are associated with the alert rule.'."\n", - 'type' => 'string', - 'example' => '[{\\"instanceId\\":\\"i-2ze2d6j5uhg20x47****\\"}]', - ], - 'Escalations' => [ - 'description' => 'The conditions for triggering different levels of alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Info' => [ - 'description' => 'The conditions for triggering Info-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'PreCondition' => [ - 'description' => 'The additional conditions for triggering Info-level alerts. The additional conditions take effect when the value of the ComparisonOperator parameter is GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, or LessThanLastPeriod.'."\n" - ."\n" - .'For example, the values of the PreCondition, ComparisonOperator, and Threshold parameters are set to $Average>80, GreaterThanYesterday, and 10, respectively. An alert is triggered only when the average metric value is greater than 80 and 10% greater than the average metric value at the same time yesterday.'."\n" - ."\n" - .'> $Average is a placeholder that consists of `a dollar sign ($) and the statistical method`. CloudMonitor replaces the placeholder with the aggregated value or original value before value comparison.'."\n", - 'type' => 'string', - 'example' => '$Average>80', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Warn' => [ - 'description' => 'The conditions for triggering Warn-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'PreCondition' => [ - 'description' => 'The additional conditions for triggering Warn-level alerts. The additional conditions take effect when the value of the ComparisonOperator parameter is GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, or LessThanLastPeriod.'."\n" - ."\n" - .'For example, the values of the PreCondition, ComparisonOperator, and Threshold parameters are set to $Average>80, GreaterThanYesterday, and 10, respectively. An alert is triggered only when the average metric value is greater than 80 and 10% greater than the average metric value at the same time yesterday.'."\n" - ."\n" - .'> $Average is a placeholder that consists of `a dollar sign ($) and the statistical method`. CloudMonitor replaces the placeholder with the aggregated value or original value before value comparison.'."\n", - 'type' => 'string', - 'example' => '$Average>80', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Critical' => [ - 'description' => 'The conditions for triggering Critical-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'PreCondition' => [ - 'description' => 'The additional conditions for triggering Critical-level alerts. The additional conditions take effect when the value of the ComparisonOperator parameter is GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, or LessThanLastPeriod.'."\n" - ."\n" - .'For example, the values of the PreCondition, ComparisonOperator, and Threshold parameters are set to $Average>80, GreaterThanYesterday, and 10, respectively. An alert is triggered only when the average metric value is greater than 80 and 10% greater than the average metric value at the same time yesterday.'."\n" - ."\n" - .'> $Average is a placeholder that consists of `a dollar sign ($) and the statistical method`. CloudMonitor replaces the placeholder with the aggregated value or original value before value comparison.'."\n", - 'type' => 'string', - 'example' => '$Average>80', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - ], - ], - 'NoDataPolicy' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default value): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n", - 'type' => 'string', - 'example' => 'KEEP_LAST_STATE', - ], - 'CompositeExpression' => [ - 'description' => 'The trigger conditions for multiple metrics.'."\n" - ."\n" - .'> The trigger conditions for a single metric and multiple metrics are mutually exclusive. You cannot specify trigger conditions for a single metric and multiple metrics at the same time.'."\n", - 'type' => 'object', - 'properties' => [ - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'Critical', - ], - 'ExpressionList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ExpressionList' => [ - 'description' => 'The trigger conditions that are created in standard mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Period' => [ - 'description' => 'The aggregation period of the metric.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Statistics' => [ - 'description' => 'The statistical method of the metric. Valid values:'."\n" - ."\n" - .'* $Maximum: the maximum value'."\n" - .'* $Minimum: the minimum value'."\n" - .'* $Average: the average value'."\n" - .'* $Availability: the availability rate (usually used for site monitoring)'."\n" - ."\n" - .'> `$` is the prefix of the metric. For information about the Alibaba Cloud services that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => '$Maximum', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '90', - ], - ], - ], - ], - ], - ], - 'ExpressionListJoin' => [ - 'description' => 'The relationship between the trigger conditions for multiple metrics. Valid values:'."\n" - ."\n" - .'* `&&`: An alert is triggered only if all metrics meet the trigger conditions. An alert is triggered only if the results of all expressions specified in the ExpressionList parameter are `true`.'."\n" - .'* `||`: An alert is triggered if one of the metrics meets the trigger conditions.'."\n", - 'type' => 'string', - 'example' => '||', - ], - 'ExpressionRaw' => [ - 'description' => 'The trigger conditions that are created by using expressions. You can use expressions to create trigger conditions in the following scenarios:'."\n" - ."\n" - .'* Set an alert blacklist for specific resources. For example, if you specify `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`, no alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 50.'."\n" - .'* Set a special alert threshold for a specified instance in the rule. For example, if you specify `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`, an alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 80 or the `average metric value` of other instances exceeds 50.'."\n" - .'* Limit the number of instances whose metric values exceed the threshold. For example, if you specify `count($Average > 20) > 3`, an alert is triggered only when the number of instances whose `average metric value` exceeds 20 exceeds three.'."\n", - 'type' => 'string', - 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', - ], - 'Times' => [ - 'description' => 'The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - ], - 'Labels' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Labels' => [ - 'description' => 'The tags of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'cmsRuleKey', - ], - 'Value' => [ - 'description' => 'The tag value of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'cmsRuleValue', - ], - ], - ], - ], - ], - ], - 'Prometheus' => [ - 'description' => 'The Prometheus alerts.'."\n" - ."\n" - .'> This parameter is required only if you create a Prometheus alert rule for Hybrid Cloud Monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'PromQL' => [ - 'description' => 'The PromQL query statement.'."\n" - ."\n" - .'> The data obtained by using the PromQL query statement is the monitoring data. You must include the alert threshold in this statement.'."\n", - 'type' => 'string', - 'example' => 'CpuUsage{instanceId="xxxx"}[1m]>90', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'Critical', - ], - 'Times' => [ - 'description' => 'The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Annotations' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Annotations' => [ - 'description' => 'The annotations of the Prometheus alert rule. When a Prometheus alert is triggered, the system renders the annotated keys and values to help you understand the metrics and alert rule.'."\n" - ."\n" - .'> This parameter is equivalent to the annotations parameter of open source Prometheus.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the annotation.'."\n", - 'type' => 'string', - 'example' => 'summary', - ], - 'Value' => [ - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', - ], - ], - ], - ], - ], - ], - ], - ], - 'ProductCategory' => [ - 'type' => 'string', - ], - 'GmtCreate' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtUpdate' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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":"\\r\\n\\t386C6712-335F-5054-930A-CC92B851ECBA\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tECS_Group\\r\\n\\t\\t\\t86400\\r\\n\\t\\t\\tECS_Alarm\\r\\n\\t\\t\\t00:00-05:30\\r\\n\\t\\t\\tgroup\\r\\n\\t\\t\\t${serviceType}-${metricName}-${levelDescription}通知（${dimensions}）\\r\\n\\t\\t\\tMETRIC\\r\\n\\t\\t\\tapplyTemplate344cfd42-0f32-4fd6-805a-88d7908a****\\r\\n\\t\\t\\t60\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\ti-2ze2d6j5uhg20x47****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t05:31-23:59\\r\\n\\t\\t\\tacs_ecs_dashboard\\r\\n\\t\\t\\tOK\\r\\n\\t\\t\\t7301****\\r\\n\\t\\t\\tcpu_total\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tGreaterThanOrEqualToThreshold\\r\\n\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t90\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tGreaterThanOrEqualToThreshold\\r\\n\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t90\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tGreaterThanOrEqualToThreshold\\r\\n\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\tAverage\\r\\n\\t\\t\\t\\t\\t90\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\thttps://www.aliyun.com\\r\\n\\t\\t\\t[{\\\\\\"instanceId\\\\\\":\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\"}]\\r\\n\\t\\t\\tRule_01\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeMetricRuleList', - 'description' => 'This topic provides an example on how to query all alert rules within your Alibaba Cloud account. The returned result shows that only one alert rule is found. The name of the alert rule is `Rule_01` and the ID is `applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateGroupMetricRules' => [ - 'summary' => 'Creates one or more alert rules for a specified application group.', - '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' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'GroupMetricRules', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The statistical methods for Warn-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid value:'."\n" - ."\n" - .'* Average: the average value'."\n" - .'* Minimum: the minimum value'."\n" - .'* Maximum: the maximum value'."\n", - 'type' => 'object', - 'properties' => [ - 'Escalations.Info.Threshold' => [ - 'description' => 'The threshold for Info-level alerts. Valid values of N: 1 to 200.', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'MetricName' => [ - 'description' => 'The name of the metric. Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - 'Escalations.Warn.Threshold' => [ - 'description' => 'The threshold for Warn-level alerts. Valid values of N: 1 to 200.', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '05:31-23:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-05:30', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '456789', - ], - 'Escalations.Critical.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered. Valid values of N: 1 to 200.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Dimensions' => [ - 'description' => 'The dimension of the alert rule. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Set the value to a set of key-value pairs, for example, `userId:120886317861****` or `instanceId:i-m5e1qg6uo38rztr4****`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', - ], - 'Escalations.Critical.Threshold' => [ - 'description' => 'The threshold for Critical-level alerts. Valid values of N: 1 to 200.', - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'Escalations.Critical.Statistics' => [ - 'description' => 'The statistical methods for Critical-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- Average: the average value'."\n" - .'- Minimum: the minimum value'."\n" - .'- Maximum: the maximum value', - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'- GreaterThanThreshold: greater than the threshold'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'- LessThanThreshold: less than the threshold'."\n" - .'- NotEqualToThreshold: not equal to the threshold'."\n" - .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Info.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered. Valid values of N: 1 to 200.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Unit: seconds. Default value: 86400. Minimum value: 3600.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], - 'Webhook' => [ - 'description' => 'The callback URL. Valid values of N: 1 to 200.'."\n" - ."\n" - .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service. Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - 'EmailSubject' => [ - 'description' => 'The subject of the alert notification email. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Period' => [ - 'description' => 'The aggregation period of the metric data. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Set the `Period` parameter to an integral multiple of 60. Unit: seconds. Default value: 300.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Rule1', - ], - 'Escalations.Info.Statistics' => [ - 'description' => 'The statistical methods for Info-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- Average: the average value'."\n" - .'- Minimum: the minimum value'."\n" - .'- Maximum: the maximum value', - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered. Valid values of N: 1 to 200.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Escalations.Info.ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'- GreaterThanThreshold: greater than the threshold'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'- LessThanThreshold: less than the threshold'."\n" - .'- NotEqualToThreshold: not equal to the threshold'."\n" - .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Interval' => [ - 'description' => 'The interval at which CloudMonitor checks whether the alert rule is triggered. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Unit: seconds. The default value is the lowest frequency at which the metric is polled.'."\n" - ."\n" - .'> We recommend that you set the interval to the data aggregation period. If the interval is shorter than the data aggregation period, alerts cannot be triggered due to insufficient data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - 'Category' => [ - 'description' => 'The name of the cloud service. Valid values of N: 1 to 200. Valid value:'."\n" - ."\n" - .'* PolarDB: PolarDB'."\n" - .'* NewBGPDDoS: Anti-DDoS Pro'."\n" - .'* IoTDevice: IoT Platform'."\n" - .'* DRDS: Distributed Relational Database Service (DRDS)'."\n" - .'* VS: Video Surveillance System'."\n" - .'* AMQP: Alibaba Cloud Message Queue for AMQP'."\n" - .'* ADS: AnalyticDB'."\n" - .'* APIGateway: API Gateway'."\n" - .'* InternetSharedBandwidth: EIP Bandwidth Plan'."\n" - .'* CDN: Alibaba Cloud Content Delivery Network (CDN)'."\n" - .'* CEN: Cloud Enterprise Network (CEN)'."\n" - .'* DCDN: Dynamic Route for CDN (DCDN)'."\n" - .'* DDoS: Anti-DDoS'."\n" - .'* ECS: Elastic Compute Service (ECS)'."\n" - .'* DirectMail: Direct Mail'."\n" - .'* Elasticsearch: Elasticsearch'."\n" - .'* EMR: E-MapReduce (EMR)'."\n" - .'* ESS: Auto Scaling'."\n" - .'* FunctionCompute: Function Compute'."\n" - .'* RealtimeCompute: Realtime Compute for Apache Flink'."\n" - .'* GlobalAcceleration: Global Accelerator (GA)'."\n" - .'* Hbase: ApsaraDB for HBase'."\n" - .'* TSDB: Time Series Database (TSDB)'."\n" - .'* IPv6trans: IPv6 Translation Service'."\n" - .'* Kafka: Message Queue for Apache Kafka'."\n" - .'* Kubernetes: Container Service for Kubernetes (ACK)'."\n" - .'* KVstore: ApsaraDB for Redis'."\n" - .'* MNS: Message Service (MNS)'."\n" - .'* MongoDB: ApsaraDB for MongoDB'."\n" - .'* MQ: Message Queue'."\n" - .'* NAT: NAT Gateway'."\n" - .'* OpenAd: Open Ad'."\n" - .'* OpenSearch: Open Search'."\n" - .'* OSS: Object Storage Service (OSS)'."\n" - .'* PCDN: P2P CDN'."\n" - .'* petadata: HybridDB for MySQL'."\n" - .'* RDS: ApsaraDB RDS'."\n" - .'* SCDN: Secure CDN'."\n" - .'* SLB: Server Load Balancer (SLB)'."\n" - .'* SLS: Log Service'."\n" - .'* VideoLive: ApsaraVideo Live'."\n" - .'* VOD: ApsaraVideo VOD'."\n" - .'* EIP: Elastic IP Address (EIP)'."\n" - .'* VPN: VPN Gateway'."\n" - .'* AIRec: Artificial Intelligence Recommendation'."\n" - .'* GPDB: AnalyticDB for PostgreSQL'."\n" - .'* DBS: Database Backup (DBS)'."\n" - .'* SAG: Smart Access Gateway (SAG)'."\n" - .'* Memcache: ApsaraDB for Memcache'."\n" - .'* IOT_EDGE: Link IoT Edge'."\n" - .'* OCS: ApsaraDB for Memcache (previous version)'."\n" - .'* VPC: Express Connect'."\n" - .'* EHPC: Elastic High Performance Computing (E-HPC)'."\n" - .'* MPS: ApsaraVideo Media Processing'."\n" - .'* ENS: Edge Node Service (ENS)'."\n" - .'* MaxCompute_Prepay: MaxCompute'."\n" - .'* IoT_Kubernetes: Edge Application Hosting'."\n" - .'* CMS: CloudMonitor'."\n" - .'* batchcomputenew: Batch Compute'."\n" - .'* HBaseUE: ApsaraDB for HBase Performance-enhanced Edition'."\n" - .'* UIS: Ultimate Internet Service (UIS)'."\n" - .'* nls: Intelligent Speech Interaction'."\n" - .'* ots: Tablestore'."\n" - .'* NAS: File Storage NAS'."\n" - .'* ECI: Elastic Container Instance (ECI)'."\n" - .'* OpenAPI: OpenAPI Explorer'."\n" - .'* pvtzpost: Alibaba Cloud DNS PrivateZone'."\n" - .'* blinkonk8s: Flink on Kubernetes'."\n" - .'* FunctionFlow: Serverless Workflow (SWF)'."\n" - .'* SMC: Server Migration Center (SMC)'."\n" - .'* ddosbgp: Anti-DDoS Origin'."\n" - .'* baas: Blockchain as a Service'."\n" - .'* privatelink: PrivateLink'."\n" - .'* cds: ApsaraDB for Cassandra'."\n" - .'* DDH: Dedicated Host'."\n" - .'* RocketMQ: Message Queue for Apache RocketMQ'."\n" - .'* ECC: Express Cloud Connect'."\n" - .'* hbaseserverless: ApsaraDB for HBase Serverless Edition'."\n" - .'* mns_tmp: Message Service'."\n" - .'* hdr: Hybrid Disaster Recovery (HDR)'."\n" - .'* hbr: Hybrid Backup Recovery (HBR)'."\n" - .'* ADB: AnalyticDB for MySQL V3.0'."\n" - .'* tag: Tag Service'."\n" - .'* GDB: Graph Database'."\n" - .'* WAF: Web Application Firewall (WAF)'."\n" - .'* hcs_sgw: Cloud Storage Gateway (CSG)'."\n" - .'* ipv6gateway: IPv6 Gateway'."\n" - .'* RDS_SAR: ApsaraDB Exclusive Host Group'."\n" - .'* learn: Machine Learning Platform for AI'."\n" - .'* ROS: Resource Orchestration Service (ROS)'."\n" - .'* OOS: Operation Orchestration Service (OOS)'."\n" - .'* bds: Data Synchronization for HBase'."\n" - .'* cfw: Cloud Firewall'."\n" - .'* ddosDip: Anti-DDoS Premium'."\n" - .'* datahub: DataHub'."\n" - .'* hologres: Hologres'."\n" - .'* ExpressConnect: Express Connect'."\n" - .'* dbfs: Database File System (DBFS)'."\n" - .'* clickhouse: ApsaraDB for ClickHouse'."\n" - .'* k8s: Container Service for Kubernetes (ACK)'."\n" - .'* DTS: Data Transmission Service (DTS)'."\n" - .'* AnycastEIP: Anycast Elastic IP Address'."\n" - .'* Lindorm: ApsaraDB for Lindorm'."\n" - .'* config: Cloud Config'."\n" - .'* spark: Databricks DataInsight (DDI)'."\n" - .'* serverless: Serverless App Engine (SAE)'."\n" - .'* alb: Application Load Balancer (ALB)'."\n" - .'* oceanbase: ApsaraDB for OceanBase'."\n" - .'* KMS: Key Management Service (KMS)'."\n" - .'* lvwang: Content Moderation'."\n" - .'* LinkVisual: LinkVisual'."\n" - .'* tair: ApsaraDB for Redis Enhanced Edition (Tair)'."\n" - .'* dlf: Data Lake Formation (DLF)'."\n" - .'* networkmonitor: Site Monitoring'."\n" - .'* pnc: Physical Network Change'."\n" - .'* AIS: Alibaba Cloud Infrastructure'."\n" - .'* cloudgame: Cloud Gaming Platform'."\n" - .'* RTC: Real-Time Communication'."\n" - .'* cloudbox: CloudBox'."\n" - .'* actiontrail: ActionTrail'."\n" - .'* cc: Cloud Connector'."\n" - .'* disk: Elastic Block Storage (EBS)'."\n" - .'* easygene: Genomics Computing Platform'."\n" - .'* cloudphone: Elastic Cloud Phone'."\n" - .'* BMS: Bare Metal Management Service'."\n" - .'* swas: Simple Application Server'."\n" - .'* AvailabilityMonitoring: Availability Monitoring of CloudMonitor', - 'type' => 'string', - 'required' => true, - 'example' => 'ECS', - ], - 'Escalations.Critical.ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'- GreaterThanThreshold: greater than the threshold'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'- LessThanThreshold: less than the threshold'."\n" - .'- NotEqualToThreshold: not equal to the threshold'."\n" - .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Warn.Statistics' => [ - 'description' => 'The statistical methods for Warn-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- Average: the average value'."\n" - .'- Minimum: the minimum value'."\n" - .'- Maximum: the maximum value', - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'NoDataPolicy' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values of N: 1 to 200. Valid value:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default value): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The alert rule has no active alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KEEP_LAST_STATE', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact groups. Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], - 'Labels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the alert rule. The specified tag is contained in alert notifications.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value of the alert rule. The specified tag is contained in alert notifications.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, - ], - 'Options' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "NotSendOK": true'."\n" - .'}', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid value:'."\n" - ."\n" - .'- true: The call is successful.'."\n" - .'- false: The call fails.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AlertResult' => [ - 'description' => 'The details of the alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code that is returned for the alert rule.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message that is returned for the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Metric not found.', - ], - 'Success' => [ - 'description' => 'Indicates whether the alert rule was created. Valid value:'."\n" - ."\n" - .'- true: The alert rule was created.'."\n" - .'- false: The alert rule failed to be created.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'ECS_Rule1', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - '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":"\\r\\n\\tCED22B00-CFD8-5BDF-A645-CAF7B81FAE45\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t456789\\r\\n\\t\\t\\t200\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tECS_Rule1\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'CreateGroupMetricRules', - 'description' => 'This topic provides an example to show how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the `123456` application group. The ID of the alert rule is `456789`. The name of the alert rule is `ECS_Rule1`. The alert level is `Critical`. The statistical method is `Average`. The comparison operator is `GreaterThanOrEqualToThreshold`. The alert threshold is `90`. The number of alert retries is `3`. The response shows that the alert rule named `ECS_Rule1` is created.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateMetricRuleResources' => [ - 'summary' => 'Associates resources with an alert rule.', - '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' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'i-2ze3w55tr2rcpejpcfap_59c96b85-0339-4f35-ba66-ae4e34d3****', - ], - ], - [ - 'name' => 'Overwrite', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to overwrite existing resources. Valid values:'."\n" - ."\n" - .'* true: The resources submitted this time overwrite the previously associated resources.'."\n" - .'* false: The resources submitted this time do not overwrite the previously associated resources. The associated resources after submission include the previously associated resources and the resources submitted this time.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'false', - ], - ], - [ - 'name' => 'Resources', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resources that are associated with the alert rule. Set the value to a JSON array.'."\n" - ."\n" - .'> You can add up to 100 resources each time. An alert rule can be associated with up to 3,000 resources.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{"instanceId":"i-a2d5q7pm3f9yr29e****"}]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0671A721-0D7A-4F11-BB77-2416325D65AB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - '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' => 'CreateMetricRuleResources', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMetricRuleTargets' => [ - 'summary' => 'Delete the push channels of an alert rule.', - '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' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ruleId-xxxxxx', - ], - ], - [ - 'name' => 'TargetIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - ], - 'required' => true, - 'example' => '12345', - 'maxItems' => 5, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Description** 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailIds' => [ - 'description' => 'The IDs of the resources that failed to be deleted.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetIds' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TargetId' => [ - 'description' => 'The IDs of the resources that failed to be deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource that failed to be deleted.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - '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":"\\r\\n\\t\\t786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n\\t\\t\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\r\\n","errorExample":""}]', - 'title' => 'DeleteMetricRuleTargets', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMetricRules' => [ - 'summary' => 'Deletes one or more alert rules.', - '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' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The ID of the alert rule. Valid values of N: 1 to 100.'."\n", - 'example' => 'ab05733c97b7ce239fb1b53393dc1697c7e12****', - ], - 'required' => true, - 'example' => 'ab05733c97b7ce239fb1b53393dc1697c7e12****', - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates a success.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E5599964-8D0D-40DC-8E90-27A619384B81', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" - ."\n" - .'* true: successful.'."\n" - .'* false: failed.'."\n", - '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' => 'DeleteMetricRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMetricRuleResources' => [ - 'summary' => 'Disassociates resources from an alert rule.', - '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' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rr-bp18017n6iolv****', - ], - ], - [ - 'name' => 'Resources', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resources that are associated with the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{"instanceId":"i-uf6hm9lnlzsarrc7****"}]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses 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 alert does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D8A35882-90C6-4F03-BBEB-153C180398EA', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - '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":"\\n\\t\\t0671A721-0D7A-4F11-BB77-2416325D65AB\\n\\t\\ttrue\\n\\t\\t200\\n","errorExample":""}]', - 'title' => 'DeleteMetricRuleResources', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'EnableMetricRules' => [ - 'summary' => 'Enables alert rules.', - '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' => 'The IDs of the alert rules.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - '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' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - '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":"\\n 200\\n success\\n FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\n true\\n","errorExample":""}]', - 'title' => 'EnableMetricRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DisableMetricRules' => [ - 'summary' => 'Disables alert rules.', - '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' => 'The ID of the alert rule. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - ], - 'required' => true, - 'example' => 'detect_87****_HTTP_HttpLatency', - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses 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' => 'RuleId is mandatory for this action.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - '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' => 'DisableMetricRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMetricRuleTargets' => [ - 'summary' => 'Queries the resources that are associated with a specified alert rule.', - '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' => 'The ID of the alert rule.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ae06917_75a8c43178ab66****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Targets' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Target' => [ - 'description' => 'The information about the resource for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Valid value: mns.'."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - .'* {regionId}: the region ID of the message queue or topic.'."\n" - .'* {Resource type}`: the type of the resource for which alerts are triggered. Valid values: - **queues** - **topics** {Resource name}: the name of the resource. - If the resource type is set to **queues**, the resource name is the name of the message queue. - If the resource type is set to **topics**, the resource name is the name of the topic.`'."\n", - 'type' => 'string', - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* INFO: information'."\n" - .'* WARN: warning'."\n" - .'* CRITICAL: critical'."\n", - 'type' => 'string', - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - '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":"\\n\\t786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\n\\t200\\n\\ttrue\\n\\t","errorExample":""}]', - 'title' => 'DescribeMetricRuleTargets', - 'description' => '## Limit'."\n" - ."\n" - .'This operation supports only Message Service (MNS) resources. '."\n" - ."\n" - .'>This topic provides an example on how to query the resources that are associated with an alert rule whose ID is `ae06917_75a8c43178ab66****`.', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMetricRuleCount' => [ - 'summary' => 'Queries the number of alert rules in each state.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MetricRuleCount' => [ - 'description' => 'The number of alert rules in each state.'."\n", - 'type' => 'object', - 'properties' => [ - 'Ok' => [ - 'description' => 'The number of alert rules without active alerts.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], - 'Nodata' => [ - 'description' => 'The number of alert rules without data.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Disable' => [ - 'description' => 'The number of disabled alert rules.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Total' => [ - 'description' => 'The total number of alert rules.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '45', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'trace_region' => ['description' => 'The deployment region of the target application when integrating with Managed Service for OpenTelemetry.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'trace_type' => ['description' => 'Settings for the Tracing Analysis protocol used when integrating with Managed Service for OpenTelemetry.'."\n" + .'Valid values:'."\n" + .'- OpenTelemetry'."\n" + .'- Zipkin'."\n" + .'- Jaeger.', 'type' => 'string', 'example' => 'OpenTelemetry', 'title' => ''], + 'safe_link' => ['description' => 'This parameter takes effect for SMTP monitoring tasks. Set this parameter to 1 to use a secure connection. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'enable_packet_capture' => ['description' => 'Specifies whether to enable packet capture for this task.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'use_private_crt' => ['title' => '', 'description' => 'Specifies whether to use a private certificate.', 'type' => 'boolean', 'example' => ''], + 'private_crt_file_name' => ['title' => '', 'description' => 'The certificate file name of the private certificate.', 'type' => 'string', 'example' => 'cert.pem'], + 'use_ssl' => ['title' => '', 'description' => 'Specifies whether to use an SSL connection when performing a TCP task.', 'type' => 'boolean', 'example' => 'tlsv1.0'], + 'max_tls_version' => ['title' => '', 'description' => 'The maximum TLS version.', 'type' => 'string', 'example' => 'tlsv1.3'], + 'server_name' => ['title' => '', 'description' => 'The Server Name Indication (SNI).', 'type' => 'string', 'example' => 'www.aliyun.com'], + 'supported_cipher_suits' => ['title' => '', 'description' => 'The supported cipher suites.', 'type' => 'string', 'example' => 'TLS_AES_256_GCM_SHA384'], + ], + 'title' => '', + 'example' => '', ], - 'Alarm' => [ - 'description' => 'The number of alert rules with active alerts.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', + 'TaskId' => ['description' => 'The ID of the monitoring task.', 'type' => 'string', 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', 'title' => ''], + 'TaskName' => ['description' => 'The name of the monitoring task.', 'type' => 'string', 'example' => 'test123', 'title' => ''], + 'TaskState' => ['description' => 'The status of the monitoring task. Valid values:'."\n" + ."\n" + .'- 1: Enabled.'."\n" + .'- 2: Disabled.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TaskType' => ['description' => 'The type of the monitoring task. Site monitoring task types include HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, and FTP.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'VpcConfig' => [ + 'description' => 'The VPC configuration for the internal network monitoring task.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where the target site of the internal network monitoring task is located.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The ID of the security group associated with the internal network monitoring task.', 'type' => 'string', 'example' => 'sg-xxxxxx', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the VPC associated with the internal network monitoring task.', 'type' => 'string', 'example' => 'vpc-xxxxxx', 'title' => ''], + 'VswitchId' => ['description' => 'The ID of the vSwitch associated with the internal network monitoring task.', 'type' => 'string', 'example' => 'vsw-xxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => ''], ], - 402 => [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'Task Id does not exist', 'description' => ''], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], ], 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n true\\n 200\\n FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\n \\n 40\\n 0\\n 45\\n 0\\n 5\\n \\n","errorExample":""}]', - 'title' => 'DescribeMetricRuleCount', - 'requestParamsDescription' => ' ', + 'title' => 'Query details of a site monitoring task', + 'description' => 'This topic provides an example on how to query the details of the site monitoring task `cc641dff-c19d-45f3-ad0a-818a0c4f****`. The response shows that the task name is `test123`, the monitored address is `https://aliyun.com`, and the carrier is `Alibaba`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAlertingMetricRuleResources' => [ - 'summary' => 'Queries the resources for which active alerts are triggered based on an alert rule.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-10-14T05:34:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-26T07:45:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-20T09:27:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-27T05:33:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-13T05:55:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-10T06:02:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-28T07:10:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-25T09:01:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-25T10:12:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-24T08:27:35.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ['createdAt' => '2024-09-23T08:45:00.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ['createdAt' => '2024-09-09T11:50:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-05T11:09:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-31T06:53:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-16T06:57:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-16T06:23:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-04T08:23:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-22T07:49:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-04T02:58:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-15T04:29:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-22T07:54:08.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-06T11:21:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-17T07:34:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-16T09:06:08.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-16T09:06:08.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": false,\\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}","type":"json"}]', + ], + 'DescribeSiteMonitorData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group. For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '7671****', - ], + 'schema' => ['description' => 'The type of the monitored object whose monitoring data is to be queried. Valid values:'."\n" + ."\n" + .'- metric'."\n" + ."\n" + .'- event', 'type' => 'string', 'required' => false, 'example' => 'metric', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The metric name. Valid values:'."\n" + ."\n" + .'- Availability'."\n" + ."\n" + .'- ResponseTime', 'type' => 'string', 'required' => true, 'example' => 'Availability', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The start of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" + ."\n" + .'- UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.', 'type' => 'string', 'required' => false, 'example' => '1551579637000', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_mns_new', - ], + 'schema' => ['description' => 'The end of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" + ."\n" + .'- UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.', 'type' => 'string', 'required' => false, 'example' => '1551581437000', 'title' => ''], ], [ - 'name' => 'Dimensions', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions that specify the resources whose monitoring data you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"userId\\":\\"120886317861****\\",\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\"}', - ], + 'schema' => ['description' => 'The statistical period. The value is an integral multiple of 60. Unit: seconds.'."\n" + ."\n" + .'> The default value equals the minimum interval at which detection requests are sent to the monitored address.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], [ - 'name' => 'AlertBeforeTime', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Queries the alerts that were triggered before the specified time. Timestamps in milliseconds are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1698827400000', - ], + 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => '49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****', 'title' => ''], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => ['description' => 'The number of data points to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0724011B-D9E0-4B2F-8C51-F17A894CC42C', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The resources that are associated with the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'ActiveMessages', - ], - 'RetryTimes' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'MetricValues' => [ - 'description' => 'The metric value that triggered the alert based on the alert rule. The value is a JSON string.'."\n", - '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' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_mns_new', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'test123456789', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', - ], - 'ProductCategory' => [ - 'description' => 'The type of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'mns', - ], - 'StartTime' => [ - 'description' => 'The time when the resource was associated with the alert rule. The value is a timestamp.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1622427900000', - ], - 'Resource' => [ - 'description' => 'The resources that are monitored.'."\n", - 'type' => 'string', - 'example' => 'userId=120886317861****,region=cn-huhehaote,queue=test-0128', - ], - 'LastModifyTime' => [ - 'description' => 'The time when the alert rule was last modified. The value is a timestamp.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1622827900000', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'> If the alert rule is associated with an application group, the ID of the application group is returned in this parameter.'."\n", - 'type' => 'string', - 'example' => '7671****', - ], - 'Dimensions' => [ - 'description' => 'The dimensions based on which the resources are queried.'."\n", - 'type' => 'string', - 'example' => '{\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\",\\"userId\\":\\"120886317861****\\"}', - ], - 'LastAlertTime' => [ - 'description' => 'The time when the last alert was triggered for the resource based on the alert rule. The value is a timestamp.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1622427900000', - ], - 'Level' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* 4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Statistics' => [ - 'description' => 'The method used to calculate the metric values that trigger alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'Enable' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Escalation' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The alert rule based on which the alert is triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'PreCondition' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* `>=`'."\n" - .'* `=`'."\n" - .'* `<=`'."\n" - .'* `>`'."\n" - .'* `<`'."\n" - .'* `!=`'."\n", - 'type' => 'string', - 'example' => '>=', - ], - 'Expression' => [ - 'description' => 'The description of the alert rule.'."\n" - ."\n" - .'> This parameter indicates the content of the alert rule. If the metric value meets the alert condition, an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '$Average>=10', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Tag' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => 'mns', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Level' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* 4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ExpressionListJoin' => [ - 'description' => 'The relationship between multiple metrics. Valid values:'."\n" - ."\n" - .'* &&: If all metrics meet the alert conditions, CloudMonitor sends alert notifications.'."\n" - .'* ||: If one of the metrics meets the alert conditions, CloudMonitor sends alert notifications.'."\n", - 'type' => 'string', - 'example' => '&&', - ], - 'ExpressionList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ExpressionList' => [ - 'description' => 'The description of the multi-metric alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Period' => [ - 'description' => 'The statistical period of the metric. Unit: seconds. The default value is the interval at which the monitoring data of the metric is collected.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'Statistics' => [ - 'description' => 'The statistical method of the alert level. Valid values:'."\n" - ."\n" - .'* Maximum'."\n" - .'* Minimum'."\n" - .'* Average'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '90', - ], - ], - ], - ], - ], - ], - 'ExpressionRaw' => [ - 'description' => 'The trigger conditions that are created by using expressions. You can use expressions to create trigger conditions in the following scenarios:'."\n" - ."\n" - .'* Set an alert blacklist for specific resources. For example, if you specify `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`, no alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 50.'."\n" - .'* Set a special alert threshold for a specified instance in the rule. For example, if you specify `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`, an alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 80 or the `average metric value` of other instances exceeds 50.'."\n" - .'* Limit the number of instances whose metric values exceed the threshold. For example, if you specify `count($Average > 20) > 3`, an alert is triggered only when the `average metric value` of more than three instances exceeds 20.'."\n", - 'type' => 'string', - 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'NextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => 'ea42e5220930ea42e522****', 'title' => ''], + 'Data' => ['description' => 'The monitoring data.', 'type' => 'string', 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3febb181-0d98-4af9-8b04-7faf36b048b9', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DescribeSiteMonitorData', + 'summary' => 'Queries the fine-grained monitoring data of a site monitoring task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The returned data contains a JSON string that may consist of several or all of the following parameters:'."\n" + ."\n" + .'- Error4XXRate: the percentage of detection results with 4XX status codes.'."\n" + ."\n" + .'- Error6XXRate: the percentage of detection results with 6XX status codes.'."\n" + ."\n" + .'- Error5XXRate: the percentage of detection results with 5XX status codes.'."\n" + ."\n" + .'- Error4XXNumber: the number of detection results with 4XX status codes.'."\n" + ."\n" + .'- Error5XXNumber: the number of detection results with 5XX status codes.'."\n" + ."\n" + .'- Error6XXNumber: the number of detection results with 6XX status codes.'."\n" + ."\n" + .'- Over5totalTime: the percentage of detection requests to which the response time exceeds 5,000 ms.'."\n" + ."\n" + .'- Over3totalTime: the percentage of detection requests to which the response time exceeds 3,000 ms.'."\n" + ."\n" + .'- Over2totalTime: the percentage of detection requests to which the response time exceeds 2,000 ms.'."\n" + ."\n" + .'- Over10FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 10%.'."\n" + ."\n" + .'- Over100FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 99%.'."\n" + ."\n" + .'- Over30FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 30%.'."\n" + ."\n" + .'- Over50FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 50%.'."\n" + ."\n" + .'- Over80FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 80%.'."\n" + ."\n" + .'- Over90FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 90%.'."\n" + ."\n" + .'- Over400NumberRate: the percentage of detection results with status codes that are greater than 400.'."\n" + ."\n" + .'- Over400NumberRate: the percentage of detection results with status codes that are greater than 500.'."\n" + ."\n" + .'- AvailableNumber: the number of available detection points.'."\n" + ."\n" + .'- UnavailableNumber: the number of unavailable detection points.'."\n" + ."\n" + .'- Availability: the availability rate.'."\n" + ."\n" + .'- Unavailability: the unavailability rate.'."\n" + ."\n" + .'- ErrorCodeMaximum: the maximum error code in the detection results that were returned in a specific period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the maximum error code is 404.'."\n" + ."\n" + .'- ErrorCodeMinimum: the minimum error code in the detection results returned in a monitoring period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the minimum error code is 200.'."\n" + ."\n" + .'> We recommend that you use the AvailableNumber, UnavailableNumber, Availability, Unavailability, ErrorCodeMaximum, or ErrorCodeMinimum metric, whose value is easy to calculate.', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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":"\\r\\n\\t0724011B-D9E0-4B2F-8C51-F17A894CC42C\\r\\n\\t\\r\\n\\t2\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tputNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t$Average>=10\\r\\n\\t\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\tmns\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tuserId=120886317861****,region=cn-huhehaote,queue=test-0128\\r\\n\\t\\t\\t1622427900000\\r\\n\\t\\t\\t{\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-0128\\\\\\"}\\r\\n\\t\\t\\t{\\\\\\"timestamp\\\\\\":1623727500000,\\\\\\"Sum\\\\\\":926,\\\\\\"value\\\\\\":463,\\\\\\"Maximum\\\\\\":463,\\\\\\"Minimum\\\\\\":463,\\\\\\"Average\\\\\\":463,\\\\\\"SampleCount\\\\\\":2,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-0128\\\\\\"}\\r\\n\\t\\t\\t1623727904000\\r\\n\\t\\t\\tAverage\\r\\n\\t\\t\\tacs_mns_new\\r\\n\\t\\t\\t7671****\\r\\n\\t\\t\\tActiveMessages\\r\\n\\t\\t\\t1622427900000\\r\\n\\t\\t\\tmns\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t3\\r\\n\\t\\t\\ttest123456789\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\t10\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tputNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t$Average>=10\\r\\n\\t\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t\\tmns\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tuserId=120886317861****,region=cn-huhehaote,queue=test-022401-1\\r\\n\\t\\t\\t1622427900000\\r\\n\\t\\t\\t{\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-022401-1\\\\\\"}\\r\\n\\t\\t\\t{\\\\\\"timestamp\\\\\\":1623727500000,\\\\\\"queue\\\\\\":\\\\\\"test-022401-1\\\\\\",\\\\\\"Maximum\\\\\\":349,\\\\\\"Minimum\\\\\\":349,\\\\\\"Sum\\\\\\":698,\\\\\\"value\\\\\\":349,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"Average\\\\\\":349,\\\\\\"SampleCount\\\\\\":2}\\r\\n\\t\\t\\t1623727904000\\r\\n\\t\\t\\tAverage\\r\\n\\t\\t\\tacs_mns_new\\r\\n\\t\\t\\t7671****\\r\\n\\t\\t\\tActiveMessages\\r\\n\\t\\t\\t1622427900000\\r\\n\\t\\t\\tmns\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t3\\r\\n\\t\\t\\ttest123456789\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\t10\\r\\n\\t\\t\\r\\n\\t\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeAlertingMetricRuleResources', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"ea42e5220930ea42e522****\\",\\n \\"Data\\": \\"[{\\\\\\"Maximum\\\\\\":247,\\\\\\"Mimimum\\\\\\":61,\\\\\\"Average\\\\\\":154,\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"taskId\\\\\\":\\\\\\"49f7b317-7645-4cc9-94fd-ea42e522****\\\\\\",\\\\\\"timestamp\\\\\\":1551581760000}]\\",\\n \\"RequestId\\": \\"3febb181-0d98-4af9-8b04-7faf36b048b9\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\"\\n}","type":"json"}]', ], - 'PutMetricRuleTargets' => [ - 'summary' => 'Adds or modifies the push channels of an alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSiteMonitorISPCityList' => [ + 'summary' => 'Queries the details of all carrier detection points by calling the DescribeSiteMonitorISPCityList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'Isp', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ae06917_75a8c43178ab66****', - ], + 'schema' => ['description' => 'The name or ID of the carrier detection point.'."\n" + ."\n" + .'> Fuzzy match is supported for carrier names.', 'type' => 'string', 'required' => false, 'example' => 'China Unicom', 'title' => ''], ], [ - 'name' => 'Targets', + 'name' => 'City', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n" - ."\n" - .'For more information about how to obtain the ID of the resource for which alerts are triggered, see [DescribeMetricRuleTargets](~~121592~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Simple Message Queue (formerly MNS) (SMQ), Auto Scaling, Simple Log Service, and Function Compute are supported.'."\n" - ."\n" - .'The following part describes the ARN of SMQ and the parameters in the ARN:'."\n" - ."\n" - .'`acs:mns:{regionId}:{userId}:/{Resource type}/{Resource name}/message`.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account that owns the resource.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n" - ."\n" - .'ARN of Auto Scaling:'."\n" - ."\n" - .'acs:ess:{regionId}:{userId}:scalingGroupId/{Scaling group ID}:scalingRuleId/{Scaling rule ID}'."\n" - ."\n" - .'ARN of Simple Log Service:'."\n" - ."\n" - .'acs:log:{regionId}:{userId}:project/{Project name}/logstore/{Logstore name}'."\n" - ."\n" - .'ARN of Function Compute:'."\n" - ."\n" - .'acs:fc:{regionId}:{userId}:services/{Service name}/functions/{Function name}'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The name or ID of the city where the carrier detection point resides.'."\n" + ."\n" + .'> Fuzzy match is supported for city names.', 'type' => 'string', 'required' => false, 'example' => 'Guiyang', 'title' => ''], + ], + [ + 'name' => 'IPV6', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query IPv6 probes. Valid values:'."\n" + .'- true (default): Queries IPv6 probes.'."\n" + .'- false: Does not query IPv6 probes.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'IPV4', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query IPv4 probes. Valid values:'."\n" + .'- true (default): Queries IPv4 probes.'."\n" + .'- false: Does not query IPv4 probes.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ViewAll', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return all detection points. Valid values:'."\n" + ."\n" + .'- true (default): Returns all detection points.'."\n" + .'- false: Returns only available detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\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 returned.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A569B0D-9055-58AF-9E82-BAEAF95C0FD5', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailData' => [ - 'description' => 'The failed data.'."\n", + 'Code' => ['description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B35D7D84-547B-4E61-B909-48A1F8A0C756', 'title' => ''], + 'Success' => ['description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IspCityList' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Targets' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Target' => [ - 'description' => 'The information about the resources for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", + 'IspCity' => [ + 'description' => '探测点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '探测点列表。', + 'type' => 'object', + 'properties' => [ + 'CityName.en' => ['description' => '城市名称（英文）。', 'type' => 'string', 'example' => 'Guiyang', 'title' => ''], + 'IPV4ProbeCount' => ['description' => 'IPv4探针数量。', 'type' => 'string', 'example' => '4', 'title' => ''], + 'City' => ['description' => '城市ID。', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Isp' => ['description' => '运营商ID。', 'type' => 'string', 'example' => '232', 'title' => ''], + 'CityName.zh_CN' => ['description' => '城市名称（简体中文）。'."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '贵阳市', 'title' => ''], + 'Region.zh_CN' => ['description' => '省份（简体中文）。'."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '贵州省', 'title' => ''], + 'IspName.zh_CN' => ['description' => '运营商名称（简体中文）。'."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '联通', 'title' => ''], + 'Country.en' => ['description' => '国家（英文）。', 'type' => 'string', 'example' => 'China', 'title' => ''], + 'IPV6ProbeCount' => ['description' => 'IPv6探针数量。', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Region' => ['description' => '省份代码。', 'type' => 'string', 'example' => '264', 'title' => ''], + 'Country' => ['description' => '国家代码。', 'type' => 'string', 'example' => '629', 'title' => ''], + 'IspName.en' => ['description' => '运营商名称（英文）。', 'type' => 'string', 'example' => 'China-Unicom', 'title' => ''], + 'Region.en' => ['description' => '省份（英文）。', 'type' => 'string', 'example' => 'Guizhou', 'title' => ''], + 'Country.zh_CN' => ['description' => '国家（简体中文）。'."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '中国', 'title' => ''], + 'Area.zh_CN' => ['description' => '区域（简体中文）。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '西南', 'title' => ''], + 'Area.en' => ['description' => '区域（汉语拼音）。', 'type' => 'string', 'example' => 'XiNan', 'title' => ''], + 'IPPool' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The ARN of the resource. Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. SMQ, Auto Scaling, Simple Log Service, and Function Compute are supported. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. The following part describes the ARN of SMQ and the parameters in the ARN:'."\n" - ."\n" - .'* {Service name abbreviation}: mns.'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => '["INFO", "WARN", "CRITICAL"]', + 'IPPool' => [ + 'description' => 'IP地址池。', + 'type' => 'array', + 'items' => ['description' => 'IP地址池。', 'type' => 'string', 'example' => '["192.68.XX.XX","192.68.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 200 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 400 => [ + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], - 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t6A569B0D-9055-58AF-9E82-BAEAF95C0FD5\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'PutMetricRuleTargets', - 'description' => '# [](#)'."\n" - ."\n" - .'This topic provides an example on how to associate an alert rule with a resource. In this example, the alert rule is `ae06917_75a8c43178ab66****`, the resource is `acs:mns:cn-hangzhou:120886317861****:/queues/test/message`, and the ID of the resource for which alerts are triggered is `1`. The response indicates that the resource is associated with the specified alert rule.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query details of all carrier detection points', + 'description' => '本文将提供一个示例，查询运营商“联通”在“贵阳市”的探测点详情。', + 'requestParamsDescription' => 'For details about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutResourceMetricRule' => [ - 'summary' => 'Configures an alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', + 'changeSet' => [ + ['createdAt' => '2021-10-28T06:46:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T06:46:29.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorISPCityList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorISPCityList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeSiteMonitorList' => [ + 'summary' => 'Queries the list of site monitoring tasks by calling the DescribeSiteMonitorList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'You can specify a new ID or the ID of an existing alert rule. For more information about how to query the IDs of alert rules, see [DescribeMetricRuleList](~~114941~~).'."\n" - ."\n" - .'> If you specify a new ID, a threshold-triggered alert rule is created.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'You can specify a new name or the name of an existing alert rule. For more information about how to query the names of alert rules, see [DescribeMetricRuleList](~~114941~~).'."\n" - ."\n" - .'> If you specify a new name, a threshold-triggered alert rule is created.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test123', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service. For more information about how to query the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> If you create a Prometheus alert rule for Hybrid Cloud Monitoring, you must set this parameter to `acs_prometheus`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. For more information about how to query metric names, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> If you create a Prometheus alert rule for Hybrid Cloud Monitoring, you must set this parameter to the name of the namespace. For more information about how to query the names of namespaces, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'Resources', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource information. Examples: `[{"instanceId":"i-uf6j91r34rnwawoo****"}]` and `[{"userId":"100931896542****"}]`.'."\n" - ."\n" - .'For more information about the supported dimensions that are used to query resources, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', - ], - ], - [ - 'name' => 'ContactGroups', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact groups. Alert notifications are sent to the alert contacts in the alert contact group.'."\n" - ."\n" - .'> An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ECS_Group', - ], - ], - [ - 'name' => 'Webhook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://alert.aliyun.com.com:8080/callback', - ], - ], - [ - 'name' => 'EffectiveInterval', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The period of time during which the alert rule is effective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], + 'schema' => ['description' => 'The ID of the site monitoring task.', 'type' => 'string', 'required' => false, 'example' => 'a1ecd34a-8157-44d9-b060-14950837****', 'title' => ''], ], [ - 'name' => 'NoEffectiveInterval', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The period of time during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-06:00', - ], + 'schema' => ['description' => 'The type of the site monitoring task. CloudMonitor supports the following types: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], ], [ - 'name' => 'SilenceTime', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400.'."\n" - ."\n" - .'> If an alert is not cleared after the mute period ends, CloudMonitor resends an alert notification.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - 'default' => '86400', - ], + 'schema' => ['description' => 'The keyword used to search for site monitoring tasks.'."\n" + ."\n" + .'> Fuzzy match is supported based on the task name or task address.', 'type' => 'string', 'required' => false, 'example' => 'site', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the metric. Unit: seconds. The default value is the interval at which the monitoring data of the metric is collected.'."\n" - ."\n" - .'> For more information about how to query the statistical periods of metrics, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Interval', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which alerts are triggered based on the alert rule. Unit: seconds.'."\n" - ."\n" - .'> For more information about how to query the statistical periods of metrics, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'EmailSubject', + 'name' => 'TaskState', 'in' => 'query', - 'schema' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 1: Normal.'."\n" + ."\n" + .'- 2: Disabled.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Escalations.Critical.Statistics', + 'name' => 'AgentGroup', 'in' => 'query', 'schema' => [ - 'description' => 'The statistical methods for Critical-level alerts.'."\n" + 'description' => 'The type of detection points used by the task. Valid values:'."\n" + ."\n" + .'- PC: PC-based detection points.'."\n" ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + .'- MOBILE: mobile-based detection points.'."\n" ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", + .'- FC: internal detection points.', 'type' => 'string', + 'enum' => ['PC', 'MOBILE', 'FC'], 'required' => false, - 'example' => 'Average', + 'example' => 'PC', + 'title' => '', ], ], - [ - 'name' => 'Escalations.Critical.ComparisonOperator', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid value:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SiteMonitors' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SiteMonitor' => [ + 'description' => 'The list of site monitoring tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'TaskType' => ['description' => 'The type of the site monitoring task. CloudMonitor supports the following types: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.', 'type' => 'string', 'example' => 'TCP', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the site monitoring task was last updated.', 'type' => 'string', 'example' => '2022-03-08 17:14:31', 'title' => ''], + 'Interval' => ['description' => 'The monitoring interval. Unit: minutes.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TaskState' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 1: Normal.'."\n" + ."\n" + .'- 2: Disabled.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2021-11-01 11:05:18', 'title' => ''], + 'TaskName' => ['description' => 'The name of the site monitoring task.', 'type' => 'string', 'example' => 'New monitoring task', 'title' => ''], + 'Address' => ['description' => 'The URL or IP address that is monitored by the task.', 'type' => 'string', 'example' => 'https://aliyun.com', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the site monitoring task.', 'type' => 'string', 'example' => 'f5783760-1b39-4b6b-80e8-453d962a****', 'title' => ''], + 'OptionsJson' => [ + 'description' => 'The extended options. Each monitoring type has different extended options. For more information, see [CreateSiteMonitor](~~115048~~).', + 'type' => 'object', + 'properties' => [ + 'password' => ['description' => 'The password for the SMTP, POP3, or FTP monitoring type.', 'type' => 'string', 'example' => '123****', 'title' => ''], + 'request_format' => ['description' => 'The format of the HTTP request content. Valid values:'."\n" + .'- hex: hexadecimal format.'."\n" + .'- txt: text format.', 'type' => 'string', 'example' => 'hex', 'title' => ''], + 'response_content' => ['description' => 'The matched response content.'."\n" + .'- Hexadecimal format: When the request content is a byte string that cannot be represented by printable characters, you can convert the byte string to a hexadecimal string. The conversion rule is as follows: each byte is converted to a two-character hexadecimal representation. For example, 1 byte (1B) is converted to `01` in hexadecimal, and 27 bytes (27B) is converted to `1B` in hexadecimal. The binary array (in Java format) `{(byte)1, (byte)27}` is converted to `011b` or `011B` in hexadecimal. Site monitoring is case-insensitive for hexadecimal values. Enter the string `011B` in the request content and set the request content format to hexadecimal.'."\n" + ."\n" + .'- Text format: plain text, which is a string composed of printable characters.', 'type' => 'string', 'example' => 'cf0f85', 'title' => ''], + 'failure_rate' => ['description' => 'The packet loss rate.'."\n" + ."\n" + .'> This parameter is applicable only to the PING monitoring type.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + 'time_out' => ['description' => 'The timeout period. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', 'title' => ''], + 'header' => ['description' => 'The HTTP request header. The format is `key1:value1`. Multiple headers are separated by line breaks.', 'type' => 'string', 'example' => 'testKey:testValue', 'title' => ''], + 'cookie' => ['description' => 'The cookie text for the HTTP request.', 'type' => 'string', 'example' => 'lang=en', 'title' => ''], + 'port' => ['description' => 'The port for the TCP, UDP, SMTP, or POP3 monitoring type.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'ping_num' => ['description' => 'The number of PING attempts.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'authentication' => ['description' => 'Specifies whether security authentication is enabled. Valid values:'."\n" + .'- 0: Enabled.'."\n" + .'- 1: Disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'http_method' => ['description' => 'The HTTP request method. Valid values:'."\n" + .'- get '."\n" + .'- post'."\n" + .'- head.', 'type' => 'string', 'example' => 'get', 'title' => ''], + 'match_rule' => ['description' => 'Specifies whether alert rules are included. Valid values:'."\n" + .'- 0: Included.'."\n" + .'- 1: Not included.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'dns_match_rule' => ['description' => 'The DNS matching rule. Valid values:'."\n" + ."\n" + .'- IN_DNS: The expected aliases or IP addresses are all included in the DNS response.'."\n" + .'- DNS_IN: All DNS responses are included in the expected aliases or IP addresses.'."\n" + .'- EQUAL: The DNS response exactly matches the expected aliases or IP addresses.'."\n" + .'- ANY: The DNS response and the expected aliases or IP addresses have an intersection.', 'type' => 'string', 'example' => 'IN_DNS', 'title' => ''], + 'request_content' => ['description' => 'The HTTP request content.', 'type' => 'string', 'example' => 'cf0f85', 'title' => ''], + 'username' => ['description' => 'The username for the FTP, SMTP, or POP3 monitoring type.', 'type' => 'string', 'example' => 'testUser', 'title' => ''], + 'response_format' => ['description' => 'The format of the HTTP response content. Valid values:'."\n" + .'- hex: hexadecimal format.'."\n" + .'- txt: text format.', 'type' => 'string', 'example' => 'hex', 'title' => ''], + 'dns_type' => ['description' => 'The DNS resolution type. This parameter is applicable only to the DNS monitoring type. Valid values:'."\n" + .'- A (default): specifies the IP address that corresponds to the hostname or domain name.'."\n" + .'- CNAME: maps multiple domain names to another domain name.'."\n" + .'- NS: specifies the DNS server that resolves the domain name.'."\n" + .'- MX: points the domain name to a mail server address.'."\n" + .'- TXT: the description of the hostname or domain name. The text length is limited to 512 bytes. This type is typically used for Sender Policy Framework (SPF) records for anti-spam purposes.'."\n" + .'- AAAA: the DNS record that resolves a domain name to an IPv6 address.', 'type' => 'string', 'example' => 'A', 'title' => ''], + 'dns_server' => ['description' => 'The domain name or IP address of the specified DNS server.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'enable_operator_dns' => ['description' => 'Specifies whether to use the carrier DNS. Valid values:'."\n" + .'- true (default): Uses the carrier DNS.'."\n" + .'- false: Does not use the carrier DNS. Uses the default DNS or the DNS of the specified server.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'attempts' => ['description' => 'The number of retries after a DNS failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'protocol' => ['description' => 'The DNS protocol type. Valid values:'."\n" + .'- udp (default)'."\n" + .'- tcp'."\n" + .'- tcp-tls.', 'type' => 'string', 'example' => 'udp', 'title' => ''], + 'proxy_protocol' => ['description' => 'Specifies whether ProxyProtocol is enabled. Valid values:'."\n" + .'- false (default): ProxyProtocol is disabled.'."\n" + .'- true: ProxyProtocol is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'acceptable_response_code' => ['description' => 'The acceptable status codes. '."\n" + ."\n" + .'> Use assertion configurations instead.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'isBase64Encode' => ['description' => 'Specifies whether to store the password after Base64 decoding. Valid values:'."\n" + .'- true: Stores the password after Base64 decoding.'."\n" + .'- false (default): Does not store the password after Base64 decoding.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'cert_verify' => ['description' => 'Specifies whether to verify the certificate. Valid values:'."\n" + .'- false (default): Skips certificate verification.'."\n" + .'- true: Verifies the certificate.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'unfollow_redirect' => ['description' => 'Specifies whether to follow redirects when a 301 or 302 status code is returned. Valid values:'."\n" + .'- true: Does not follow redirects.'."\n" + .'- false (default): Follows redirects.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'diagnosis_mtr' => ['description' => 'Specifies whether to enable automatic MTR network diagnostics after a task failure. Valid values:'."\n" + .'- false (default): Disables automatic MTR network diagnostics.'."\n" + .'- true: Enables automatic MTR network diagnostics.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'diagnosis_ping' => ['description' => 'Specifies whether to enable automatic Ping network latency detection after a monitoring task failure. Valid values:'."\n" + .'- false (default): Disabled.'."\n" + .'- true: Enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'retry_delay' => ['description' => 'The number of retries after a monitoring failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'assertions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'assertions' => [ + 'description' => 'The assertion configuration group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The assertion configuration group.', + 'type' => 'object', + 'properties' => [ + 'property' => ['description' => 'The parsing path for the assertion content.'."\n" + ."\n" + .'- If the assertion type is `body_json`, the path is a `json path`.'."\n" + ."\n" + .'- If the assertion type is `body_xml`, the path is an `xml path`.', 'type' => 'string', 'example' => 'json path', 'title' => ''], + 'type' => ['description' => 'The assertion type. Valid values:'."\n" + .'- response_time: determines whether the response time meets expectations.'."\n" + .'- status_code: determines whether the HTTP response status code meets expectations.'."\n" + .'- header: determines whether a field in the response header meets expectations.'."\n" + .'- body_text: determines whether the response body content meets expectations through text character matching.'."\n" + .'- body_json: determines whether the response body content meets expectations through JSON parsing (JSON Path).'."\n" + .'- body_xml: determines whether the response body content meets expectations through XML parsing (XPath).', 'type' => 'string', 'example' => 'response_time', 'title' => ''], + 'operator' => ['description' => 'The assertion comparison operator. Valid values:'."\n" + .'- contains: contains.'."\n" + .'- doesNotContain: does not contain.'."\n" + .'- matches: matches a regular expression.'."\n" + .'- doesNotMatch: does not match a regular expression.'."\n" + .'- is: equals (numeric or string).'."\n" + .'- isNot: does not equal.'."\n" + .'- lessThan: less than.'."\n" + .'- moreThan: greater than.', 'type' => 'string', 'example' => 'lessThan', 'title' => ''], + 'target' => ['description' => 'The target value or string for assertion comparison.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'AgentGroup' => ['description' => 'The type of detection point. Valid values:'."\n" + ."\n" + .'- PC: PC-based.'."\n" + .'- MOBILE: mobile-based.', 'type' => 'string', 'example' => 'PC', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ], [ - 'name' => 'Escalations.Critical.Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - 'name' => 'Escalations.Critical.Times', - 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - 'name' => 'Escalations.Warn.Statistics', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Warn-level alerts.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Query site monitoring tasks', + 'description' => 'This topic provides an example of how to query the list of site monitoring tasks for the current account. The response shows that the current account has one site monitoring task named `HanZhou_ECS2`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-05-07T03:43:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-22T07:54:08.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-17T07:34:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-05-30T06:34:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-16T09:06:08.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"New monitoring task\\",\\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}","type":"json"}]', + ], + 'DescribeSiteMonitorLog' => [ + 'summary' => 'Call the DescribeSiteMonitorLog operation to query the detection logs for a one-time detection task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Escalations.Warn.ComparisonOperator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid value:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Escalations.Warn.Threshold', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], + 'schema' => ['description' => 'The ID of the detection task. You can specify multiple task IDs. Separate them with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'afa5c3ce-f944-4363-9edb-ce919a29****', 'title' => ''], ], [ - 'name' => 'Escalations.Warn.Times', + 'name' => 'Isp', 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The carrier ID.', 'type' => 'string', 'required' => false, 'example' => '465', 'title' => ''], ], [ - 'name' => 'Escalations.Info.Statistics', + 'name' => 'City', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Info-level alerts.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], + 'schema' => ['description' => 'The city ID.', 'type' => 'string', 'required' => false, 'example' => '546', 'title' => ''], ], [ - 'name' => 'Escalations.Info.ComparisonOperator', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid value:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], + 'schema' => ['description' => 'The metric.'."\n" + ."\n" + .'Only the `ProbeLog` metric is supported.', 'type' => 'string', 'required' => false, 'example' => 'ProbeLog', 'title' => ''], ], [ - 'name' => 'Escalations.Info.Threshold', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Info-level alerts.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], + 'schema' => ['description' => 'The beginning of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970.'."\n" + ."\n" + .'- UTC format: YYYY-MM-DDThh:mm:ssZ.'."\n" + ."\n" + .'> * The start time and end time follow the (StartTime, EndTime] pattern. The value of StartTime cannot be the same as or later than the value of EndTime.
- Use UNIX timestamps to prevent time zone-related issues.
', 'type' => 'string', 'required' => false, 'example' => '1638422474389', 'title' => ''], ], [ - 'name' => 'Escalations.Info.Times', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The end of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970.'."\n" + ."\n" + .'- UTC format: YYYY-MM-DDThh:mm:ssZ.'."\n" + ."\n" + .'> Use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '1638422475687', 'title' => ''], ], [ - 'name' => 'NoDataPolicy', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid value:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KEEP_LAST_STATE', - ], + 'schema' => ['description' => 'If the response is truncated, use the `NextToken` parameter to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'IWBjqMYSy0is7zSMGu16****', 'title' => ''], ], [ - 'name' => 'CompositeExpression', + 'name' => 'Length', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The trigger conditions for multiple metrics.'."\n" - ."\n" - .'> The trigger conditions for a single metric and multiple metrics are mutually exclusive. You cannot specify trigger conditions for a single metric and multiple metrics at the same time.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExpressionList' => [ - 'description' => 'The trigger conditions that are created in standard mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The trigger conditions that are created in standard mode.', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - 'Period' => [ - 'description' => 'The aggregation period of the metric.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - 'Statistics' => [ - 'description' => 'The statistical method of the metric. Valid value:'."\n" - ."\n" - .'* $Maximum: the maximum value'."\n" - .'* $Minimum: the minimum value'."\n" - .'* $Average: the average value'."\n" - .'* $Availability: the availability rate (usually used for site monitoring)'."\n" - ."\n" - .'> `$` is the prefix of the metric. For information about the Alibaba Cloud services that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$Maximum', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid value:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ExpressionListJoin' => [ - 'description' => 'The relationship between the trigger conditions for multiple metrics. Valid value:'."\n" - ."\n" - .'* `&&`: An alert is triggered only if all metrics meet the trigger conditions. An alert is triggered only if the results of all expressions specified in the ExpressionList parameter are `true`.'."\n" - .'* `||`: An alert is triggered if one of the metrics meets the trigger conditions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '||', - ], - 'ExpressionRaw' => [ - 'description' => 'The trigger conditions that are created by using expressions. You can use expressions to create trigger conditions in the following scenarios:'."\n" - ."\n" - .'* Set an alert blacklist for specific resources. For example, if you specify `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`, no alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 50.'."\n" - .'* Set a special alert threshold for a specified instance in the rule. For example, if you specify `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`, an alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 80 or the `average metric value` of other instances exceeds 50.'."\n" - .'* Limit the number of instances whose metric values exceed the threshold. For example, if you specify `count($Average > 20) > 3`, an alert is triggered only when the `average metric value` of more than three instances exceeds 20.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* Critical'."\n" - .'* Warn'."\n" - .'* Info'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Critical', - ], - 'Times' => [ - 'description' => 'The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries to return on each page for a paged query. Valid values: 1 to 1440.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => 'The filter expression for detection results.'."\n" + ."\n" + .'Simple expressions are supported. For example, you can use the `TotalTime>100` expression to query the detection data whose total response time exceeds 100 milliseconds.', 'type' => 'string', 'required' => false, 'example' => 'TotalTime>100', 'title' => ''], ], [ - 'name' => 'Labels', + 'name' => 'BrowserInfo', 'in' => 'query', - 'style' => 'repeatList', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], + ], + [ + 'name' => 'Browser', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'If the metric meets the specified condition in the alert rule and CloudMonitor sends an alert notification, the tag is also written to the metric and displayed in the alert notification.'."\n" - ."\n" - .'> This parameter is equivalent to the Label parameter of Prometheus alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The key of the tag.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'> You can use a template parameter to specify a tag value. CloudMonitor replaces the value of the template parameter with an actual tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - 'required' => false, - ], + 'description' => 'The type of the browser.', + 'enumValueTitles' => [' Chrome' => 'Chrome', 'Safari' => 'Safari', 'Edge' => 'Edge', 'Firefox' => 'Firefox'], + 'type' => 'string', 'required' => false, - 'maxItems' => 20, + 'example' => 'Chrome', + 'title' => '', ], ], [ - 'name' => 'Prometheus', + 'name' => 'Device', 'in' => 'query', - 'style' => 'json', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Prometheus alerts.'."\n" - ."\n" - .'> This parameter is required only if you create a Prometheus alert rule for Hybrid Cloud Monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'PromQL' => [ - 'description' => 'PromQL statements are supported.'."\n" - ."\n" - .'> The data obtained by using the PromQL query statement is the monitoring data. You must include the alert threshold in this statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpuUsage{instanceId="xxxx"}[1m]>90', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* Critical'."\n" - .'* Warn'."\n" - .'* Info'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Critical', - ], - 'Times' => [ - 'description' => 'The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Annotations' => [ - 'description' => 'The annotations of the Prometheus alert rule. When a Prometheus alert is triggered, the system renders the annotated keys and values to help you understand the metrics and alert rule.'."\n" - ."\n" - .'> This parameter is equivalent to the annotations parameter of open source Prometheus.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The annotations of the Prometheus alert rule. When a Prometheus alert is triggered, the system renders the annotated keys and values to help you understand the metrics and alert rule.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the annotation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'summary', - ], - 'Value' => [ - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], + 'description' => 'The type of the device. This parameter specifies the screen size for impersonation.', + 'enumValueTitles' => ['tablet' => 'tablet', 'mobile' => 'mobile', 'laptop' => 'laptop'], + 'type' => 'string', 'required' => false, + 'example' => 'laptop', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'N/A', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9436', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'NextToken' => ['description' => 'The token that is used to query the next page.', 'type' => 'string', 'example' => 'IWBjqMYSy0is7zSMGu16****', 'title' => ''], + 'Data' => ['description' => 'The detection logs of the one-time detection task.', '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****\\"}]', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '67F646FA-ED8A-58C2-B461-451DB52C8B14', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the operation was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], ], - 429 => [ - [ - 'errorCode' => 'ResourceOverLimit', - 'errorMessage' => 'The resource has exceeded the limit. %s', - ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], - [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t200\\r\\n\\t\\r\\n\\t65D50468-ECEF-48F1-A6E1-D952E89D9436\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'PutResourceMetricRule', - 'description' => 'This topic provides an example on how to create a threshold-triggered alert rule for the `cpu_total` metric of an Elastic Compute Service (ECS) instance whose ID is `i-uf6j91r34rnwawoo****`. The namespace of ECS metrics is `acs_ecs_dashboard`. The alert contact group of the alert rule is `ECS_Group`. The name of the alert rule is `test123`. The ID of the alert rule is `a151cd6023eacee2f0978e03863cc1697c89508****`. The statistical method for Critical-level alerts is `Average`. The comparison operator for Critical-level alerts is `GreaterThanOrEqualToThreshold`. The threshold for Critical-level alerts is `90`. The consecutive number of times for which the metric value meets the trigger condition before a Critical-level alert is triggered is `3`.'."\n" + 'title' => 'DescribeSiteMonitorLog', + 'description' => 'Only Alibaba Cloud accounts with Network Analysis and Monitoring activated can create one-time detection tasks.'."\n" ."\n" - .'> Statistics verification was added on August 15, 2024. Only the statistical value of the corresponding metric can be set for the Statistics parameter. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PutResourceMetricRules' => [ - 'summary' => 'Creates multiple alert rules for the specified metric of a specified resource.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + .'This topic provides an example of how to query the detection logs for the one-time detection task `afa5c3ce-f944-4363-9edb-ce919a29****`.', + 'changeSet' => [ + ['createdAt' => '2023-08-22T07:49:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T11:31:12.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorLog'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'DescribeSiteMonitorQuota' => [ + 'summary' => 'Calls the DescribeSiteMonitorQuota operation to query the quota and version of site monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Rules', - 'in' => 'query', - 'style' => 'repeatList', + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The threshold-triggered alert rules.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The statistical methods for Warn-level alerts. Valid values:'."\n" + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" ."\n" - .'* Maximum: the maximum value'."\n" - .'* Minimum: the minimum value'."\n" - .'* Average: the average value'."\n" - .'* Availability: the availability rate'."\n" + .'> The value 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Request succeeded.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '26860260-76C6-404E-AB7A-EB98D36A6885', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" - .'Valid values of N: 1 to 500.'."\n" + .'- true: The operation was successful.'."\n" ."\n" - .'> You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Escalations.Info.Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'For information about how to query the name of a metric, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - 'Escalations.Warn.Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-06:00', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'You can specify a new ID or the ID of an existing alert rule. For information about how to query the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n" - ."\n" - .'> If you specify a new ID, a threshold-triggered alert rule is created.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', - ], - 'Escalations.Critical.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Escalations.Critical.Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'Escalations.Critical.Statistics' => [ - 'description' => 'The statistical methods for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Info.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Resources' => [ - 'description' => 'The information about the resource. Example: `[{"instanceId":"i-uf6j91r34rnwawoo****"}]` or `[{"userId":"100931896542****"}]`.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'For more information about the supported dimensions that are used to query resources, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', - ], - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds. Default value: 86400.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> If an alert is not cleared after the mute period ends, CloudMonitor resends an alert notification.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], - 'Webhook' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://alert.aliyun.com.com:8080/callback', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact groups. The alert notifications are sent to the alert contacts in the alert contact group.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Group', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'For information about how to query the namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - 'EmailSubject' => [ - 'description' => 'The subject of the alert notification email.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Period' => [ - 'description' => 'The statistical period of the metric.'."\n" - ."\n" - .'Unit: seconds. The default value is the interval at which the monitoring data of the metric is collected.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> For information about how to query the statistical period of a metric, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'You can specify a new name or the name of an existing alert rule. For information about how to query the name of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n" - ."\n" - .'> If you specify a new name, a threshold-triggered alert rule is created.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test123', - ], - 'Escalations.Info.Statistics' => [ - 'description' => 'The statistical methods for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Escalations.Info.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Interval' => [ - 'description' => 'The interval at which alerts are triggered based on the alert rule.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> For information about how to query the statistical period of a metric, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - 'Escalations.Critical.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Warn.Statistics' => [ - 'description' => 'The statistical methods for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The quota information.', + 'type' => 'object', + 'properties' => [ + 'SiteMonitorOperatorQuotaQuota' => ['description' => 'The quota of non-Alibaba detection points. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SecondMonitor' => ['description' => 'Indicates whether second-level monitoring is enabled. Valid values:'."\n" ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'NoDataPolicy' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values:'."\n" + .'- true: enabled.'."\n" ."\n" - .'* KEEP_LAST_STATE (default): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n" + .'- false: disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SiteMonitorQuotaTaskUsed' => ['description' => 'The number of used site monitoring detection task quotas.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'SiteMonitorTaskQuota' => ['description' => 'The quota of site monitoring detection tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'SiteMonitorVersion' => ['description' => 'The version of site monitoring. Valid values:'."\n" ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KEEP_LAST_STATE', - ], - 'Labels' => [ - 'description' => 'If the metric meets the specified condition in the alert rule and CloudMonitor sends an alert notification, the tag is also written to the metric and displayed in the alert notification.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'> You can use a template parameter to specify a tag value. CloudMonitor replaces the value of the template parameter with an actual tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, + .'- V1: the old version.'."\n" + .' '."\n" + .'- V2: the new version.', 'type' => 'string', 'example' => 'V1', 'title' => ''], + 'SiteMonitorIdcQuota' => ['description' => 'The quota of Alibaba detection points. The free quota is 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => true, - 'maxItems' => 500, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'staticInfo' => [], + 'title' => 'Queries the quota and version of site monitoring', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-27T07:31:02.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorQuota'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Request succeeded.\\",\\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}","type":"json"}]', + ], + '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' => 'The ID of the site monitoring task.'."\n" + ."\n" + .'For information about how to obtain the ID of a site monitoring task, see [DescribeSiteMonitorList](~~115052~~).', 'type' => 'string', 'required' => true, 'example' => 'ef4cdc8b-9dc7-43e7-810e-f950e56c****', 'title' => ''], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period.'."\n" + ."\n\n" + .'Unit: minutes. Default value: 1440 (1 day). Maximum value: 43200 (30 days).', 'type' => 'string', 'required' => false, 'example' => '1440', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'Unit: milliseconds. Default value: 1 hour before the current time.', 'type' => 'string', 'required' => false, 'example' => '1576142850527', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric. Valid values:'."\n" + ."\n" + .'- Availability: the availability.'."\n" + .'- ErrorRate: the error rate.'."\n" + .'- ResponseTime: the response time.', 'type' => 'string', 'required' => true, 'example' => 'Availability', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15D1440E-BF24-5A41-93E4-36864635179E', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailedListResult' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Target' => [ - 'description' => 'The alert rules that failed to be created for the resource.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', - ], - 'Result' => [ - 'description' => 'The alert rule that failed to be created.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + .'> The value 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Data' => ['description' => 'The statistical result.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '3AD2724D-E317-4BFB-B422-D6691D071BE1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 422 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], - [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\t\\r\\n\\t15D1440E-BF24-5A41-93E4-36864635179E\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'PutResourceMetricRules', - 'description' => 'This topic provides an example on how to create a threshold-triggered alert rule for the `cpu_total` metric of an Elastic Compute Service (ECS) instance whose ID is `i-uf6j91r34rnwawoo****`. The namespace of ECS metrics is `acs_ecs_dashboard`. The alert contact group of the alert rule is `ECS_Group`. The name of the alert rule is `test123`. The ID of the alert rule is `a151cd6023eacee2f0978e03863cc1697c89508****`. The statistical method for Critical-level alerts is `Average`. The comparison operator for Critical-level alerts is `GreaterThanOrEqualToThreshold`. The threshold for Critical-level alerts is `90`. The consecutive number of times for which the metric value meets the trigger condition before a Critical-level alert is triggered is `3`.'."\n" - ."\n" - .'> Statistics verification was added on August 15, 2024. Only the statistical value of the corresponding metric can be set for the Statistics parameter. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Queries the average statistics of a specified metric in a specified site monitoring task.', + 'summary' => 'Queries the average statistics of a specified metric in a specified site monitoring task by calling the DescribeSiteMonitorStatistics operation.', + 'description' => 'This topic provides an example on how to query the average statistics of the `Availability` metric in the site monitoring task whose ID is `ef4cdc8b-9dc7-43e7-810e-f950e56c****`. The returned result shows that the availability is `100`.'."\n" + ."\n\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutGroupMetricRule' => [ - 'summary' => 'Creates or modifies an alert rule for an application group.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorStatistics'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorStatistics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"100\\",\\n \\"RequestId\\": \\"3AD2724D-E317-4BFB-B422-D6691D071BE1\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'DescribeSyntheticProbeList' => [ + 'summary' => 'Queries a list of detection points.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Isp', 'in' => 'query', - 'schema' => [ - 'description' => 'The application group ID.'."\n" - ."\n" - .'For more information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '17285****', - ], + 'schema' => ['description' => 'The name or ID of the carrier.', 'type' => 'string', 'example' => 'China Unicom', 'required' => false, 'title' => ''], ], [ - 'name' => 'RuleId', + 'name' => 'City', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'* When you create an alert rule for the application group, enter the ID of the alert rule.'."\n" - .'* When you modify a specified alert rule in the application group, you must obtain the ID of the alert rule. For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The name or ID of the city where the carrier detection point is located.', 'type' => 'string', 'example' => 'Beijing', 'required' => false, 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'Ipv4', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => 'Specifies whether to return only IPv4 detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'RuleName', + 'name' => 'Ipv6', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'* When you create an alert rule for the application group, enter the name of the alert rule.'."\n" - .'* When you modify a specified alert rule in the application group, you must obtain the name of the alert rule. For more information about how to obtain the name of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Rule_01', - ], + 'schema' => ['description' => 'Specifies whether to return only IPv6 detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ViewAll', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'Specifies whether to return all detection points. Valid values:'."\n" + ."\n" + .'- false (default): Returns the detection points that are available to you.'."\n" + ."\n" + .'- true: Returns all detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'MbProbe', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only mobile detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'LmProbe', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only last-mile detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'IdcProbe', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only detection points in data centers.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'For more information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', + 'title' => '', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'IspCityList' => [ + 'description' => 'The list of detection points.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a detection point.', + 'type' => 'object', + 'properties' => [ + 'AreaCn' => ['description' => 'The name of the area in Chinese.', 'type' => 'string', 'example' => '华北', 'title' => ''], + 'AreaEn' => ['description' => 'The name of the area in English.', 'type' => 'string', 'example' => 'Huabei', 'title' => ''], + 'City' => ['description' => 'The city ID.', 'type' => 'string', 'example' => '738', 'title' => ''], + 'CityCn' => ['description' => 'The name of the city in Chinese.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'CityEn' => ['description' => 'The name of the city in English.', 'type' => 'string', 'example' => 'Beijing', 'title' => ''], + 'Country' => ['description' => 'The country code.', 'type' => 'string', 'example' => '629', 'title' => ''], + 'CountryCn' => ['description' => 'The name of the country in Chinese.', 'type' => 'string', 'example' => '中国', 'title' => ''], + 'CountryEn' => ['description' => 'The name of the country or region in English.', 'type' => 'string', 'example' => 'China', 'title' => ''], + 'IpPool' => [ + 'description' => 'The list of node IP addresses.', + 'type' => 'array', + 'items' => ['description' => 'The node IP address.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Isp' => ['description' => 'The carrier ID.', 'type' => 'string', 'example' => '232', 'title' => ''], + 'IspCn' => ['description' => 'The name of the carrier in Chinese.', 'type' => 'string', 'example' => '联通', 'title' => ''], + 'IspEn' => ['description' => 'The name of the carrier in English.', 'type' => 'string', 'example' => 'China-Unicom', 'title' => ''], + 'LmProbeCount' => ['description' => 'The number of last-mile detection points.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'MbProbeCount' => ['description' => 'The number of mobile detection points.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Region' => ['description' => 'The province code.', 'type' => 'string', 'example' => '264', 'title' => ''], + 'RegionCn' => ['description' => 'The name of the province in Chinese.', 'type' => 'string', 'example' => '江西省', 'title' => ''], + 'RegionEn' => ['description' => 'The name of the province in English.', 'type' => 'string', 'example' => 'Jiangxi', 'title' => ''], + 'IdcV4ProbeCount' => ['description' => 'The number of IPv4 detection points in data centers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IdcV6ProbeCount' => ['description' => 'The number of IDC IPv6 nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => 'DescribeSyntheticProbeList', + 'description' => 'This topic provides an example of how to call the DescribeSyntheticProbeList operation to query detection point details for the China Unicom carrier in Beijing.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSyntheticProbeList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:DescribeSyntheticProbeList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + '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' => 'The abbreviation of the service name.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the abbreviations of service names.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the system event.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the types of system events.', 'type' => 'string', 'required' => false, 'example' => 'Exception', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the system event.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the names of system events.', 'type' => 'string', 'required' => false, 'example' => 'BucketIngressBandwidth', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The level of the system event. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical'."\n" + ."\n" + .'- WARN: warning'."\n" + ."\n" + .'- INFO: information', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the system event.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the statuses of system events.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], + ], [ - 'name' => 'Dimensions', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The first-level dimension of the alert rule in the application group.'."\n" - ."\n" - .'Set the value to a set of key-value pairs, for example, `userId:120886317861****` or `instanceId:i-m5e1qg6uo38rztr4****`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12346', 'title' => ''], ], [ - 'name' => 'ExtraDimensionJson', + 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The second-level or third-level dimension of the alert rule in the application group.'."\n" - ."\n" - .'Set the value to a set of key-value pairs, for example, `port:80` or `/dev/xvda:d-m5e6yphgzn3aprwu****`.'."\n" - ."\n" - .'If the first-level dimension of the alert rule is `instanceId:i-m5e1qg6uo38rztr4****`, its second-level dimension is the `/dev/xvda:d-m5e6yphgzn3aprwu****` disk in the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}', - ], + 'schema' => ['description' => 'The keywords that are used to search for the system event. Valid values:'."\n" + ."\n" + .'- If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" + ."\n" + .'- If you want to search for the system event whose content contains a or b, set the value to `a or b`.', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], ], [ - 'name' => 'EffectiveInterval', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '05:31-23:59', - ], + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.', 'type' => 'string', 'required' => false, 'example' => '1552199984949', 'title' => ''], ], [ - 'name' => 'NoEffectiveInterval', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-05:30', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.', 'type' => 'string', 'required' => false, 'example' => '1552221584949', 'title' => ''], ], [ - 'name' => 'SilenceTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds. Default value: 86400.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n" + ."\n" + .'Valid values: 1 to 100000000.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The aggregation period of the metric data.'."\n" - ."\n" - .'Set the `Period` parameter to an integral multiple of 60. Unit: seconds. Default value: 300.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message that is returned. If the call is successful, `success` is returned. If the call fails, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values: True: The call is successful. false: The call fails.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'SystemEvents' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemEvent' => [ + 'description' => 'The details of the event.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the event.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'Time' => ['description' => 'The time when the event occurred. The value is a timestamp.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552199984000', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Product' => ['description' => 'The abbreviation of the service name.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'instanceId1', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'xxxxx-1', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'Agent_Status_Stopped', 'title' => ''], + 'Content' => ['description' => 'The details of the event.', '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"}]', 'title' => ''], + 'Level' => ['description' => 'The level of the event. Valid values:'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- INFO', 'type' => 'string', 'example' => 'WARN', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Id' => ['description' => 'The event ID.', 'type' => 'string', 'example' => 'b936efc9-f621-4e8a-a6eb-076be40e****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which CloudMonitor checks whether the alert rule is triggered. Unit: seconds.'."\n" - ."\n" - .'> We recommend that you set the interval to the data aggregation period. If the interval is shorter than the data aggregation period, alerts cannot be triggered due to insufficient data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeSystemEventAttribute', + 'summary' => 'Queries a system event.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-12-07T03:28:51.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSystemEventAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeSystemEventCount' => [ + 'summary' => 'Queries the number of events that occurred for each Alibaba Cloud service under the current account.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Webhook', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'The callback URL must be accessible over the Internet. CloudMonitor sends a POST request to push an alert notification to the callback URL that you specify. Only HTTP requests are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], + 'schema' => ['description' => 'The name of the Alibaba Cloud service.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `Product` response parameter, which provides the Alibaba Cloud service names for all events under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], [ - 'name' => 'EmailSubject', + 'name' => 'EventType', 'in' => 'query', - 'schema' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The event type.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `EventType` response parameter, which provides the event types for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'StatusNotification', 'title' => ''], ], [ - 'name' => 'ContactGroups', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], + 'schema' => ['description' => 'The event name.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `Name` response parameter, which provides the event names for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'Instance:StateChange', 'title' => ''], ], [ - 'name' => 'Escalations.Critical.Statistics', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Critical-level alerts. Separate multiple statistical methods with commas (,).'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], + 'schema' => ['description' => 'The event level. Valid values:'."\n" + ."\n" + .'- Critical: critical.'."\n" + ."\n" + .'- Warn: warning.'."\n" + ."\n" + .'- Info: information.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `Level` response parameter, which provides the event levels for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'Info', 'title' => ''], ], [ - 'name' => 'Escalations.Critical.ComparisonOperator', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], + 'schema' => ['description' => 'The event status.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `Status` response parameter, which provides the event statuses for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ - 'name' => 'Escalations.Critical.Threshold', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], + 'schema' => ['description' => 'The application group ID.', 'type' => 'string', 'required' => false, 'example' => '17285****', 'title' => ''], ], [ - 'name' => 'Escalations.Critical.Times', + 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The keywords contained in the event content for searching. Valid values:'."\n" + ."\n" + .'- To search for event content that contains both a and b, search for `a and b`.'."\n" + ."\n" + .'- To search for event content that contains either a or b, search for `a or b`.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], [ - 'name' => 'Escalations.Warn.Statistics', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Warn-level alerts. Separate multiple statistical methods with commas (,).'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], + 'schema' => ['description' => 'The timestamp of the start time for the event query. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1635993541000', 'title' => ''], ], [ - 'name' => 'Escalations.Warn.ComparisonOperator', + 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['description' => 'The timestamp of the end time for the event query. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1635993921000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'If the request is successful, a success message is returned. If the request fails, the failure reason is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: The operation is successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'SystemEventCounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemEventCount' => [ + 'description' => 'The event details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The event details.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The event status.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Time' => ['description' => 'The timestamp when the event occurred. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1635993751000', 'title' => ''], + 'GroupId' => ['description' => 'The application group ID.', 'type' => 'string', 'example' => '17285****', 'title' => ''], + 'Product' => ['description' => 'The Alibaba Cloud service name of the event.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'ECS-test', 'title' => ''], + 'Num' => ['description' => 'The number of events that occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'i-rj99xc6cptkk64ml****', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'Instance:StateChange', 'title' => ''], + 'Content' => ['description' => 'The event description.', 'type' => 'string', 'example' => 'Instance status change notification', 'title' => ''], + 'Level' => ['description' => 'The event level. Valid values:'."\n" + ."\n" + .'- Critical: critical.'."\n" + ."\n" + .'- Warn: warning.'."\n" + ."\n" + .'- Info: information.', 'type' => 'string', 'example' => 'Info', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'Escalations.Warn.Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Query the number of events for each Alibaba Cloud service under the current account', + 'description' => '### Background information'."\n" + .'You can call [DescribeSystemEventMetaList](~~114972~~) to obtain the Alibaba Cloud services and their system events supported by CloudMonitor.'."\n" + .'### Operation description'."\n" + .'This topic provides an example of how to query the number of events that occurred for Elastic Compute Service (`ECS`) under the current account. The response shows that a total of 3 events occurred.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventCount'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSystemEventCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"Instance status change notification\\",\\n \\"Level\\": \\"Info\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSystemEventHistogram' => [ + 'summary' => 'Queries the number of times a system event occurred during each interval within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Escalations.Warn.Times', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The abbreviation of the service name.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the abbreviations of service names.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], ], [ - 'name' => 'Escalations.Info.Statistics', + 'name' => 'EventType', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Info-level alerts. Separate multiple statistical methods with commas (,).'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], + 'schema' => ['description' => 'The event type.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the types of system events.', 'type' => 'string', 'required' => false, 'example' => 'Exception', 'title' => ''], ], [ - 'name' => 'Escalations.Info.ComparisonOperator', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], + 'schema' => ['description' => 'The event name.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the names of system events.', 'type' => 'string', 'required' => false, 'example' => 'BucketIngressBandwidth', 'title' => ''], ], [ - 'name' => 'Escalations.Info.Threshold', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Info-level alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], + 'schema' => ['description' => 'The level of the event. Valid values:'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- INFO', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The event status.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the status of system events.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], ], [ - 'name' => 'Escalations.Info.Times', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'NoDataPolicy', + 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KEEP_LAST_STATE', - ], + 'schema' => ['description' => 'The keywords that are used to search for the system event. Valid values:'."\n" + ."\n" + .'- If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" + ."\n" + .'- If you want to search for the system event whose content contains a or b, set the value to `a or b`.', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], ], [ - 'name' => 'Labels', + 'name' => 'StartTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags of the alert rule.'."\n" - ."\n" - .'The specified tag is contained in alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, - ], + 'schema' => ['description' => 'The start time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552209685596', 'title' => ''], ], [ - 'name' => 'Options', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The end time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552220485596', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Result' => [ - 'description' => 'The result of the request.'."\n", + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'SystemEventHistograms' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => '123456', + 'SystemEventHistogram' => [ + 'description' => 'The information about the number of times the system event occurred during each interval of a time period.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552225753000', 'title' => ''], + 'StartTime' => ['description' => 'The start time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552225770000', 'title' => ''], + 'Count' => ['description' => 'The number of times the system event occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeSystemEventHistogram', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventHistogram'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSystemEventHistogram', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeSystemEventMetaList' => [ + 'summary' => 'Queries the meta information of system events by calling the DescribeSystemEventMetaList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 'AK' => [], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A6582C8B-E67C-4A19-BC15-EAEFEBDC7995', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The meta information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The event status.', 'type' => 'string', 'example' => 'failed', 'title' => ''], + 'EventType' => ['description' => 'The event type. Valid values:'."\n" + ."\n" + .'- StatusNotification: fault notification.'."\n" + ."\n" + .'- Exception: exception.'."\n" + ."\n" + .'- Maintenance: O&M.', 'type' => 'string', 'example' => 'Exception', 'title' => ''], + 'Product' => ['description' => 'The abbreviation of the product name.', 'type' => 'string', 'example' => 'ADS', 'title' => ''], + 'NameDesc' => ['description' => 'The description of the event name.', 'type' => 'string', 'example' => 'High query failure rate', 'title' => ''], + 'NameDesc.En' => ['description' => '英文事件名称的描述信息。', 'type' => 'string', 'example' => 'High query failure rate.', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'SelectFailureRate', 'title' => ''], + 'StatusDesc' => ['description' => 'The description of the event status.', 'type' => 'string', 'example' => 'Operation Failed', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical.'."\n" + .'- WARN: warning.'."\n" + .'- INFO: information.', 'type' => 'string', 'example' => 'INFO', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"\\r\\n\\t\\r\\n\\t461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t\\r\\n\\t\\t123456\\r\\n\\t\\r\\n","errorExample":""}]', - 'title' => 'PutGroupMetricRule', - 'description' => 'This topic provides an example on how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the `17285****` application group. The ID of the alert rule is `123456`. The name of the alert rule is `Rule_test`. The alert level is `Critical`. The statistical method is `Average`. The alert threshold comparator is `GreaterThanOrEqualToThreshold`. The alert threshold is `90`. The number of alert retries is `3`. The returned result shows that the alert rule is created and the alert rule ID is `123456`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Query meta information of system events', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteEventRuleTargets' => [ - 'summary' => 'Deletes the push channels of an event-triggered alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventMetaList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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\\": \\"High query failure rate\\",\\n \\"NameDesc.En\\": \\"High query failure rate.\\",\\n \\"Name\\": \\"SelectFailureRate\\",\\n \\"StatusDesc\\": \\"Operation Failed\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeTagKeyList' => [ + 'summary' => 'Calls the DescribeTagKeyList operation to query a list of tag keys.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n" - ."\n" - .'For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testRule', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Ids', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of event-triggered alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'required' => true, - 'maxItems' => 20, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '100', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -31064,99 +21007,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '7ADD7EFB-7555-4EC1-A3D9-F9955C189CCF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter PageSize is not valid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B04B8CF3-4489-432D-83BA-6F128E5F2293', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TagKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag keys.', + 'type' => 'array', + 'items' => ['description' => 'The tag keys.', 'type' => 'string', 'example' => 't0et07752s_', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successfull\\",\\n \\"RequestId\\": \\"142989D9-CC52-54D0-928D-2C9B1D9F051C\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteEventRuleTargets', - ], - 'DeleteEventRules' => [ - 'summary' => 'Deletes event-triggered alert rules.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query tag key list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTagKeyList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeTagKeyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'DescribeTagValueList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleNames', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The name of the alert rule. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'rule1', - ], - 'required' => true, - 'example' => 'rule1', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Starts from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '100', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'schema' => ['description' => 'The tag key.'."\n" + ."\n" + .'For more information about how to obtain the tag key, see [DescribeTagKeyList](~~145558~~).', 'type' => 'string', 'required' => true, 'example' => 'tagKey1', 'title' => ''], ], ], 'responses' => [ @@ -31164,94 +21108,101 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E5A72B5B-4F44-438C-B68A-147FD5DC53A8', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates a successful response.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B04B8CF3-4489-432D-83BA-6F128E4F2295', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TagValues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagValue' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'si-65d55ff37d6c4b4ea3b3', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeTagValueList', + 'summary' => 'Queries the tag values for a specified tag key.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTagValueList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeTagValueList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"45231A42-5A09-5AFF-953C-A5B3D4ED8925\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteEventRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + '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"}]', 'extraInfo' => ' ', ], - 'EnableEventRules' => [ - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeUnhealthyHostAvailability' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleNames', + 'name' => 'Id', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The task ID.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The name of the event-triggered alert rule. Valid values of N: 1 to 20.'."\n", - ], + 'items' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123***', 'title' => ''], 'required' => true, - 'example' => 'ruleName1', + 'example' => '123456', 'maxItems' => 20, + 'title' => '', ], ], ], @@ -31260,94 +21211,136 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '20F2896A-6684-4A04-8255-4155B1593C70', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: -true: The operation was successful. -false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'UnhealthyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeTaskInstance' => [ + 'description' => 'Information about the list of unhealthy servers.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123******', 'title' => ''], + 'InstanceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => 'A list of instance IDs.', + 'type' => 'array', + 'items' => ['description' => 'The instances.', 'type' => 'string', 'example' => 'i-*****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeUnhealthyHostAvailability', + 'summary' => 'Call the DescribeUnhealthyHostAvailability operation to query a list of unhealthy servers.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUnhealthyHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeUnhealthyHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"20F2896A-6684-4A04-8255-4155B1593C70\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'EnableEventRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + '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"}]', 'extraInfo' => ' ', ], - 'DisableEventRules' => [ - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DisableActiveMetricRule' => [ + 'summary' => 'Disables the initiative alert feature for a cloud service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleNames', + 'name' => 'Product', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The name of the event-triggered alert rule. Valid values of N: 1 to 20.'."\n", - ], - 'required' => true, - 'example' => 'ruleName1', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The cloud service for which you want to disable proactive alerting. Valid values:'."\n" + ."\n" + .'- ECS: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)'."\n" + ."\n" + .'- redis\\_standard: Redis Open-Source Edition (standard architecture)'."\n" + ."\n" + .'- redis\\_sharding: Redis Open-Source Edition (cluster architecture)'."\n" + ."\n" + .'- redis\\_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" + ."\n" + .'- mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" + ."\n" + .'- mongodb\\_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" + ."\n" + .'- hbase: ApsaraDB for HBase'."\n" + ."\n" + .'- elasticsearch: Elasticsearch'."\n" + ."\n" + .'- opensearch: OpenSearch', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], ], 'responses' => [ @@ -31355,107 +21348,99 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3FD0E8B5-F132-4F4E-A081-2878AF378B12', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DisableActiveMetricRule', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableActiveMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableActiveMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'DisableEventRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + '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"}]', ], - 'DescribeEventRuleAttribute' => [ - 'summary' => 'Queries the details of an event-triggered alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DisableEventRules' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'RuleName', + 'name' => 'RuleNames', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n" - ."\n" - .'For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).'."\n", - 'type' => 'string', + 'description' => 'The names of the event-triggered alert rules.', + 'type' => 'array', + 'items' => ['description' => 'The name of an event-triggered alert rule.', 'type' => 'string', 'required' => false, 'example' => 'ruleName1', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'testRule', - ], - ], - [ - 'name' => 'SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds. Default value: 86400, which indicates one day.'."\n" - ."\n" - .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86400', + 'example' => 'ruleName1', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -31464,571 +21449,490 @@ 'schema' => [ '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 alert does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9AA3F210-C03D-4C86-8DB6-21C84FF692A1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Result' => [ - 'description' => 'The details of the event-triggered alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'description' => 'The event type. Valid values:'."\n" - ."\n" - .'* SYSTEM: system event'."\n" - .'* CUSTOM: custom event'."\n", - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '3607****', - ], - 'Name' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'example' => 'test_DefaultEventRule_7378****', - ], - 'Description' => [ - 'description' => 'The description of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'example' => 'Default group event rule.', - ], - 'State' => [ - 'description' => 'The status of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* ENABLED'."\n" - .'* DISABLED'."\n", - 'type' => 'string', - 'example' => 'ENABLED', - ], - 'EventPattern' => [ - 'description' => 'The event pattern. This parameter describes the trigger conditions of an event.'."\n", - 'type' => 'object', - 'properties' => [ - 'Product' => [ - 'description' => 'The name of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'LevelList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'LevelList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The level of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => '["CRITICAL","WARN"] ', - ], - ], - ], - ], - 'StatusList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'StatusList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The status of the event.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - ], - ], - ], - 'NameList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NameList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => 'Agent_Status_Running', - ], - ], - ], - ], - 'EventTypeList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'EventTypeList' => [ - 'description' => 'The types of the event-triggered alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event-triggered alert rule.'."\n" - ."\n" - .'`*` indicates all types of alert rules.'."\n", - 'type' => 'string', - 'example' => '*', - ], - ], - ], - ], - 'SQLFilter' => [ - 'description' => 'Indicates that logs are filtered based on the specified SQL statement. If the specified conditions are met, an alert is triggered.'."\n", - 'type' => 'string', - 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', - ], - 'KeywordFilterObj' => [ - 'description' => 'The keyword for filtering.'."\n", - 'type' => 'object', - 'properties' => [ - 'Keywords' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'keyword' => [ - 'description' => 'The keywords that are used to match events.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The keyword.'."\n", - 'type' => 'string', - 'example' => 'VMException', - ], - ], - ], - ], - 'Relation' => [ - 'description' => 'The relationship between multiple keywords in a condition. Valid values:'."\n" - ."\n" - .'* OR: The relationship between keywords is OR.'."\n" - .'* NOT: The keyword is excluded. The value NOT indicates that all events that do not contain the keywords are matched.'."\n", - 'type' => 'string', - 'example' => 'OR', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3FD0E8B5-F132-4F4E-A081-2878AF378B12', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DisableEventRules', + 'summary' => 'Disables one or more event-triggered alert rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableEventRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableEventRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + '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"}]', + 'extraInfo' => ' ', + ], + 'DisableHostAvailability' => [ + 'summary' => 'Disables one or more specified availability monitoring jobs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the availability monitoring jobs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the availability monitoring job.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], + 'required' => true, + 'example' => '12345', + 'maxItems' => 20, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: true: success. false: failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DisableHostAvailability', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'HostAvailability', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], ], - '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":"\\r\\n\\t9AA3F210-C03D-4C86-8DB6-21C84FF692A1\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tAgent_Status_Running\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCRITICAL\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tCloudMonitor\\r\\n\\t\\t\\r\\n\\t\\tDefault group event rule\\r\\n\\t\\tSYSTEM\\r\\n\\t\\tENABLED\\r\\n\\t\\ttest_DefaultEventRule_7378****\\r\\n\\t\\t3607****\\r\\n\\t\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeEventRuleAttribute', - 'description' => 'This topic provides an example to show how to query the details of an event-triggered alert rule named `testRule`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + '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"}]', 'extraInfo' => ' ', ], - 'DescribeEventRuleList' => [ - 'summary' => 'Queries event-triggered alert rules.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DisableMetricRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'NamePrefix', + 'name' => 'RuleId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The prefix in the name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'description' => 'The IDs of the alert rules.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'uuid_a141b055483428c22bab05443287196afa42cb6146', 'title' => ''], + 'required' => true, + 'example' => 'detect_87****_HTTP_HttpLatency', + 'maxItems' => 100, + 'title' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. A value of \\`true\\` indicates success and a value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Pages start from page 1. Default value: 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7378****', + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DisableMetricRules', + 'summary' => 'You can call the DisableMetricRules operation to disable alert rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + '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"}]', + 'extraInfo' => ' ', + ], + 'DisableSiteMonitors' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IsEnable', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'- true (default)'."\n" - .'- false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The IDs of site monitoring tasks. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The event-triggered alert rules.'."\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 returned.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D0E6D82B-16B5-422A-8136-EE5BDC01E415', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '21', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EventRules' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The number of detection point records affected by the site monitoring task.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'EventRule' => [ - 'description' => 'The event-triggered alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'description' => 'The type of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* SYSTEM: system event-triggered alert rule'."\n" - .'* CUSTOM: custom event-triggered alert rule'."\n", - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'Description' => [ - 'description' => 'The description of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'example' => 'Default group event rule.', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '7378****', - ], - 'Name' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'example' => 'test_DefaultEventRule_7378****', - ], - 'State' => [ - 'description' => 'The status of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* ENABLED'."\n" - .'* DISABLED'."\n", - 'type' => 'string', - 'example' => 'ENABLED', - ], - 'EventPattern' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'EventPattern' => [ - 'description' => 'The mode of the event-triggered alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Product' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'LevelList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'LevelList' => [ - 'description' => 'The levels of the event-triggered alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The level of the event-triggered alert. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'CRITICAL', - ], - ], - ], - ], - 'EventTypeList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'EventTypeList' => [ - 'description' => 'The types of the event-triggered alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event-triggered alert rule.'."\n" - ."\n" - .'`*` indicates all types of alert rules.'."\n", - 'type' => 'string', - 'example' => '*', - ], - ], - ], - ], - 'NameList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NameList' => [ - 'description' => 'The event names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => '["Agent_Status_Stopped"]', - ], - ], - ], - ], - 'CustomFilters' => [ - 'description' => 'The custom filter conditions.'."\n", - 'type' => 'string', - 'example' => 'ECS123', - ], - 'KeywordFilter' => [ - 'description' => 'The keyword for filtering.'."\n", - 'type' => 'object', - 'properties' => [ - 'Keywords' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Keywords' => [ - 'description' => 'The keywords that are used to match events.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The keyword.'."\n", - 'type' => 'string', - 'example' => 'VMException', - ], - ], - ], - ], - 'Relation' => [ - 'description' => 'The relationship between multiple keywords in a condition. Valid values:'."\n" - ."\n" - .'* OR: The relationship between keywords is OR.'."\n" - .'* NOT: The keyword is excluded. The value NOT indicates that all events that do not contain the keywords are matched.'."\n", - 'type' => 'string', - 'example' => 'OR', - ], - ], - ], - 'SQLFilter' => [ - 'description' => 'Indicates that logs are filtered based on the specified SQL statement. If the specified conditions are met, an alert is triggered.'."\n", - 'type' => 'string', - 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', - ], - ], - ], - ], - ], - ], - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400', - ], - ], - ], - ], + 'count' => ['description' => 'The number of detection point records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'UnauthorizedTasks', 'errorMessage' => 'You are not permitted to operate the specified tasks.', 'description' => 'You are not permitted to operate the specified tasks.'], + ], + [ + ['errorCode' => 'TaskNotExist', 'errorMessage' => 'The specified task does not exist.', 'description' => 'The specified task does not exist.'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Disable one or more site monitoring tasks', + 'summary' => 'Disables one or more site monitoring tasks by calling the DisableSiteMonitors operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:22:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSiteMonitors'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableSiteMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3fcd12e7-d387-42ee-b77e-661c775bb17f\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","type":"json"}]', + ], + 'EnableActiveMetricRule' => [ + 'summary' => 'Enables the initiative alert feature for a cloud service.', + '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' => 'The cloud service for which you want to enable initiative alert. Valid values:'."\n" + ."\n" + .'- ECS: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)'."\n" + ."\n" + .'- redis\\_standard: Redis Open-Source Edition (standard architecture)'."\n" + ."\n" + .'- redis\\_sharding: Redis Open-Source Edition (cluster architecture)'."\n" + ."\n" + .'- redis\\_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" + ."\n" + .'- mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" + ."\n" + .'- mongodb\\_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" + ."\n" + .'- hbase: ApsaraDB for HBase'."\n" + ."\n" + .'- elasticsearch: Elasticsearch'."\n" + ."\n" + .'- opensearch: OpenSearch', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\r\\n\\tC8308712-6E7A-4FA0-82AC-80D018DAD168\\r\\n\\t3\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t*\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tCRITICAL\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t*\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tCloudMonitor\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tSYSTEM\\r\\n\\t\\t\\tENABLED\\r\\n\\t\\t\\ttest123\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t*\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tCRITICAL\\r\\n\\t\\t\\t\\t\\tWARN\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t*\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tDefault group event rule.\\r\\n\\t\\t\\tSYSTEM\\r\\n\\t\\t\\tENABLED\\r\\n\\t\\t\\ttest_DefaultEventRule_7378****\\r\\n\\t\\t\\t7378****\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t*\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tCRITICAL\\r\\n\\t\\t\\t\\t\\tWARN\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t*\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tDefault group event rule.\\r\\n\\t\\t\\tSYSTEM\\r\\n\\t\\t\\tENABLED\\r\\n\\t\\t\\ttest123_DefaultEventRule_7301****\\r\\n\\t\\t\\t7301****\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeEventRuleList', + 'title' => 'EnableActiveMetricRule', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeEventRuleTargetList' => [ - 'summary' => 'Queries event-triggered alert rules.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableActiveMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableActiveMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'EnableEventRules' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'RuleName', + 'name' => 'RuleNames', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n", - 'type' => 'string', + 'description' => 'The names of the event rules to enable.', + 'type' => 'array', + 'items' => ['description' => 'The name of the event rule to enable.', 'type' => 'string', 'required' => false, 'example' => 'ruleName1', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'testRule', + 'example' => 'ruleName1', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -32037,2506 +21941,2235 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', - ], - 'ContactParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactParameter' => [ - 'description' => 'The information about the recipients if alert notifications are sent to the alert contacts of an alert contact group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'The name of the alert group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Level' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'4: Alert notifications are sent by using DingTalk chatbots and emails.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - ], - ], - 'FcParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'FCParameter' => [ - 'description' => 'The information about the recipients in Function Compute.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ServiceName' => [ - 'description' => 'The name of the Function Compute service.', - 'type' => 'string', - 'example' => 'service1', - ], - 'FunctionName' => [ - 'description' => 'The name of the function.', - 'type' => 'string', - 'example' => 'fcTest1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the function. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: '."\n" - ."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID', - 'type' => 'string', - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.', - 'type' => 'string', - 'example' => '3', - ], - 'Region' => [ - 'description' => 'The region where Function Compute is deployed.', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - ], - ], - ], - ], - ], - 'MnsParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MnsParameter' => [ - 'description' => 'The notifications of Simple Message Queue (formerly MNS) (SMQ).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Queue' => [ - 'description' => 'The name of the SMQ queue.'."\n", - 'type' => 'string', - 'example' => 'testQueue', - ], - 'Arn' => [ - 'description' => 'The ARN of the MNS queue. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: '."\n" - ."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID', - 'type' => 'string', - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', - ], - 'Region' => [ - 'description' => 'The region for SMQ.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Topic' => [ - 'description' => 'The SMQ topic.'."\n", - 'type' => 'string', - 'example' => 'topic_sample', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'WebhookParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'WebhookParameter' => [ - 'description' => 'The information about the recipients if alert notifications are sent by sending a request to a callback URL.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => 'The callback URL.', - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'Method' => [ - 'description' => 'The HTTP request method. Valid values: GET and POST.', - 'type' => 'string', - 'example' => 'GET', - ], - 'Protocol' => [ - 'description' => 'The protocol type.', - 'type' => 'string', - 'example' => 'HTTP', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.', - 'type' => 'string', - 'example' => '5', - ], - ], - ], - ], - ], - ], - 'SlsParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SlsParameter' => [ - 'description' => 'The information about the recipients in Log Service.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Project' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'example' => 'project_test', - ], - 'LogStore' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'example' => 'logstore_test', - ], - 'Arn' => [ - 'description' => 'The ARN of the Log Service Logstore. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: '."\n" - ."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID', - 'type' => 'string', - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***', - ], - 'Region' => [ - 'description' => 'The ID of the region where the Log Service project resides.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.', - 'type' => 'string', - 'example' => '4', - ], - ], - ], - ], - ], - ], - 'OpenApiParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'OpenApiParameters' => [ - 'description' => 'The information about the recipients in OpenAPI Explorer.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'The name of the API operation.', - 'type' => 'string', - 'example' => 'PutLogs', - ], - 'Arn' => [ - 'description' => 'The ARN of the API operation. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: '."\n" - ."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID The ARN of the Log Service Logstore. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:'."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID', - 'type' => 'string', - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.', - 'type' => 'string', - 'example' => '3', - ], - 'Product' => [ - 'description' => 'The ID of the cloud service to which the API operation belongs.', - 'type' => 'string', - 'example' => 'log', - ], - 'Region' => [ - 'description' => 'The region where the resource resides.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Role' => [ - 'description' => 'The name of the role.', - 'type' => 'string', - 'example' => 'MyRole', - ], - 'Version' => [ - 'description' => 'The version of the API.', - 'type' => 'string', - 'example' => '2019-01-01', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. It is a unique identifier generated by Alibaba Cloud. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '20F2896A-6684-4A04-8255-4155B1593C70', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'EnableEventRules', + 'summary' => 'The EnableEventRules operation enables one or more event rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableEventRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableEventRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t\\t87170bc7-e28a-4c93-b9bf-90a1dbe84736\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t默认告警通知组\\r\\n\\t\\t\\t\\t3\\r\\n\\t\\t\\t\\t1\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tproject_test\\r\\n\\t\\t\\t\\tlogstore_test\\r\\n\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\tacs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\r\\n\\t\\t\\t\\t2\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t200\\r\\n","errorExample":""}]', - 'title' => 'DescribeEventRuleTargetList', - 'description' => 'This topic provides an example to show how to query the details of an event-triggered alert rule named `testRule`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"20F2896A-6684-4A04-8255-4155B1593C70\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'PutEventRuleTargets' => [ - 'summary' => 'Adds or modifies the push channels of an event-triggered alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'EnableHostAvailability' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleName', + 'name' => 'Id', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', + 'description' => 'The ID of the availability monitoring task.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'testEventRule', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'FcParameters', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The information about the recipients in Function Compute.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FunctionName' => [ - 'description' => 'The name of the function. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fc-test', - ], - 'Region' => [ - 'description' => 'The region where Function Compute is deployed. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'ServiceName' => [ - 'description' => 'The name of the Function Compute service. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fc-test', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], - 'required' => false, - 'maxItems' => 5, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'ContactParameters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The information about the alert contact groups that receive alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'The name of the alert contact group. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'Level' => [ - 'description' => 'The alert notification methods. Valid values of N: 1 to 5. Valid values:'."\n" - ."\n" - .'4: Alert notifications are sent by using DingTalk and emails.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - ], - 'required' => false, + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Enable a specified availability monitoring task', + 'summary' => 'Enables a specified availability monitoring task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 5, ], ], + ], + '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\\": false\\n}","type":"json"}]', + ], + 'EnableMetricRuleBlackList' => [ + 'summary' => 'Enables or disables multiple blacklist policies at a time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MnsParameters', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The IDs of the blacklist policies. Separate multiple IDs with commas (,). You can specify up to 50 IDs.'."\n" + ."\n" + .'For information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n" + ."\n" + .'> You can also set this parameter to a JSON array. Example: `["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`.', 'type' => 'string', 'required' => true, 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', 'title' => ''], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the blacklist policy. Valid values:'."\n" + ."\n" + .'- true: The blacklist policy is enabled.'."\n" + ."\n" + .'- false (default): The blacklist policy is disabled.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The notifications of Simple Message Queue (formerly MNS) (SMQ).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'description' => 'The region for SMQ. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'Queue' => [ - 'description' => 'The name of the SMQ queue. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'queue1', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Topic' => [ - 'description' => 'The SMQ topic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'topic_sample', - ], - ], - 'required' => false, + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94869866-1621-3652-BBC9-72A47B2AC2F5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Count' => ['description' => 'The number of blacklist policies that are enabled or disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], - 'required' => false, - 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'WebhookParameters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The information about the callback URLs that are used to receive alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Protocol' => [ - 'description' => 'The name of the protocol. Valid values of N: 1 to 5. Valid values:'."\n" - ."\n" - .'* http'."\n" - .'* telnet'."\n" - .'* ping'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http', - ], - 'Url' => [ - 'description' => 'The callback URL. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], - 'Method' => [ - 'description' => 'The HTTP request method. Valid values of N: 1 to 5.'."\n" - ."\n" - .'Valid values: GET and POST.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - ], - 'required' => false, + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'EnableMetricRuleBlackList', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetricRuleBlackList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 5, ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'EnableMetricRules' => [ + 'summary' => 'Enables alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SlsParameters', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'RuleId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The information about the recipients in Simple Log Service.'."\n", + 'description' => 'The IDs of the alert rules.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LogStore' => [ - 'description' => 'The name of the Simple Log Service Logstore. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testlogstore', - ], - 'Region' => [ - 'description' => 'The region where Simple Log Service is deployed. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'Project' => [ - 'description' => 'The name of the Simple Log Service project. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testproject', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, + 'items' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'GroupProcess_67800278_2FE7D515-4BBD-447B-BC1A-3F17ED49****', 'title' => ''], + 'required' => true, + 'example' => 'ab05733c97b7ce239fb1b53393dc1697c123****', + 'maxItems' => 100, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'required' => false, - 'maxItems' => 5, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 402 => [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], [ - 'name' => 'OpenApiParameters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The parameters of API callback notification.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PutLogs', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Valid values of N: 1 to 5. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:'."\n" - ."\n" - .'* Service: the code of a cloud service'."\n" - .'* Region: the region ID'."\n" - .'* Account: the ID of an Alibaba Cloud account'."\n" - .'* ResourceType: the resource type'."\n" - .'* ResourceId: the resource ID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications sent by an API callback.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Product' => [ - 'description' => 'The ID of the cloud service to which the API operation belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'log', - ], - 'Region' => [ - 'description' => 'The region where the resource resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'Role' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MyRole', - ], - 'Version' => [ - 'description' => 'The version of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-01', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. Specify the parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'EnableMetricRules', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 5, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + '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' => 'The ID of the site monitoring task. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ '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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '409C64DA-CF14-45DF-B463-471C790DD15A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailedParameterCount' => [ - 'description' => 'The number of resources that failed to be created or modified.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'FailedContactParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactParameter' => [ - 'description' => 'This parameter is returned if the specified alert contact groups in the request failed to be created or modified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Level' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'4: Alert notifications are sent by using DingTalk and emails.'."\n", - 'type' => 'string', - 'example' => '3', - ], - ], - ], - ], - ], - ], - 'FailedMnsParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MnsParameter' => [ - 'description' => 'This parameter is returned if the specified queues in the request failed to be created or modified in SMQ.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Queue' => [ - 'description' => 'The name of the MNS queue.'."\n", - 'type' => 'string', - 'example' => 'testQueue', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - ], - ], - 'FailedFcParameters' => [ + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The number of detection points that are affected by the site monitoring tasks.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'FcParameter' => [ - 'description' => 'This parameter is returned if the specified functions in the request failed to be created or modified in Function Compute.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ServiceName' => [ - 'description' => 'The name of the Function Compute service.'."\n", - 'type' => 'string', - 'example' => 'serviceTest1', - ], - 'FunctionName' => [ - 'description' => 'The name of the function.'."\n", - 'type' => 'string', - 'example' => 'functionTest1', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], + 'count' => ['description' => 'The number of detection points.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'RestrictedUser', 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code.', 'description' => ''], + ['errorCode' => 'UnauthorizedTasks', 'errorMessage' => 'You are not permitted to operate the specified tasks.', 'description' => 'You are not permitted to operate the specified tasks.'], + ], + [ + ['errorCode' => 'TaskNotExist', 'errorMessage' => 'The specified task does not exist.', 'description' => 'The specified task does not exist.'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t\\t681CC49A-DD28-4D11-B86F-19D3F71E0EAE\\n\\t\\t200\\n\\t\\ttrue\\n","errorExample":""}]', - 'title' => 'PutEventRuleTargets', + 'title' => 'EnableSiteMonitors', + 'summary' => 'Enables site monitoring tasks.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutEventRule' => [ - 'summary' => '创建或者修改事件监控', - 'methods' => [ - 'post', - 'get', - 'put', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:22:22.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-06-19T07:10:45.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSiteMonitors'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableSiteMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3fcd12e7-d387-42ee-b77e-661c775bb17f\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","type":"json"}]', + ], + 'InstallMonitoringAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'myRuleName', - ], - ], - [ - 'name' => 'GroupId', + 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group to which the event-triggered alert rule belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7378****', - ], + 'schema' => ['description' => 'Specifies whether to forcibly install the CloudMonitor agent. Valid values:'."\n" + ."\n" + .'- true (default): Forcibly installs the agent.'."\n" + ."\n" + .'- false: Does not forcibly install the agent.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], ], [ - 'name' => 'EventType', + 'name' => 'InstanceIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the event-triggered alert rule. Valid values:'."\n" + 'description' => 'The IDs of the Alibaba Cloud hosts.'."\n" ."\n" - .'* SYSTEM: system event-triggered alert rule'."\n" - .'* CUSTOM: custom event-triggered alert rule'."\n", - 'type' => 'string', + .'You can specify from 1 to 10 instance IDs.'."\n" + ."\n" + .'> You must specify either `InstallCommand` or `InstanceIds`.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the Alibaba Cloud host.'."\n" + ."\n" + .'You can specify from 1 to 10 instance IDs.'."\n" + ."\n" + .'> You must specify either `InstallCommand` or `InstanceIds`.', 'type' => 'string', 'required' => false, 'example' => 'i-m5e0k0bexac8tykr****', 'title' => ''], 'required' => false, - 'example' => 'SYSTEM', - 'default' => 'SYSTEM', - 'enum' => [ - 'SYSTEM', - 'CUSTOM', - ], + 'example' => 'i-m5e0k0bexac8tykr****', + 'maxItems' => 10, + 'title' => '', ], ], [ - 'name' => 'Description', + 'name' => 'InstallCommand', 'in' => 'query', + 'schema' => ['description' => 'The installation command. This command installs the CloudMonitor agent on all Alibaba Cloud hosts that belong to your Alibaba Cloud account. Valid values:'."\n" + ."\n" + .'- `onlyInstallNotHasAgent`: Installs the latest version of the CloudMonitor agent only on Alibaba Cloud hosts where the agent is not installed.'."\n" + ."\n" + .'- `onlyUpgradeAgent`: Upgrades the CloudMonitor agent only on Alibaba Cloud hosts where an earlier version of the agent is installed.'."\n" + ."\n" + .'- `installAndUpgrade`: Installs the latest version of the CloudMonitor agent on Alibaba Cloud hosts where the agent is not installed, and upgrades the agent on Alibaba Cloud hosts where an earlier version of the agent is installed.'."\n" + ."\n" + .'> If you set this parameter, the `InstanceIds` parameter is invalid.', 'type' => 'string', 'required' => false, 'example' => 'onlyInstallNotHasAgent', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C41945', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'State', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* ENABLED: enabled'."\n" - .'* DISABLED: disabled'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLED', - 'default' => 'ENABLED', - 'enum' => [ - 'ENABLED', - 'DISABLED', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'InstallMonitoringAgent', + 'summary' => 'Call the InstallMonitoringAgent operation to install the CloudMonitor agent on specified Alibaba Cloud hosts.', + 'description' => '## Prerequisites'."\n" + ."\n" + .'Ensure that Cloud Assistant is installed on the Alibaba Cloud host. For more information, see [Cloud Assistant overview](~~64601~~).'."\n" + ."\n" + .'## Background information'."\n" + ."\n" + .'This API applies only to Alibaba Cloud hosts, which are Elastic Compute Service (ECS) instances. The success rate for installing the CloudMonitor agent using this API is approximately 95%. If the installation fails, you must manually install the agent. For more information about how to install the CloudMonitor agent, see [Install and uninstall the C++ agent](~~183482~~).'."\n" + ."\n" + .'## Example'."\n" + ."\n" + .'This example shows how to forcibly install the latest version of the CloudMonitor agent on the ECS instance `i-m5e0k0bexac8tykr****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-11-16T08:56:27.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallMonitoringAgent'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:InstallMonitoringAgent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - [ - 'name' => 'EventPattern', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EventTypeList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event-triggered alert rule. Valid values of N: 1 to 50. Valid values:'."\n" - ."\n" - .'* StatusNotification: fault notifications'."\n" - .'* Exception: exceptions'."\n" - .'* Maintenance: O\\&M'."\n" - .'* \\*: all types'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exception', - ], - 'required' => false, - 'example' => 'Exception', - 'maxItems' => 5, - ], - 'StatusList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The status of the event-triggered alert rule. Valid values of N: 1 to 50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Failed', - ], - 'required' => false, - 'example' => 'Failed', - 'maxItems' => 5, - ], - 'Product' => [ - 'description' => 'The type of the cloud service. Valid values of N: 1 to 50.'."\n" - ."\n" - .'> You can call the DescribeSystemEventMetaList operation to query the cloud services that support event-triggered alerts. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - 'LevelList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The level of the event-triggered alert rule. Valid values of N: 1 to 50. Valid values:'."\n" - ."\n" - .'* CRITICAL: critical'."\n" - .'* WARN: warning'."\n" - .'* INFO: information'."\n" - .'* \\*: all levels'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', - ], - 'required' => false, - 'example' => 'CRITICAL', - 'maxItems' => 5, - ], - 'NameList' => [ - 'description' => '', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"0BDAF8A8-04DC-5F0C-90E4-724D42C41945\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyGroupMonitoringAgentProcess' => [ + 'summary' => 'Modifies process monitoring in an application group.', + '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' => 'The ID of the process monitoring task in the application group.', 'type' => 'string', 'required' => true, 'example' => '92E3065F-0980-4E31-9AA0-BA6****', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'example' => '6780****', 'title' => ''], + ], + [ + 'name' => 'MatchExpressFilterRelation', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated and does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'and', 'title' => ''], + ], + [ + 'name' => 'AlertConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The alert rule configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute for epoch. Valid values of N: 1 to 200.'."\n" + ."\n" + .'Unit: seconds. Minimum value: 3600 (1 hour). Default value: 86400 (1 day).'."\n" + .'> When monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute for epoch.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator for the Critical-level threshold. Valid values of N: 1 to 200. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week'."\n" + .'- LessThanLastWeek: less than the value at the same time last week'."\n" + .'- GreaterThanLastPeriod: greater than the value in the previous period'."\n" + .'- LessThanLastPeriod: less than the value in the previous period', 'type' => 'string', 'required' => true, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Times' => ['description' => 'The number of consecutive occurrences of the alert level. Valid values of N: 1 to 200. Default value: 3.'."\n" + ."\n" + .'> An alert is triggered only when the alert level consecutively occurs the specified number of times and the alert threshold is reached.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'EscalationsLevel' => ['description' => 'The alert level. Valid values of N: 1 to 200. Valid values:'."\n" + .'- critical (default): critical.'."\n" + .'- warn: warning.'."\n" + .'- info: information.', 'type' => 'string', 'required' => true, 'example' => 'warn', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The effective period of the alert rule. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => '00:00-22:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'This parameter is deprecated and does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => '00:00-05:30', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => true, 'example' => '5', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for alerts. Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Only Average is supported.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'TargetList' => [ + 'description' => 'None.', 'type' => 'array', 'items' => [ - 'description' => 'The name of the event-triggered alert rule. Valid values of N: 1 to 50.'."\n", - 'type' => 'string', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert trigger target.'."\n" + ."\n" + .'For information about how to obtain the ID of the alert trigger target, see [DescribeMetricRuleTargets](~~121592~~).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" + ."\n" + .'For information about how to obtain the resource ARN, see [DescribeMetricRuleTargets](~~121592~~).'."\n" + ."\n" + .'The ARN is in the format of `acs:{ServiceAbbreviation}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The parameters are described as follows:'."\n" + ."\n" + .'- {ServiceAbbreviation}: Only Simple Message Queue (formerly MNS) is supported.'."\n" + ."\n" + .'- {userId}: The Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: The region where the Simple Message Queue (formerly MNS) queue or topic resides.'."\n" + ."\n" + .'- {ResourceType}: The type of the resource that accepts alerts. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {ResourceName}: The resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], 'required' => false, - 'example' => 'Agent_Status_Stopped', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'Agent_Status_Stopped', - 'maxItems' => 20, - ], - 'CustomFilters' => [ - 'description' => 'The keyword that is used to filter events. If the content of an event contains the specified keyword, an alert is automatically triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Stopping', - ], - 'SQLFilter' => [ - 'description' => 'The SQL condition that is used to filter events. If the content of an event meets the specified SQL condition, an alert is automatically triggered.'."\n" - ."\n" - .'> The syntax of SQL event filtering is consistent with the query syntax of Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX and Executed', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 50, - ], - ], - [ - 'name' => 'SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', + 'maxItems' => 3, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'Data' => [ - 'description' => 'The number of event-triggered alert rules that were created or modified.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t\\t0B47C47B-E68A-4429-BB23-370E91889C7D\\n\\t\\t1\\n\\t\\t200\\n\\t\\ttrue\\n","errorExample":""}]', - 'title' => 'PutEventRule', - 'description' => 'If the specified rule name does not exist, an event-triggered alert rule is created. If the specified rule name exists, the specified event-triggered alert rule is modified.'."\n" - ."\n" - .'In this example, the `myRuleName` alert rule is created for the `ecs` cloud service.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Modify process monitoring in an application group', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutCustomEventRule' => [ - 'methods' => [ - 'post', - 'get', - 'put', + 'changeSet' => [ + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyGroupMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyGroupMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitoringAgentProcess', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ModifyHostAvailability' => [ + 'summary' => 'Modifies an availability monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group. For more information about how to obtain the group ID, see [DescribeCustomEventAttribute](~~115262~~).'."\n" - ."\n" - .'> The value 0 indicates that the reported custom event does not belong to any application Group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7378****', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'> You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CustomRuleId1', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'RuleName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CustomeRule', - ], + 'schema' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'EventName', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom event. For more information about how to obtain the event name, see [DescribeCustomEventAttribute](~~115262~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HostDown', - ], + 'schema' => ['description' => 'The name of the availability monitoring task.', 'type' => 'string', 'required' => true, 'example' => 'task2', 'title' => ''], ], [ - 'name' => 'ContactGroups', + 'name' => 'TaskScope', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact group that receives alert notifications. Separate multiple contact groups with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Group', - ], + 'schema' => ['description' => 'The detection scope of the availability monitoring task. Valid values:'."\n" + ."\n" + .'- GROUP: All ECS instances in the current application group are used as probes for the detection task.'."\n" + .'- GROUP_SPEC_INSTANCE: Specified ECS instances in the current application group are used as probes for the detection task. If you set this parameter to this value, you must also set InstanceList to specify the ECS instances that initiate detection.', 'type' => 'string', 'required' => false, 'default' => 'GROUP', 'example' => 'GROUP', 'title' => ''], ], [ - 'name' => 'Webhook', + 'name' => 'TaskOption.HttpURI', 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], + 'schema' => ['description' => 'The URI for HTTP or Telnet detection types.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com'."\n" + .'telnet://127.0.0.1:80', 'title' => ''], ], [ - 'name' => 'EffectiveInterval', + 'name' => 'TaskOption.TelnetOrPingHost', 'in' => 'query', - 'schema' => [ - 'description' => 'The time period during which the alert rule is effective. Valid values: 00:00 to 23:59.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], + 'schema' => ['description' => 'The domain name or address to detect.'."\n" + ."\n" + .'> If the detection task type is PING, you must set this parameter. For more information about how to set the detection task type, see [CreateHostAvailability](~~115317~~).', 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'TaskOption.HttpResponseCharset', 'in' => 'query', - 'schema' => [ - 'description' => 'The cycle that is used to aggregate monitoring data of the custom event. Unit: seconds. Set the value to an integral multiple of 60. Default value: 300.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - 'default' => '300', - ], + 'schema' => ['description' => 'The response character set for the HTTP detection type.'."\n" + ."\n" + .'> Only UTF-8 is supported.', 'type' => 'string', 'required' => false, 'example' => 'UTF-8', 'title' => ''], ], [ - 'name' => 'EmailSubject', + 'name' => 'TaskOption.HttpPostContent', 'in' => 'query', - 'schema' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The POST content of the HTTP detection request.', 'type' => 'string', 'required' => false, 'example' => 'params1=value1', 'title' => ''], ], [ - 'name' => 'Threshold', + 'name' => 'TaskOption.HttpResponseMatchContent', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '99', - ], + 'schema' => ['description' => 'The content to match in the HTTP detection response.', 'type' => 'string', 'required' => false, 'example' => 'ok', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'TaskOption.HttpMethod', 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* CRITICAL: critical issue'."\n" - .'* WARN: warning'."\n" - .'* INFO: information'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CRITICAL', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The value 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The request has failed due to a temporary failure of the server.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AD5DCD82-BD1C-405F-BAED-32302DE9F498', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - '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":"\\n\\tAD5DCD82-BD1C-405F-BAED-32302DE9F498\\n\\t200\\n\\ttrue\\n","errorExample":""}]', - 'title' => 'PutCustomEventRule', - 'description' => 'Before you call this operation, call the PutCustomEvent operation to report the monitoring data of the custom event. For more information, see [PutCustomEvent](~~115012~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateMetricRuleBlackList' => [ - 'summary' => 'Creates a blacklist policy.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'schema' => ['description' => 'The method for the detection type. Valid values:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD'."\n" + ."\n" + .'> If the detection task type is HTTP, you must set this parameter. For more information about how to set the detection task type, see [CreateHostAvailability](~~115317~~).', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'TaskOption.HttpNegative', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the blacklist policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Blacklist-01', - ], + 'schema' => ['description' => 'The alert rule for matching HTTP response content. Valid values:'."\n" + .'- true: An alert is triggered if the HTTP response content contains the specified alert rule.'."\n" + .'- false: An alert is triggered if the HTTP response content does not contain the specified alert rule.'."\n" + ."\n" + .'> If the detection task type is HTTP, you must set this parameter. For more information about how to set the detection task type, see [CreateHostAvailability](~~115317~~).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'TaskOption.HttpHeader', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The header of the HTTP request. The format is `Parameter:Value`. Separate multiple parameters with carriage returns. Example:'."\n" + .'```'."\n" + .'params1:value1'."\n" + .'params2:value2'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'params1:value1', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'TaskOption.Interval', 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The detection frequency. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.'."\n" + ."\n" + .'> Only CloudMonitor agent 3.5.1 or later supports this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], [ - 'name' => 'ScopeType', + 'name' => 'AlertConfig.NotifyType', 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the blacklist policy. Valid values:'."\n" - ."\n" - .'* USER (default): The blacklist policy takes effect only for the current Alibaba Cloud account.'."\n" - .'* GROUP: The blacklist policy takes effect only for the specified application group. For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER', - ], + 'schema' => ['description' => 'The alert notification type. Valid values:'."\n" + ."\n" + .'- 2: Phone call + text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 1: Text message + email + DingTalk chatbot.'."\n" + ."\n" + .'- 0: Email + DingTalk chatbot.'."\n" + ."\n\n" + .'0: Email + DingTalk chatbot.'."\n" + ."\n" + .'0: Email + DingTalk chatbot.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'ScopeValue', + 'name' => 'AlertConfig.StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group. The value of this parameter is a JSON array.'."\n" - ."\n" - .'> This parameter must be specified when `ScopeType` is set to `GROUP`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["67****","78****"]', - ], + 'schema' => ['description' => 'The start time when the alert takes effect. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert is effective from 00:00:00 to 22:00:00.'."\n" + ."\n" + .'> If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'EnableStartTime', + 'name' => 'AlertConfig.EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy starts to take effect.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640237400000', - ], + 'schema' => ['description' => 'The end time when the alert takes effect. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert is effective from 00:00:00 to 22:00:00.'."\n" + ."\n" + .'> If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', 'title' => ''], ], [ - 'name' => 'EnableEndTime', + 'name' => 'AlertConfig.SilenceTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy expires.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640608200000', - ], + 'schema' => ['description' => 'The mute period. Unit: seconds. Default value: 86400 (1 day).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], ], [ - 'name' => 'EffectiveTime', + 'name' => 'AlertConfig.WebHook', 'in' => 'query', - 'schema' => [ - 'description' => 'The time range within which the blacklist policy is effective.'."\n" - ."\n" - .'* If you do not configure this parameter, the blacklist policy is permanently effective.'."\n" - ."\n" - .'* If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples:'."\n" - ."\n" - .' * `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded.'."\n" - .' * `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '03:00-04:59', - ], + 'schema' => ['description' => 'The webhook address.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com/webhook.json', 'title' => ''], ], [ - 'name' => 'Instances', + 'name' => 'AlertConfigEscalationList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n", + 'description' => 'The alert configuration list.', 'type' => 'array', 'items' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n", - 'type' => 'string', + 'description' => 'The alert configuration list.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric for the alert. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- HttpStatus: HTTP status code.'."\n" + .'- HttpLatency: HTTP latency.'."\n" + .'- TelnetStatus: Telnet status code.'."\n" + .'- TelnetLatency: Telnet latency.'."\n" + .'- PingLostRate: PING packet loss rate.', 'type' => 'string', 'required' => true, 'example' => 'HttpStatus', 'title' => ''], + 'Value' => ['description' => 'The alert threshold. Valid values of N: 1 to 21.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Times' => ['description' => 'The number of alert retries. Valid values of N: 1 to 21.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Operator' => ['description' => 'The comparison operator for the alert rule. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Aggregate' => ['description' => 'The statistical method for the alert. Valid values of N: 1 to 21. The valid values vary based on the metric:'."\n" + ."\n" + .'- HttpStatus: Value.'."\n" + .'- HttpLatency: Average.'."\n" + .'- TelnetStatus: Value.'."\n" + .'- TelnetLatency: Average.'."\n" + .'- PingLostRate: Average.'."\n" + ."\n" + .'> The statistical method for status code metrics is the original value (Value). The statistical method for latency or packet loss rate metrics is the average value (Average).', 'type' => 'string', 'required' => false, 'example' => 'Value', 'title' => ''], + ], 'required' => false, - 'example' => '{"instancceId":"i-bp1ew0zfkjblsuwx****"}', + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 100, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Metrics', + 'name' => 'InstanceList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The metrics of the instance.'."\n" + 'description' => 'The list of ECS instances that initiate detection. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> If `TaskScope` is set to `GROUP_SPEC_INSTANCE`, you must set this parameter.', + 'type' => 'array', + 'items' => ['description' => 'The list of ECS instances that initiate detection. Valid values of N: 1 to 21.'."\n" ."\n" - .'* If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service.'."\n" - .'* If you configure this parameter, the blacklist policy applies only to the current metric.'."\n", + .'> If `TaskScope` is set to `GROUP_SPEC_INSTANCE`, you must set this parameter.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'required' => false, + 'example' => 'i-absdfkwl321****', + 'maxItems' => 1000, + 'title' => '', + ], + ], + [ + 'name' => 'AlertConfigTargetList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The alert trigger targets.', 'type' => 'array', 'items' => [ - 'description' => 'None'."\n", + 'description' => 'The alert trigger targets.', 'type' => 'object', 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'disk_utilization', - ], - 'Resource' => [ - 'description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"device":"C:"}', - ], + 'Id' => ['description' => 'The ID of the alert trigger target.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" + ."\n" + .'The format is `acs:{AbbreviatedCloudServiceName}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The following list describes the parameters:'."\n" + ."\n" + .'- {AbbreviatedCloudServiceName}: Only Simple Message Queue (formerly MNS) is supported.'."\n" + ."\n" + .'- {userId}: The Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: The region where the Simple Message Queue (formerly MNS) queue or topic resides.'."\n" + ."\n" + .'- {ResourceType}: The type of the resource that accepts alerts. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {ResourceName}: The name of the resource.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters for the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 request has failed due to a temporary failure of the server.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5C637FA3-3959-3352-8BE6-78CE2ED2D33D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The ID of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '16E815A3-47E1-4290-87F9-D5C99471FF45', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n 5C637FA3-3959-3352-8BE6-78CE2ED2D33D\\n 93514c96-ceb8-47d8-8ee3-93b6d98b****\\n true\\n","errorExample":""}]', - 'title' => 'CreateMetricRuleBlackList', - 'description' => '### Background information'."\n" - ."\n" - .'* CloudMonitor blocks alert notifications based on the blacklist policies that take effect. To block alert notifications when the value of a metric that belongs to a cloud service reaches the threshold that you specified, add the metric to a blacklist policy.'."\n" - .'* CloudMonitor allows you to create blacklist policies only based on threshold metrics. You cannot create blacklist policies based on system events. For more information about the cloud services and the thresholds of the metrics that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'ModifyMetricRuleBlackList' => [ - 'summary' => 'Modifies a blacklist policy.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify an availability monitoring task', + 'description' => 'This topic provides an example on how to change the name of availability monitoring task `12345` in application group `123456` to `task2`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"16E815A3-47E1-4290-87F9-D5C99471FF45\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ModifyHostInfo' => [ + 'summary' => 'Calls the ModifyHostInfo operation to modify the display information of a non-Alibaba Cloud host.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the blacklist policy.'."\n" - ."\n" - .'For information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', - ], + 'schema' => ['description' => 'The instance ID. Only non-Alibaba Cloud hosts are supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'host-R_NSWNV****', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'HostName', 'in' => 'query', + 'schema' => ['description' => 'The host name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'portalHost', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the blacklist policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Blacklist-02', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EBB5215C-44AB-4000-A2D7-48634FDC4F04', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. The value true indicates that the call was successful. The value false indicates that the call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Modify the display information of a non-Alibaba Cloud host', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHostInfo'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyHostInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"EBB5215C-44AB-4000-A2D7-48634FDC4F04\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + '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' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The name of the metric store.'."\n" + ."\n" + .'Format: consists of uppercase letters, lowercase letters, digits, and hyphens (-).'."\n" + ."\n" + .'For information about how to obtain the name of a metric store, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the cloud service. For example, ApsaraDB for Redis supports the standard architecture, the cluster architecture, and the read/write splitting architecture. In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The description of the metric store.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Alibaba Cloud product metric repository.', 'title' => ''], ], [ - 'name' => 'ScopeType', + 'name' => 'Spec', 'in' => 'query', 'schema' => [ - 'description' => 'The effective scope of the blacklist policy. Valid values:'."\n" + 'description' => 'The data storage duration. Valid values:'."\n" ."\n" - .'* USER: The blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" - .'* GROUP (default): The blacklist policy takes effect only within the specified application group. For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", + .'- cms.s1.large: 15 days.'."\n" + .'- cms.s1.xlarge: 32 days.'."\n" + .'- cms.s1.2xlarge: 63 days.'."\n" + .'- cms.s1.3xlarge: 93 days.'."\n" + .'- cms.s1.6xlarge: 185 days.'."\n" + .'- cms.s1.12xlarge: 376 days.'."\n" + ."\n" + .'For the prices of different storage duration specifications, see the **Pricing** section in [Dashboard](~~223532~~).', + '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'], 'type' => 'string', 'required' => false, - 'example' => 'USER', + 'docRequired' => false, + 'enum' => [], + 'example' => 'cms.s1.2xlarge', + 'title' => '', ], ], - [ - 'name' => 'ScopeValue', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The IDs of the application groups.'."\n" - ."\n" - .'> This parameter is required only when `ScopeType` is set to `GROUP`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["67****","78****"]', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '%s', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], [ - 'name' => 'EnableStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy starts to take effect.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640237400000', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Modify a metric store', + 'summary' => 'Calls the ModifyHybridMonitorNamespace operation to modify a metric store.', + 'description' => 'This topic provides an example on how to change the data storage duration of the metric store `aliyun` to `cms.s1.2xlarge`. The response shows that the metric store is modified.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-06-09T09:38:01.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-04-24T08:29:10.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorNamespace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'EnableEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy expires.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640608200000', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateCustomNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"%s\\",\\n \\"RequestId\\": \\"E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ModifyHybridMonitorSLSGroup' => [ + 'summary' => 'Modifies a Logstore group by calling the ModifyHybridMonitorSLSGroup operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'EffectiveTime', + 'name' => 'SLSGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The time range within which the blacklist policy is effective. Take note of the following information:'."\n" - ."\n" - .'* If you do not configure this parameter, the blacklist policy is permanently effective.'."\n" - ."\n" - .'* If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples:'."\n" - ."\n" - .' * `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded.'."\n" - .' * `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '03:00-04:59', - ], + 'schema' => ['description' => 'The name of the Logstore group.'."\n" + ."\n" + .'For information about how to obtain the name of a Logstore group, see [DescribeHybridMonitorSLSGroup](~~429526~~).', 'type' => 'string', 'required' => true, 'example' => 'Logstore_test', 'title' => ''], ], [ - 'name' => 'Instances', + 'name' => 'SLSGroupDescription', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"instancceId":"i-bp1ew0zfkjblsuwx****"}', - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The description of the Logstore group.', 'type' => 'string', 'required' => false, 'example' => 'Logstore group of Alibaba Cloud products.', 'title' => ''], ], [ - 'name' => 'Metrics', + 'name' => 'SLSGroupConfig', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The metrics of the instance.'."\n" + 'description' => 'The configurations of the Logstore group.'."\n" ."\n" - .'* If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service.'."\n" - .'* If you configure this parameter, the blacklist policy applies only to the current metric.'."\n", + .'Valid values of N: 1 to 25.', 'type' => 'array', 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'disk_utilization', - ], - 'Resource' => [ - 'description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"device":"C:"}', - ], + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => ['description' => 'The region.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The log project.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-project', 'title' => ''], + 'SLSLogstore' => ['description' => 'The Logstore.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'Logstore-aliyun-all', 'title' => ''], + 'SLSUserId' => ['description' => 'The member ID.'."\n" + ."\n" + .'Valid values of N: 1 to 25.'."\n" + ."\n" + .'When you invoke this operation by using a management account, you can associate the Alibaba Cloud services of any member in the resource folder with Hybrid Cloud Monitoring through cloud native mode. You can use the resource folder to monitor the Alibaba Cloud services of multiple accounts.'."\n" + ."\n" + .'> If a member uses CloudMonitor for the first time, make sure that the member has completed authorization for the CloudMonitor service-linked role (AliyunServiceRoleForCloudMonitor). For more information, see [CloudMonitor service-linked role](~~170423~~).', 'type' => 'string', 'required' => false, 'example' => '120886317861****', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], - 'required' => false, - 'maxItems' => 100, + 'required' => true, + 'maxItems' => 30, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error 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' => '008773AE-1D86-3231-90F9-1AF7F808F9CE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Count' => [ - 'description' => 'The number of blacklist policies that are modified.'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'NotFound.SLSGroup', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n 008773AE-1D86-3231-90F9-1AF7F808F9CE\\n true\\n 1\\n","errorExample":""}]', - 'title' => 'ModifyMetricRuleBlackList', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DeleteMetricRuleBlackList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify a logstore group', + 'description' => 'This topic provides an example on how to change the Logstore in the `aliyun-project` log project in the `ap-southeast-1` region of the Logstore group `Logstore_test` to `Logstore-aliyun-all`. The response shows that the Logstore group is modified.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorSLSGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:ModifyHybridMonitorSLSGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NotFound.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ModifyHybridMonitorTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The monitoring task ID.'."\n" + ."\n" + .'For information about how to obtain the monitoring task ID, see [DescribeHybridMonitorTaskList](~~428624~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '36****', 'title' => ''], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The monitoring task name.'."\n" + ."\n" + .'For information about how to obtain the monitoring task ID, see [DescribeHybridMonitorTaskList](~~428624~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SLS_task', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the monitoring task.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SLS log monitoring data.', 'title' => ''], + ], + [ + 'name' => 'CollectInterval', + 'in' => 'query', + 'schema' => ['description' => 'The collection interval of the metric. Valid values:'."\n" + ."\n" + .'- 15'."\n" + ."\n" + .'- 60'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'AttachLabels', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the blacklist policies. Separate multiple IDs with commas (,). You can specify up to 50 IDs.'."\n" - ."\n" - .'For more information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n" - ."\n" - .'> You can also set this parameter to a JSON array. Example: `["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', + 'description' => 'The tags of the metric.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The tag value of the metric.', 'type' => 'string', 'required' => false, 'example' => 'testValue', 'title' => ''], + 'Name' => ['description' => 'The tag key of the metric.', 'type' => 'string', 'required' => false, 'example' => 'app_service', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'SLSProcessConfig', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'The SLS log configuration.', '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.', + 'Filter' => [ + 'description' => 'The filter conditions for parameters in the SLS log.', + 'type' => 'object', + 'properties' => [ + 'Relation' => ['description' => 'The relationship between multiple filter conditions. Valid values:'."\n" + ."\n" + .'- and (default): Logs are processed only when all filter conditions are met.'."\n" + .'- or: Logs are processed when any filter condition is met.', 'type' => 'string', 'required' => false, 'example' => 'and', 'title' => ''], + 'Filters' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter to filter in the SLS log.', 'type' => 'string', 'required' => false, 'example' => 'code', 'title' => ''], + 'Operator' => [ + 'description' => 'The method used to filter parameter values in the SLS log. Valid values:'."\n" + .'- `contain`: contains.'."\n" + .'- `notContain`: does not contain.'."\n" + .'- `>`: greater than.'."\n" + .'- `<`: less than.'."\n" + .'- `=`: equal to.'."\n" + .'- `!=`: not equal to.'."\n" + .'- `>=`: greater than or equal to.'."\n" + .'- `<=`: less than or equal to.', + 'type' => 'string', + 'enum' => ['>', '>=', '=', '<=', '<', '!=', 'contain', 'notContain'], + 'required' => false, + 'example' => '=', + 'title' => '', + ], + 'Value' => ['description' => 'The filter value of the parameter in the SLS log.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B88D233C-A004-3AB8-AD9C-30CBDD4440C5', + 'Statistics' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter for SLS log statistics.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'The statistical method used to aggregate log data within a statistical period. Valid values:'."\n" + .'- count: counts the number of occurrences.'."\n" + .'- sum: calculates the sum.'."\n" + .'- avg: calculates the average.'."\n" + .'- max: returns the maximum value.'."\n" + .'- min: returns the minimum value.'."\n" + .'- value: samples within the period.'."\n" + .'- countps: calculates the per-second average of the count for the specified field within the statistical period.'."\n" + .'- sumps: calculates the per-second average of the sum for the specified field within the statistical period.'."\n" + .'- distinct: calculates the number of occurrences of the specified field after deduplication within the statistical period.'."\n" + .'- distribution: calculates the number of occurrences of field values within a specified range.'."\n" + .'- percentile: calculates the distribution value of field values, such as P50.', 'type' => 'string', 'required' => false, 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the SLS log statistics result.', 'type' => 'string', 'minLength' => 0, 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'level_count', 'title' => ''], + 'Parameter1' => ['description' => 'The statistical value of the SLS log.'."\n" + ."\n" + .'- If `Function` is set to `distribution`, this parameter specifies the lower limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 200.'."\n" + ."\n" + .'- If `Function` is set to `percentile`, this parameter specifies the percentile of the statistical distribution. For example, 0.5 indicates P50.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + 'Parameter2' => ['description' => 'The statistical value of the SLS log.'."\n" + ."\n" + .'> This parameter is required only when `Function` is set to `distribution`. It specifies the upper limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 299.', 'type' => 'string', 'required' => false, 'example' => '299', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'GroupBy' => [ + 'description' => 'Aggregates data by spatial dimension, which is equivalent to GROUP BY in SQL.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter for SLS log statistics.', 'type' => 'string', 'required' => false, 'example' => 'code', 'title' => ''], + 'Alias' => ['description' => 'The alias of the SLS log statistics result.', 'type' => 'string', 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'ApiResult', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Count' => [ - 'description' => 'The number of blacklist policies that are deleted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Express' => [ + 'description' => 'The arithmetic operation result of the extended field in the SLS log statistics result.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Express' => ['description' => 'The arithmetic operation result of the extended field in the SLS log statistics result.', 'type' => 'string', 'required' => false, 'example' => 'success_count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the arithmetic operation result of the extended field in the SLS log statistics result.', 'type' => 'string', 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'SuccRate', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Invalid.SLSConfig', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n B88D233C-A004-3AB8-AD9C-30CBDD4440C5\\n true\\n 1\\n","errorExample":""}]', - 'title' => 'DeleteMetricRuleBlackList', - 'summary' => 'Deletes multiple blacklist policies at a time.', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DescribeMetricRuleBlackList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify a monitoring task', + 'summary' => 'Modifies the metrics of a Simple Log Service (SLS) log monitoring task by calling the ModifyHybridMonitorTask operation.', + 'description' => 'This topic provides an example on how to change the collection interval of the SLS log monitoring task `36****` to `15` seconds. The response shows that the metric is modified.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-07-11T06:44:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-09T02:41:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorTask'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyHybridMonitorTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Invalid.SLSConfig\\",\\n \\"RequestId\\": \\"11145B76-566A-5D80-A8A3-FAD98D310079\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ModifyMetricRuleBlackList' => [ + 'summary' => 'Modifies a blacklist policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy expired.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The ID of the blacklist policy.'."\n" + ."\n" + .'For information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).', 'type' => 'string', 'required' => true, 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the blacklist policy.', 'type' => 'string', 'required' => true, 'example' => 'Blacklist-02', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The categories of the Alibaba Cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'DESC', - ], + 'schema' => ['description' => 'The category of the cloud service. For example, ApsaraDB for Redis supports the standard architecture, the cluster architecture, and the read/write splitting architecture. In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'ScopeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the blacklist policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The effective scope of the blacklist policy. Valid values:'."\n" + ."\n" + .'- USER: The blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" + ."\n" + .'- GROUP (default): The blacklist policy takes effect only within the specified application group. For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], ], [ - 'name' => 'Ids', + 'name' => 'ScopeValue', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The operation that you want to perform. Set the value to **DescribeMetricRuleBlackList**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The IDs of the application groups.'."\n" + ."\n" + .'> This parameter is required only when `ScopeType` is set to `GROUP`.', 'type' => 'string', 'required' => false, 'example' => '["67****","78****"]', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'EnableStartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the blacklist policy.'."\n" - ."\n" - .'This parameter supports fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Blacklist-01', - ], + 'schema' => ['description' => 'The timestamp when the blacklist policy starts to take effect.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640237400000', 'title' => ''], ], [ - 'name' => 'ScopeType', + 'name' => 'EnableEndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the blacklist policy. Valid values:'."\n" - ."\n" - .'* USER: The blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" - .'* GROUP: The blacklist policy takes effect only within the specified application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER', - ], + 'schema' => ['description' => 'The timestamp when the blacklist policy expires.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640608200000', 'title' => ''], ], [ - 'name' => 'IsEnable', + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => ['description' => 'The time range within which the blacklist policy is effective. Take note of the following information:'."\n" + ."\n" + .'- If you do not configure this parameter, the blacklist policy is permanently effective.'."\n" + ."\n" + .'- If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples:'."\n" + ."\n" + .' - `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded.'."\n" + ."\n" + .' - `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.', 'type' => 'string', 'required' => false, 'example' => '03:00-04:59', 'title' => ''], + ], + [ + 'name' => 'Instances', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The status of the blacklist policy. Valid values:'."\n" + 'description' => 'The IDs of the instances that belong to the specified cloud service.', + 'type' => 'array', + 'items' => ['description' => 'The IDs of the instances that belong to the specified cloud service.'."\n" ."\n" - .'* true: The blacklist policy is enabled.'."\n" - .'* false: The blacklist policy is disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + .'Valid values of N: 1 to 100.', 'type' => 'string', 'required' => false, 'example' => '{"instancceId":"i-bp1ew0zfkjblsuwx****"}', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InstanceIds', + 'name' => 'Metrics', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'flat', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the instances in the blacklist policy.'."\n" + 'description' => 'The metrics of the instance.'."\n" ."\n" - .'Valid values of N: 0 to 10.'."\n", + .'- If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service.'."\n" + ."\n" + .'- If you configure this parameter, the blacklist policy applies only to the current metric.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the instance in the blacklist policy.'."\n", - 'type' => 'string', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 10.', 'type' => 'string', 'required' => true, 'example' => 'disk_utilization', 'title' => ''], + 'Resource' => ['description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n" + ."\n" + .'Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => '{"device":"C:"}', 'title' => ''], + ], 'required' => false, - 'example' => 'i-2ze2d6j5uhg20x47****', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 10, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The categories of the Alibaba Cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'D63E76CB-29AA-5B9F-88CE-400A6F28D428', - ], - 'Total' => [ - 'description' => 'The timestamp when the blacklist policy was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DescribeMetricRuleBlackList' => [ - 'description' => 'The queried blacklist policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EffectiveTime' => [ - 'description' => 'The time range within which the blacklist policy is effective.'."\n", - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'UpdateTime' => [ - 'description' => 'The timestamp when the blacklist policy was modified.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1665718373000', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the blacklist policy was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1665714561000', - ], - 'ScopeType' => [ - 'description' => 'The effective scope of the blacklist policy. Valid values:'."\n" - ."\n" - .'* USER: The blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" - .'* GROUP: The blacklist policy takes effect only within the specified application group.'."\n", - 'type' => 'string', - 'example' => 'USER', - ], - 'IsEnable' => [ - 'description' => 'The status of the blacklist policy. Valid values:'."\n" - ."\n" - .'* true: The blacklist policy is enabled.'."\n" - .'* false: The blacklist policy is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'Category' => [ - 'description' => 'The category of the cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'EnableEndTime' => [ - 'description' => 'The timestamp when the blacklist policy started to take effect.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640608200000', - ], - 'Name' => [ - 'description' => 'The name of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => 'Blacklist-01', - ], - 'EnableStartTime' => [ - 'description' => 'The timestamp when the blacklist policy expired.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640237400000', - ], - 'Id' => [ - 'description' => 'The ID of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', - ], - 'Metrics' => [ - 'description' => 'The metrics of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Resource' => [ - 'description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n", - 'type' => 'string', - 'example' => '[{"device":"C:"}]', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'disk_utilization', - ], - ], - ], - ], - 'Instances' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n", - 'type' => 'string', - 'example' => 'i-rj99xc6cptkk64ml****', - ], - ], - 'ScopeValue' => [ - 'description' => 'The IDs of the application groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the application groups. The value of this parameter is a JSON array.'."\n" - ."\n" - .'> This parameter is returned only if the `ScopeType` parameter is set to `GROUP`.'."\n", - 'type' => 'string', - 'example' => '["67****","78****"]', - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The error code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '008773AE-1D86-3231-90F9-1AF7F808F9CE', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Count' => ['description' => 'The number of blacklist policies that are modified.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'ModifyMetricRuleBlackList', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMetricRuleBlackList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n D63E76CB-29AA-5B9F-88CE-400A6F28D428\\n 1\\n \\n USER\\n \\n i-rj99xc6cptkk64ml****\\n \\n true\\n \\n disk_utilization\\n \\n \\n ecs\\n 1635714561000\\n 1635718373000\\n 93514c96-ceb8-47d8-8ee3-93b6d98b****\\n acs_ecs_dashboard\\n Blacklist-01\\n \\n true\\n","errorExample":""}]', - 'title' => 'DescribeMetricRuleBlackList', - 'summary' => 'Queries blacklist policies.', - 'requestParamsDescription' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'EnableMetricRuleBlackList' => [ - 'summary' => 'Enables or disables multiple blacklist policies at a time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyMetricRuleTemplate' => [ + 'summary' => 'Modifies an alert template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the blacklist policies. Separate multiple IDs with commas (,). You can specify up to 50 IDs.'."\n" - ."\n" - .'For information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n" - ."\n" - .'> You can also set this parameter to a JSON array. Example: `["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', - ], + 'schema' => ['description' => 'The ID of the alert template.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'IsEnable', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert template.'."\n" + ."\n" + .'For information about how to obtain the name of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => false, 'example' => 'Template_123', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the alert template.', 'type' => 'string', 'required' => false, 'example' => 'ECS_template1', 'title' => ''], + ], + [ + 'name' => 'RestVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version of the alert template. The version changes with the number of times that the alert template is modified.'."\n" + ."\n" + .'For information about how to obtain the version of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AlertTemplates', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to enable the blacklist policy. Valid values:'."\n" - ."\n" - .'* true: The blacklist policy is enabled.'."\n" - .'* false (default): The blacklist policy is disabled.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', + 'description' => 'The details of the alert template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The version of the alert template. The version changes with the number of times that the alert template is modified.'."\n" + ."\n" + .'For information about how to obtain the version of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => ['description' => 'The threshold for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain metrics, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Escalations.Warn.Threshold' => ['description' => 'The threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> If the value is set to 300 seconds, the monitoring data is collected every 300 seconds. If the monitoring data is reported every 1 minute, the alert system calculates the average, maximum, and minimum values of the monitoring data of 5 minutes and checks whether the aggregated values exceed the threshold. To prevent unexpected alerts, we recommend that you set this parameter together with other parameters.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'Rule_123', 'title' => ''], + 'Escalations.Critical.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'Selector' => ['description' => 'The dimension of the alert. It is an extended field.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied.'."\n" + ."\n" + .'> For more information about the values of extended fields, see [DescribeMetricRuleTemplateAttribute](~~114979~~).', 'type' => 'string', 'required' => false, 'example' => '{"disk":"/"}', 'title' => ''], + 'Escalations.Info.Statistics' => ['description' => 'The statistical method for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Escalations.Info.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + 'Escalations.Critical.Threshold' => ['description' => 'The threshold for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'Escalations.Critical.Statistics' => ['description' => 'The statistical method for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Critical.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Warn.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Info.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Escalations.Warn.Statistics' => ['description' => 'The statistical method for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => '94869866-1621-3652-BBC9-72A47B2AC2F5', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Count' => [ - 'description' => 'The number of blacklist policies that are enabled or disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9E07117F-F6AE-4F1C-81E8-36FBB4892235', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalFailure', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'ModifyMetricRuleTemplate', + 'description' => 'This topic provides an example on how to modify an alert template whose version is `1` and ID is `123456`. The alert level is changed to `Critical`. The statistical method is changed to `Average`. The alert threshold comparator is changed to `GreaterThanOrEqualToThreshold`. The alert threshold is changed to `90`. The number of alert retries is changed to `3`. The response shows that the alert template is modified.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMetricRuleTemplate'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyMetricRuleTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n 94869866-1621-3652-BBC9-72A47B2AC2F5\\n true\\n 1\\n","errorExample":""}]', - 'title' => 'EnableMetricRuleBlackList', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"9E07117F-F6AE-4F1C-81E8-36FBB4892235\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DeleteContactGroup' => [ - 'summary' => 'Deletes an alert contact group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyMonitorGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ContactGroupName', + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => false, 'example' => 'ecs_group', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'contact_group_2019_templatedfkXQ', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'alarm_ecs_group', 'title' => ''], ], ], 'responses' => [ @@ -34544,98 +24177,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F722BE59-2400-4A64-9C1A-AD886AED9A69', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C85A2870-5DF4-4269-BC50-ECB5E4591A80', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ContactNotExists', - 'errorMessage' => 'ContactGroupName Not Exists', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'ModifyMonitorGroup', + 'summary' => 'You can call the ModifyMonitorGroup operation to modify an application group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMonitorGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyMonitorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroup', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], ], - '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":"\\n F722BE59-2400-4A64-9C1A-AD886AED9A69\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'DeleteContactGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + '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"}]', 'extraInfo' => ' ', ], - 'DeleteContact' => [ - 'summary' => 'Deletes an alert contact.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyMonitorGroupInstances' => [ + 'summary' => 'The ModifyMonitorGroupInstances operation modifies the resources in an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ContactName', + 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', + 'description' => 'The list of instances. You can specify up to 2,000 instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'HostName', 'title' => ''], + 'Category' => ['description' => 'The cloud service to which the resource instance belongs. The following cloud services are supported:'."\n" + ."\n" + .'- ECS (including Alibaba Cloud and third-party hosts)'."\n" + ."\n" + .'- ApsaraDB RDS'."\n" + ."\n" + .'- AnalyticDB'."\n" + ."\n" + .'- SLB'."\n" + ."\n" + .'- VPC (Elastic IP)'."\n" + ."\n" + .'- API Gateway'."\n" + ."\n" + .'- Alibaba Cloud CDN'."\n" + ."\n" + .'- Container Service for Swarm'."\n" + ."\n" + .'- DCDN'."\n" + ."\n" + .'- Anti-DDoS'."\n" + ."\n" + .'- EIP'."\n" + ."\n" + .'- Elasticsearch'."\n" + ."\n" + .'- E-MapReduce'."\n" + ."\n" + .'- Auto Scaling'."\n" + ."\n" + .'- ApsaraDB for HBase'."\n" + ."\n" + .'- IoT Edge'."\n" + ."\n" + .'- Kubernetes pod'."\n" + ."\n" + .'- ApsaraDB for Redis (sharded cluster)'."\n" + ."\n" + .'- ApsaraDB for Redis (read/write splitting)'."\n" + ."\n" + .'- ApsaraDB for Redis (Standard Edition)'."\n" + ."\n" + .'- ApsaraDB for Memcache'."\n" + ."\n" + .'- MNS'."\n" + ."\n" + .'- ApsaraDB for MongoDB (replica set)'."\n" + ."\n" + .'- ApsaraDB for MongoDB (sharded cluster)'."\n" + ."\n" + .'- ApsaraDB for MongoDB (sharded cluster)'."\n" + ."\n" + .'- MNS topic'."\n" + ."\n" + .'- OCS (ApsaraDB for Memcache of earlier versions)'."\n" + ."\n" + .'- OpenSearch'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- PolarDB'."\n" + ."\n" + .'- HybridDB for MySQL'."\n" + ."\n" + .'- Internet Shared Bandwidth'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- VPN Gateway', 'type' => 'string', 'required' => true, 'example' => 'ECS', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the resource instance.', 'type' => 'string', 'required' => true, 'example' => 'i-a2d5q7pm12****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'test-01', - 'docRequired' => true, + 'maxItems' => 2000, + 'title' => '', + 'example' => '', ], ], ], @@ -34644,98 +24350,148 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. A value of true indicates a success. A value of false indicates a failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ContactNotExists', - 'errorMessage' => 'ContactName does not exist.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceConflict', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n 50D4CFE1-01E5-4543-939C-18BC01E3EC1C\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'DeleteContact', + 'title' => 'ModifyMonitorGroupInstances', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeContactListByContactGroup' => [ - 'summary' => 'Queries the alert contacts in an alert contact group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMonitorGroupInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyMonitorGroupInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifySiteMonitor' => [ + 'summary' => 'Modifies a site monitoring task by calling the ModifySiteMonitor operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ContactGroupName', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CloudMonitor', - ], + 'schema' => ['description' => 'The URL or IP address of the monitoring task.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the monitoring task.', 'type' => 'string', 'required' => true, 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', 'title' => ''], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring task. The name must be 4 to 100 characters in length and can contain letters, digits, underscores (_), and Chinese characters.', 'type' => 'string', 'required' => false, 'example' => 'HanZhou_ECS2', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The monitoring frequency. Valid values: 1, 5, and 15. Unit: minutes. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IspCities', + 'in' => 'query', + 'schema' => ['description' => 'The detection point information. The value is in JSONArray format, for example: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`, where `city` corresponds to Beijing, Hangzhou, and Qingdao respectively.'."\n" + ."\n" + .'> You can call the DescribeSiteMonitorISPCityList operation to query detection point information. For more information, see [DescribeSiteMonitorISPCityList](~~115045~~). If this parameter is left empty, the system randomly selects three detection points.', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', 'title' => ''], + ], + [ + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => ['description' => 'The advanced extended options for the protocol type of the monitoring task. Different protocol types correspond to different extended options.', 'type' => 'string', 'required' => false, 'example' => '{"time_out":5000}', 'title' => ''], + ], + [ + 'name' => 'AlertIds', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule. The ID of an existing alert rule in CloudMonitor. You can call the DescribeMetricRuleList operation to query alert rule IDs. For more information, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => '49f7c317-7645-4cc9-94fd-ea42e122****', 'title' => ''], + ], + [ + 'name' => 'IntervalUnit', + 'in' => 'query', + 'schema' => ['description' => 'The unit of the monitoring metrics.'."\n" + ."\n" + .'Unit: milliseconds (ms).', 'type' => 'string', 'required' => false, 'example' => 'ms', 'title' => ''], + ], + [ + 'name' => 'CustomSchedule', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The custom monitoring schedule. You can select a specific time period from Monday to Sunday for monitoring.', 'type' => 'string', 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -34743,191 +24499,228 @@ 'schema' => [ '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 returned message.'."\n", - 'type' => 'string', - 'example' => 'The group is not exists.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Contacts' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the node task result.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Contact' => [ - 'description' => 'The alert contacts that receive alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the alert contact was modified.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552314252000', - ], - 'Name' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'CreateTime' => [ - 'description' => 'The time when the alert contact was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552314252000', - ], - 'Desc' => [ - 'description' => 'The description of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'Channels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mail' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'alice@example.com', - ], - 'AliIM' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n" - ."\n" - .'> This parameter can be returned only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'DingWebHook' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', - ], - 'SMS' => [ - 'description' => 'The mobile number of the alert contact.'."\n" - ."\n" - .'> This parameter can be returned only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '1333333****', - ], - ], - ], - ], - ], - ], + 'count' => ['description' => 'The number of monitoring tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address', 'description' => ''], + ['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed', 'description' => ''], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist', 'description' => ''], + ['errorCode' => 'OperatorInvalid', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat', 'description' => ''], + ['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error', 'description' => ''], + ['errorCode' => 'NameNotExists', 'errorMessage' => 'Task name not exists', 'description' => ''], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Invalid Isp.', 'description' => 'Invalid Isp'], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'RestrictedUser', 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code.', 'description' => ''], + ['errorCode' => 'UnauthorizedTasks', 'errorMessage' => 'You are not permitted to operate the specified tasks.', 'description' => 'You are not permitted to operate the specified tasks.'], + ], + [ + ['errorCode' => 'TaskNotExist', 'errorMessage' => 'The specified task does not exist.', 'description' => 'The specified task does not exist.'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternetServerError', 'errorMessage' => 'System internal error.', 'description' => 'System internal 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\\": \\"alice@example.com\\",\\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":"\\r\\n\\t96B41DE5-6DC9-4FAF-A790-3D4AA17C1F09\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t1604024233000\\r\\n\\t\\t\\t1604024233000\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tAlice\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeContactListByContactGroup', - 'requestParamsDescription' => ' ', + 'title' => 'Modify a site monitoring task', + 'requestParamsDescription' => 'Site monitoring supports the following eight task types. The extended options (OptionsJson) for each task type are described in the following tables.'."\n" + ."\n" + .'- HTTP.'."\n" + ."\n" + .'|Name |Type |Description|'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|http_method |String |The HTTP request method. Valid values: GET, POST, and HEAD. Default value: GET. |'."\n" + .'|header |String |Custom HTTP headers separated by line feeds (\\n).
Each header must comply with the HTTP protocol format (key-value pairs separated by a colon). |'."\n" + .'|cookie |String |The cookie, which follows the standard HTTP request format. |'."\n" + .'|request_content |String |The request content. Two formats are supported: JSON and form. If this parameter is not specified, the request does not contain a body. |'."\n" + .'|response_content |String |The expected response content. During monitoring, the first 64 bytes returned by the HTTP server are checked. |'."\n" + .'|match_rule |String |0: The monitoring is successful if the response does not contain response_content.
1: The monitoring is successful if the response contains response_content. |'."\n" + .'|username |String |If a username is provided, a BasicAuth header is included in the HTTP request. |'."\n" + .'|password |String |The password for HTTP request authentication. |'."\n" + .'|time_out |int |The timeout period. Unit: milliseconds. Default value: 5. |'."\n" + .'|max_redirect |int |The maximum number of redirects. The default value is 5 for ECS detection points and 2 for carrier detection points.
To disable redirects, set this parameter to 0.
Valid values: 0 to 50. |.'."\n" + ."\n" + .' '."\n" + .'- PING.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|failure_rate |int |If the PING failure rate exceeds this value, the monitoring fails and returns 610 (PingAllFail) or 615 (PingPartialFail).
Default value: 0.1. |'."\n" + .'|ping_num |int |The number of PING attempts. Default value: 20.
Valid values: 1 to 100. |.'."\n" + ."\n" + .'- DNS.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|dns_server |string |The address of the DNS server. The value can be a domain name or an IP address. |'."\n" + .'|dns_type |string |The DNS query type. Valid values: A, NS, CNAME, MX, TXT, and ANY. |'."\n" + .'|expect_value |string |The list of expected values separated by whitespace characters. |'."\n" + .'|match_rule |string |The relationship between the expected value list and the DNS list. If the specified relationship is not met, the monitoring fails.
Empty string or IN_DNS: The expected value list is a subset of the DNS list.
DNS_IN: The DNS list is a subset of the expected value list.
EQUAL: The DNS list is equal to the expected value list.
ANY: The DNS list and the expected value list have a non-empty intersection. |.'."\n" + ."\n" + .'- FTP.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |The port number of the FTP server. If this parameter is not specified, the default value is used. Default value for FTP: 21. Default value for FTPs: 990. |'."\n" + .'|username |string |The FTP username. If this parameter is not specified, anonymous login is used. |'."\n" + .'|password |string |The FTP password. |.'."\n" + ."\n" + .'- POP3/SMTP.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |The port number of the POP3 server. Default value for POP3: 110. Default value for POP3s: 995. |'."\n" + .'|username |string |The username for POP3/SMTP. |'."\n" + .'|password |string |The password for POP3/SMTP. |.'."\n" + ."\n" + .'- TCP/UDP.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |The port of the TCP/UDP server. |'."\n" + .'|request_content |string |The request content. If request_format is set to hex, the value of request_content is in hexadecimal compact format. |'."\n" + .'|request_format |string |If request_format is set to other values, request_content is sent to the TCP/UDP server as a plain string. |'."\n" + .'|response_content |string |The response content. If the content returned by the TCP/UDP server does not contain response_content, the monitoring fails.
If response_format is set to hex, the value of response_content is in hexadecimal compact format.
If response_content is set to other values, response_content is a plain string. |.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeContactGroupList' => [ - 'summary' => 'Call the DescribeContactGroupList interface to query the list of alarm contact groups.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:22:22.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-02-13T09:00:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-04T02:58:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-19T07:10:45.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-03T06:48:53.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySiteMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifySiteMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 1\\n }\\n}","type":"json"}]', + ], + 'PutContact' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'ContactName', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alice', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Describe', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The description of the alert contact.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS_Instance', 'title' => ''], + ], + [ + 'name' => 'Channels.SMS', + 'in' => 'query', + 'schema' => ['description' => 'The phone number of the alert contact. An activation link is sent to the phone number. The alert contact is added only after the link is activated.'."\n" + ."\n" + .'Specify at least one of the following contact methods: phone number, email address, DingTalk chatbot, or TradeManager.'."\n" + .'Specify at least one of the following contact methods: email address or DingTalk chatbot.'."\n" + .'Specify at least one of the following contact methods: email address or DingTalk chatbot..', 'type' => 'string', 'required' => false, 'example' => '1333333****', 'title' => ''], + ], + [ + 'name' => 'Channels.Mail', + 'in' => 'query', + 'schema' => ['description' => 'The email address of the alert contact. An activation link is sent to the email address. The alert contact is added only after the link is activated.'."\n" + ."\n" + .'Specify at least one of the following contact methods: phone number, email address, DingTalk chatbot, or TradeManager.'."\n" + .'Specify at least one of the following contact methods: email address or DingTalk chatbot.'."\n" + .'Specify at least one of the following contact methods: email address or DingTalk chatbot..', 'type' => 'string', 'required' => false, 'example' => 'test@aliyun.com', 'title' => ''], + ], + [ + 'name' => 'Channels.AliIM', + 'in' => 'query', + 'schema' => ['description' => 'The TradeManager ID of the alert contact.'."\n" + ."\n" + .'Specify at least one of the following contact methods: phone number, email address, DingTalk chatbot, or TradeManager.'."\n" + .'Specify at least one of the following contact methods: email address or DingTalk chatbot.'."\n" + .'Specify at least one of the following contact methods: email address or DingTalk chatbot..', 'type' => 'string', 'required' => false, 'example' => 'Jim', 'title' => ''], + ], + [ + 'name' => 'Channels.DingWebHook', + 'in' => 'query', + 'schema' => ['description' => 'The webhook URL of the DingTalk chatbot.'."\n" + ."\n" + .'Specify at least one of the following contact methods: phone number, email address, DingTalk chatbot, or TradeManager.'."\n" + .'Specify at least one of the following contact methods: email address or DingTalk chatbot.'."\n" + .'Specify at least one of the following contact methods: email address or DingTalk chatbot..', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=7d49515e8ebf21106a80a9cc4bb3d247771305d52fb15d6201234565****', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language in which alert notifications are sent. Valid values:'."\n" + .'- zh-cn: simplified Chinese.'."\n" + .'- en: English.'."\n" + ."\n" + .'> If you do not set this parameter, the language is automatically determined based on the region of the account.', 'type' => 'string', 'required' => false, 'example' => 'zh-cn', 'title' => ''], ], ], 'responses' => [ @@ -34935,559 +24728,343 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'Status code. Note that 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '916EE694-03C2-47B6-85EE-5054E3C168D3', - ], - 'Total' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'List of alarm contact groups.', - 'type' => 'array', - 'items' => [ - 'description' => 'Alarm contact group.', - 'type' => 'string', - 'example' => '云账号报警联系人', - ], - ], - ], - ], - 'ContactGroupList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'List of alarm contact groups.', - 'type' => 'array', - 'items' => [ - 'description' => 'Alarm contact group.', - 'type' => 'object', - 'properties' => [ - 'Describe' => [ - 'description' => 'Description information of the alarm contact group.', - 'type' => 'string', - 'example' => 'Devops-运维组', - ], - 'UpdateTime' => [ - 'description' => 'Update time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-03-04T02:12:06Z', - ], - 'CreateTime' => [ - 'description' => 'Creation time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2023-06-07T03:52:30Z', - ], - 'EnabledWeeklyReport' => [ - 'description' => 'Indicates whether the weekly report function is enabled.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Name' => [ - 'description' => 'Name.', - 'type' => 'string', - 'example' => 'name', - ], - 'EnableSubscribed' => [ - 'description' => 'Indicates whether the weekly report subscription function is enabled. Values:'."\n" - ."\n" - .'- true: Yes.'."\n" - ."\n" - .'- false: No.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Contacts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Contact' => [ - 'description' => 'List of contacts.', - 'type' => 'array', - 'items' => [ - 'description' => 'Contact.', - 'type' => 'string', - 'example' => '135xxxx8066', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '181C406E-9DE4-484C-9C61-37AE9A1A12EE', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 200 => [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Create or modify alert contact information', + 'summary' => 'Calls the PutContact operation to create or modify alert contact information.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutContact'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutContact', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'Query Alarm Contact Group List', - 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"181C406E-9DE4-484C-9C61-37AE9A1A12EE\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DescribeContactList' => [ - 'summary' => 'Queries alert contacts.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutContactGroup' => [ + 'summary' => 'Creates or modifies an alert contact group by calling the PutContactGroup operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'required' => true, 'example' => 'Attendance system group', 'title' => ''], ], [ - 'name' => 'ContactName', + 'name' => 'Describe', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', - ], + 'schema' => ['description' => 'The description of the alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'Alert test', 'title' => ''], ], [ - 'name' => 'ChanelType', + 'name' => 'EnableSubscribed', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail: emails'."\n" - .'* DingWebHook: DingTalk chatbots'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Mail', - ], + 'schema' => ['description' => 'Specifies whether to enable the subscription feature. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'ChanelValue', + 'name' => 'ContactNames', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The value specified for the alert notification method.'."\n" - ."\n" - .'> This parameter is required only if you set the `ChanelType` parameter to `Mail`.'."\n", - 'type' => 'string', + 'description' => 'The name of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => false, 'example' => 'lucy', 'title' => ''], 'required' => false, - 'example' => 'Alice@example.com', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\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 returned.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Contacts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Contact' => [ - 'description' => 'The alert contacts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The timestamp when the alert contact was updated.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552356159000', - ], - 'Name' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the alert contact was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552356159000', - ], - 'Lang' => [ - 'description' => 'The language in which the alert information is displayed. Valid values:'."\n" - ."\n" - .'* zh-cn: simplified Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'example' => 'zh-cn', - ], - 'Desc' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact groups.'."\n", - 'type' => 'string', - 'example' => '{ "ContactGroup": [ "ECS_Group", "Jim" ] }', - ], - ], - ], - ], - 'Channels' => [ - 'description' => 'The alert notification method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mail' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'Alice@example.com', - ], - 'AliIM' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'DingWebHook' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', - ], - 'SMS' => [ - 'description' => 'The phone number of the alert contac.'."\n", - 'type' => 'string', - 'example' => '1333333****', - ], - ], - ], - 'ChannelsState' => [ - 'description' => 'The status of the alert notification method. Valid values: PENDING and OK.'."\n" - ."\n" - .'The email address must be activated after it is added as the value specified for the alert notification method. The value PENDING indicates that the email address is not activated. The value OK indicates that the email address is activated.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mail' => [ - 'description' => 'The status of the email address. Valid values:'."\n" - ."\n" - .'* PENDING: The phone number is not activated. Alert notifications can be sent to the phone number by using text messages only after the phone number is activated.'."\n" - .'* OK: The phone number is activated and can receive alert notifications.'."\n", - 'type' => 'string', - 'example' => 'PENDING', - ], - 'AliIM' => [ - 'description' => 'The status of the TradeManager ID.'."\n" - ."\n" - .'Valid value: OK. The value OK indicates that the TradeManager ID is valid and can receive alert notifications.'."\n" - ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'DingWebHook' => [ - 'description' => 'The status of the DingTalk chatbot.'."\n" - ."\n" - .'Valid value: OK. The value OK indicates that the DingTalk chatbot is normal and alert notifications can be received in a DingTalk group.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'SMS' => [ - 'description' => 'The status of the phone number. Valid values:'."\n" - ."\n" - .'* PENDING: The phone number is not activated. Alert notifications can be sent to the phone number by using text messages only after the phone number is activated.'."\n" - .'* OK: The phone number is activated and can receive alert notifications.'."\n" - ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Illegal parameters.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4E30DB6-F069-5D0B-A589-2A89F7D62A57', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], + ], + [ + ['errorCode' => 'ContactGroup.NotExists', 'errorMessage' => 'ContactGroup not exists', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Create or modify an alert contact group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutContactGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutContactGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Illegal parameters.\\",\\n \\"RequestId\\": \\"B4E30DB6-F069-5D0B-A589-2A89F7D62A57\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'PutCustomEvent' => [ + 'summary' => 'Reports custom events.', + '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' => 'The event details.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EventName' => ['description' => 'The event name. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => true, 'example' => 'myEvent', 'title' => ''], + 'Time' => ['description' => 'The time when the event occurred.'."\n" + ."\n" + .'Format: `yyyyMMddTHHmmss.SSSZ`.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You can also specify a UNIX timestamp. Example: 1552199984000. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '20171013T170923.456+0800', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group. Valid values of N: 1 to 50.'."\n" + ."\n" + .'Default value: 0. This value indicates that the event to be reported does not belong to any application group.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + 'Content' => ['description' => 'The event content. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => true, 'example' => 'IOException', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 50, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '131DD9C8-9A32-4428-AD2E-4E3013B6E3A7', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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\\": \\"Alice@example.com\\",\\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":"\\r\\n\\t\\tA1267F27-942F-40EE-9254-57FE16E3C9AB\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tContact Desc\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tECS_Group\\r\\n\\t\\t\\t\\t\\tJim\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tPENDING\\r\\n\\t\\t\\t\\t\\tOK\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t1583307692000\\r\\n\\t\\t\\t\\t1589441072000\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\talice@example.com\\r\\n\\t\\t\\t\\t\\t155*******\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\tAlice\\r\\n\\t\\t\\t\\tzh-cn\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t25\\r\\n\\t\\t200\\r\\n\\t\\ttrue\\r\\n","errorExample":""}]', - 'title' => 'DescribeContactList', + 'title' => 'PutCustomEvent', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutContact' => [ - 'summary' => 'Creates or modifies an alert contact.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomEvent'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutCustomEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"131DD9C8-9A32-4428-AD2E-4E3013B6E3A7\\"\\n}","type":"json"}]', + ], + 'PutCustomEventRule' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ContactName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Alice', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ID of the application group. For information about how to obtain the ID, see [DescribeCustomEventAttribute](~~115262~~).'."\n" + ."\n" + .'> A value of 0 indicates that the reported custom event does not belong to any application group.', 'type' => 'string', 'required' => true, 'example' => '7378****', 'title' => ''], ], [ - 'name' => 'Describe', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Instance', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'> If the alert rule ID already exists, the alert rule is modified. If the alert rule ID does not exist, an alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'CustomRuleId1', 'title' => ''], ], [ - 'name' => 'Channels.SMS', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The phone number of the alert contact. After you add or modify a phone number, the recipient receives a text message that contains an activation link. The system adds the recipient to the list of alert contacts only after the recipient activates the phone number.'."\n" - ."\n" - .'Specify at least one of the following alert notification methods: email address and DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1333333****', - ], + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'CustomeRule', 'title' => ''], ], [ - 'name' => 'Channels.Mail', + 'name' => 'EventName', 'in' => 'query', - 'schema' => [ - 'description' => 'The email address. After you add or modify an email address, the recipient receives an email that contains an activation link. The system adds the recipient to the list of alert contacts only after the recipient activates the email address.'."\n" - ."\n" - .'Specify at least one of the following alert notification methods: email address and DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test@aliyun.com', - ], + 'schema' => ['description' => 'The name of the custom event. For information about how to obtain the name, see [DescribeCustomEventAttribute](~~115262~~).', 'type' => 'string', 'required' => true, 'example' => 'HostDown', 'title' => ''], ], [ - 'name' => 'Channels.AliIM', + 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n" - ."\n" - .'Specify at least one of the following alert notification methods: email address and DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Jim', - ], + 'schema' => ['description' => 'The alert contact group. Separate multiple contact groups with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'ECS_Group', 'title' => ''], ], [ - 'name' => 'Channels.DingWebHook', + 'name' => 'Webhook', 'in' => 'query', - 'schema' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n" - ."\n" - .'Specify at least one of the following alert notification methods: email address and DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=7d49515e8ebf21106a80a9cc4bb3d247771305d52fb15d6201234565****', - ], + 'schema' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'EffectiveInterval', 'in' => 'query', - 'schema' => [ - 'description' => 'The language in which the alert information is displayed. Valid values:'."\n" - ."\n" - .'* zh-cn: simplified Chinese'."\n" - .'* en: English'."\n" - ."\n" - .'> If you do not specify this parameter, CloudMonitor identifies the language of the alert information based on the region of your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-cn', - ], + 'schema' => ['description' => 'The time period during which the alert rule is effective. Valid values: 00:00-23:59.', 'type' => 'string', 'required' => false, 'example' => '00:00-23:59', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The aggregation period of the monitoring data for the custom event. Unit: seconds. The value must be 60 or a multiple of 60. Default value: 300.', 'type' => 'string', 'required' => false, 'default' => '300', 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The alert threshold.', 'type' => 'string', 'required' => true, 'example' => '99', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL'."\n" + .'- WARN'."\n" + .'- INFO', 'type' => 'string', 'required' => true, 'example' => 'CRITICAL', 'title' => ''], ], ], 'responses' => [ @@ -35495,136 +25072,140 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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 Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '181C406E-9DE4-484C-9C61-37AE9A1A12EE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'AD5DCD82-BD1C-405F-BAED-32302DE9F498', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n 200\\n 181C406E-9DE4-484C-9C61-37AE9A1A12EE\\n true\\n","errorExample":""}]', - 'title' => 'PutContact', + 'title' => 'Create an alert rule for a custom event', + 'summary' => 'Calls the PutCustomEventRule operation to create an alert rule for a custom event.', + 'description' => 'Before you call this operation, you must call the PutCustomEvent operation to report the monitoring data of the custom event. For more information, see [PutCustomEvent](~~115012~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutContactGroup' => [ - 'summary' => 'Creates or modifies an alert contact group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomEventRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutCustomEventRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'PutCustomMetric' => [ + 'summary' => 'Calls the PutCustomMetric operation to report custom monitoring data.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ContactGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n" - ."\n" - .'For information about how to obtain the name of an alert contact group, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Group', - ], - ], - [ - 'name' => 'Describe', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Alert_Group', - ], - ], - [ - 'name' => 'EnableSubscribed', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the weekly report subscription feature. Valid values:'."\n" - ."\n" - .'* true: The weekly report subscription feature is enabled.'."\n" - .'* false: The weekly report subscription feature is disabled.'."\n" - ."\n" - .'> You can enable the weekly report subscription feature only for an Alibaba Cloud account that has at least five Elastic Compute Service (ECS) instances.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'ContactNames', + 'name' => 'MetricList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the alert contact. Valid values of N: 1 to 100.'."\n", + 'description' => 'The list of monitoring data.', 'type' => 'array', 'items' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the reported value. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- 0: raw data.'."\n" + .'- 1: aggregate data.'."\n" + ."\n" + .'> When you report aggregate data, we recommend that you report both data with a period of 60 seconds and data with a period of 300 seconds. Otherwise, monitoring data cannot be queried for a time span of more than 7 days.', 'type' => 'string', 'required' => true, 'example' => '0', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric. Valid values of N: 1 to 21. For more information, see [Metrics of cloud services](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + 'Time' => ['description' => 'The time when the metric occurred. Valid values of N: 1 to 21. The following two types of values are supported:'."\n" + .'- UTC time. Format: YYYY-MM-DDThh:mm:ssZ. For example: 20171012T132456.888+0800.'."\n" + .'- A Long-type timestamp. For example: 1508136760000.'."\n", 'type' => 'string', 'required' => false, 'example' => '1508136760000', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> If the metric does not belong to any application group, enter 0.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + 'Values' => ['description' => 'The collection of metric values. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> If the type of the reported value is 0, the raw values are reported. CloudMonitor aggregates raw values into multiple values, such as maximum, count, and sum, by period.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"value":10.5}', 'title' => ''], + 'Dimensions' => ['description' => 'The dimension map, which is used to query monitoring data of a specified resource. Valid values of N: 1 to 21.'."\n" + ."\n" + .'Format: a collection of key-value pairs. A commonly used key-value pair collection is: `{"Key":"Value"}`.'."\n" + ."\n" + .'The length of Key and Value is 1 to 64 characters. Characters beyond the first 64 are truncated.'."\n" + ."\n" + .'The values of Key and Value can contain letters, digits, periods (.), hyphens (-), underscores (_), forward slashes (/), and backslashes (\\).'."\n" + ."\n" + .'> Dimensions must be passed in as a JSON string that represents the map object, and must be passed in order. ', 'type' => 'string', 'required' => true, 'example' => '{"sampleName1":"value1","sampleName2":"value2"}', 'title' => ''], + 'Period' => ['description' => 'The aggregation period. Valid values of N: 1 to 21. Unit: seconds. Valid values: 60 and 300.'."\n" + ."\n" + .'> If the type of the reported value is 1, you must set this parameter.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + 'required' => false, 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, - 'example' => 'Alice', + 'required' => true, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -35633,4518 +25214,4623 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'Illegal parameters.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4E30DB6-F069-5D0B-A589-2A89F7D62A57', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Report custom monitoring data', + 'description' => '> We recommend that you use the [PutHybridMonitorMetricData](~~383455~~) operation in Enterprise CloudMonitor.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomMetric'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutCustomMetric', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'PutCustomMetricRule' => [ + 'summary' => 'Creates an alert rule for custom monitoring.', + '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' => 'The ID of the application group to which the custom monitoring data belongs.'."\n" + ."\n" + .'> A value of 0 indicates that the reported custom monitoring data does not belong to any application group.', 'type' => 'string', 'required' => false, 'example' => '7378****', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'> If the alert rule ID already exists, the alert rule is modified. If the alert rule ID does not exist, an alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'MyRuleId1', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'CpuUsage', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'> For information about how to obtain the metric name, see [DescribeCustomMetricList](~~115005~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => ['description' => 'The custom monitoring data to which the alert rule applies. The value consists of the application group ID to which the custom monitoring data belongs and the dimensions of the metric.', 'type' => 'string', 'required' => true, 'example' => '[{"groupId":7378****,"dimension":"instanceId=i-hp3543t5e4sudb3s****"}]', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group. Separate multiple alert contact groups with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The webhook URL that is called when an alert is triggered. A POST request is sent to this URL.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], ], [ - [ - 'errorCode' => 'ContactGroup.NotExists', - 'errorMessage' => 'ContactGroup not exists', - ], + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The time range during which the alert rule is effective. Valid values: 00:00-23:59.', 'type' => 'string', 'required' => false, 'example' => '00:00-23:59', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute for period. Unit: seconds. Default value: 86400 (1 day).'."\n" + ."\n" + .'> If monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute for period.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '86400', 'example' => '86400', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Illegal parameters.\\",\\n \\"RequestId\\": \\"B4E30DB6-F069-5D0B-A589-2A89F7D62A57\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'PutContactGroup', - 'description' => 'This topic provides an example on how to create an alert contact group named `ECS_Group`.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateHybridMonitorNamespace' => [ - 'summary' => 'Creates a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The aggregation period of the custom monitoring data. Unit: seconds. The value must be 60 or a multiple of 60. Default value: the original reporting period of the custom monitoring data.', 'type' => 'string', 'required' => false, 'default' => '300', 'example' => '300', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'EmailSubject', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'The name can contain lowercase letters, digits, and hyphens (-).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The alert threshold.', 'type' => 'string', 'required' => true, 'example' => '90', 'title' => ''], ], [ - 'name' => 'Spec', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'description' => 'The data retention period. Valid values:'."\n" - ."\n" - .'* cms.s1.large (Retention Period 15 Days)'."\n" - .'* cms.s1.xlarge (Retention Period 32 Days)'."\n" - .'* cms.s1.2xlarge (Retention Period 63 Days)'."\n" - .'* cms.s1.3xlarge (Retention Period 93 Days) (default)'."\n" - .'* cms.s1.6xlarge (Retention Period 185 Days)'."\n" - .'* cms.s1.12xlarge (Retention Period 367 Days)'."\n" - ."\n" - .'For information about the pricing for different retention periods, see the **Pricing** section in [Billing of the dashboard feature](~~223532~~).'."\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' => [], - ], + 'schema' => ['description' => 'The severity level of the alert. Valid values:'."\n" + .'- CRITICAL: critical.'."\n" + .'- WARN: warning.'."\n" + .'- INFO: information.', 'type' => 'string', 'required' => true, 'example' => 'CRITICAL', 'title' => ''], ], [ - 'name' => 'NamespaceType', + 'name' => 'EvaluationCount', 'in' => 'query', - 'schema' => [ - 'description' => 'The storage scheme of metric data. Valid values:'."\n" - ."\n" - .'* m_prom_user: The metric data is stored in Simple Log Service.'."\n" - .'* m_prom_pool: The metric data is stored in the private storage space provided by CloudMonitor.'."\n" - ."\n" - .'> For more information about the storage schemes of metric data, see [Data storage schemes for Hybrid Cloud Monitoring](~~2594921~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm_prometheus', - ], + 'schema' => ['description' => 'The number of retries for the alert.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'NamespaceRegion', + 'name' => 'Statistics', 'in' => 'query', - 'schema' => [ - 'description' => 'The region where the metric data is stored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The statistical method for the alert.', 'type' => 'string', 'required' => true, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for the threshold. Valid values:'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `!=`.', 'type' => 'string', 'required' => true, 'example' => '>=', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Namespace.Existed', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the call is successful, this parameter is empty. If the call fails, the error message is returned.', 'type' => 'string', 'example' => 'ComparisonOperator is mandatory for this action.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9432', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: successful.'."\n" + ."\n" + .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Create a custom monitoring alert rule', + 'description' => 'Before calling this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see [PutCustomMetric](~~115004~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutCustomMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t3843D23A-FB9E-5DC8-BCCC-458768B79296\\r\\n\\tSuccess\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'CreateHybridMonitorNamespace', - 'description' => '## [](#)Prerequisites'."\n" - ."\n" - .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - ."\n" - .'## [](#)Operation description'."\n" - ."\n" - .'This topic provides an example on how to create a namespace named `aliyun`. In this example, the data retention period of the namespace is set to `cms.s1.3xlarge`. The returned result indicates that the namespace is created.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"ComparisonOperator is mandatory for this action.\\",\\n \\"RequestId\\": \\"65D50468-ECEF-48F1-A6E1-D952E89D9432\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'ModifyHybridMonitorNamespace' => [ - 'summary' => 'Modifies a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutEventRule' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Event-triggered Alert Rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'myRuleName', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group to which the Event-triggered Alert Rule belongs.', 'type' => 'string', 'required' => false, 'example' => '7378****', 'title' => ''], + ], + [ + 'name' => 'EventType', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the namespace.'."\n" + 'description' => 'The type of the Event-triggered Alert Rule. Valid values:'."\n" ."\n" - .'The name can contain letters, digits, and hyphens (-).'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", + .'- SYSTEM: system event.'."\n" + .'- CUSTOM: custom event.', 'type' => 'string', - 'required' => true, - 'example' => 'aliyun', + 'required' => false, + 'default' => 'SYSTEM', + 'enum' => ['SYSTEM', 'CUSTOM'], + 'example' => 'SYSTEM', + 'title' => '', ], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The description of the Event-triggered Alert Rule.', 'type' => 'string', 'required' => false, 'example' => 'Event alert test', 'title' => ''], ], [ - 'name' => 'Spec', + 'name' => 'State', 'in' => 'query', 'schema' => [ - 'description' => 'The data retention period. Valid values:'."\n" - ."\n" - .'* cms.s1.large: Data is stored for 15 days.'."\n" - .'* cms.s1.xlarge: Data is stored for 32 days.'."\n" - .'* cms.s1.2xlarge: Data is stored for 63 days.'."\n" - .'* cms.s1.3xlarge: Data is stored for 93 days.'."\n" - .'* cms.s1.6xlarge: Data is stored for 185 days.'."\n" - .'* cms.s1.12xlarge: Data is stored for 376 days.'."\n" + 'description' => 'The status of the Event-triggered Alert Rule. Valid values:'."\n" ."\n" - .'For information about the pricing for different retention periods, see the **Pricing** section in [Billing of the dashboard feature](~~223532~~).'."\n", + .'- ENABLED: enabled.'."\n" + .'- DISABLED: disabled.', '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' => [], + 'default' => 'ENABLED', + 'enum' => ['ENABLED', 'DISABLED'], + 'example' => 'ENABLED', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'EventPattern', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => '%s', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + 'description' => 'The pattern of the Event-triggered Alert Rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'EventTypeList' => [ + 'description' => 'The type of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:'."\n" + ."\n" + .'- StatusNotification: fault notification.'."\n" + ."\n" + .'- Exception: exception.'."\n" + ."\n" + .'- Maintenance: O&M.'."\n" + ."\n" + .'- \\*: unlimited.', + 'type' => 'array', + 'items' => ['description' => 'The type of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:'."\n" + ."\n" + .'- StatusNotification: fault notification.'."\n" + ."\n" + .'- Exception: exception.'."\n" + ."\n" + .'- Maintenance: O&M.'."\n" + ."\n" + .'- \\*: unlimited.', 'type' => 'string', 'required' => false, 'example' => 'Exception', 'title' => ''], + 'required' => false, + 'example' => 'Exception', + 'maxItems' => 5, + 'title' => '', + ], + 'StatusList' => [ + 'description' => 'The status of the Event-triggered Alert Rule. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The status of the Event-triggered Alert Rule. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'Failed', 'title' => ''], + 'required' => false, + 'example' => 'Failed', + 'maxItems' => 5, + 'title' => '', + ], + 'Product' => ['description' => 'The Alibaba Cloud service type. Valid values of N: 1 to 50.'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + .'>For information about the Alibaba Cloud services supported by Event-triggered Alert Rules, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + 'LevelList' => [ + 'description' => 'The level of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical.'."\n" + ."\n" + .'- WARN: warning.'."\n" + ."\n" + .'- INFO: information.'."\n" + ."\n" + .'- \\*: all levels.', + 'type' => 'array', + 'items' => ['description' => 'The level of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical.'."\n" + ."\n" + .'- WARN: warning.'."\n" + ."\n" + .'- INFO: information.'."\n" + ."\n" + .'- \\*: all levels.', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], + 'required' => false, + 'example' => 'CRITICAL', + 'maxItems' => 5, + 'title' => '', + ], + 'NameList' => [ + 'description' => 'The name of the Event-triggered Alert Rule. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The name of the Event-triggered Alert Rule. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'Agent_Status_Stopped', 'title' => ''], + 'required' => false, + 'example' => 'Agent_Status_Stopped', + 'maxItems' => 20, + 'title' => '', + ], + 'CustomFilters' => ['description' => 'The keyword for event filtering. When the event content contains this keyword, an alert is automatically triggered.', 'type' => 'string', 'required' => false, 'example' => 'Stopping', 'title' => ''], + 'SQLFilter' => ['description' => 'The SQL filter for events. When the event content meets the SQL condition, an alert is automatically triggered.'."\n" + .'> The syntax of the SQL event filter is consistent with the query syntax of Simple Log Service (SLS).', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX and Executed', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], - ], - '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":"\\r\\n\\tE190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD\\r\\n\\tSuccess\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'ModifyHybridMonitorNamespace', - 'description' => 'This topic provides an example on how to change the data retention period of the `aliyun` namespace to `cms.s1.2xlarge`. The response shows that the namespace is modified.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DeleteHybridMonitorNamespace' => [ - 'summary' => 'Deletes a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'SilenceTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The mute period. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86400', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Namespace.NotFound', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'Data' => ['description' => 'The number of rows affected when the Event-triggered Alert Rule is created or modified.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t3843D23A-FB9E-5DC8-BCCC-458768B79296\\r\\n\\tSuccess\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DeleteHybridMonitorNamespace', - 'description' => '> If a metric import task is created for metrics in a namespace, you cannot delete the namespace unless you delete the task first.'."\n" + 'title' => 'Create or modify an event-based alert rule', + 'summary' => 'Creates or modifies an event-based alert rule by calling the PutEventRule operation.', + 'description' => 'If the Event-triggered Alert Rule name does not exist, a new alert rule is created. If the Event-triggered Alert Rule name already exists, the existing alert rule is modified.'."\n" ."\n" - .'This topic provides an example on how to delete a namespace named `aliyun`. The response shows that the namespace is deleted.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DescribeHybridMonitorNamespaceList' => [ - 'summary' => 'Queries namespaces and the details of the related metric import tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + .'This topic provides an example of how to create an event-based alert rule named `myRuleName` for the Alibaba Cloud service `ecs`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-24T03:35:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:35:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:35:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:35:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-03T08:36:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutEventRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutEventRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'PutEventRuleTargets' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testEventRule', 'title' => ''], + ], + [ + 'name' => 'FcParameters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Page numbers start from 1. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The Function Compute notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => ['description' => 'The name of the function. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'fc-test', 'title' => ''], + 'Region' => ['description' => 'The region where the Function Compute service resides. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'ServiceName' => ['description' => 'The service name of the Function Compute service. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'fc-test', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '10', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'ContactParameters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Page numbers start from 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The alert contact group notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => ['description' => 'The name of the alert contact group. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'Default alert contact group', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'Level' => ['description' => 'The alert notification level. Valid values of N: 1 to 5. Valid values:'."\n" + ."\n" + .'- 2: phone call, text message, DingTalk, and email'."\n" + ."\n" + .'- 3: text message, DingTalk, and email'."\n" + ."\n" + .'- 4: DingTalk and email'."\n" + ."\n" + .'4: DingTalk and email'."\n" + ."\n" + .'4: DingTalk and email.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '1', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Keyword', + 'name' => 'MnsParameters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The search keyword.'."\n", - 'type' => 'string', + 'description' => 'The Simple Message Queue (formerly MNS) notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where Simple Message Queue (formerly MNS) resides. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'Queue' => ['description' => 'The name of the queue. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'queue1', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Topic' => ['description' => 'The topic of Simple Message Queue (formerly MNS).', 'type' => 'string', 'required' => false, 'example' => 'topic_sample', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => 'aliyun', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Namespace', + 'name' => 'WebhookParameters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'The name can contain letters, digits, and hyphens (-).'."\n", - 'type' => 'string', + 'description' => 'The URL callback notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Protocol' => ['description' => 'The protocol name. Valid values of N: 1 to 5. Valid values:'."\n" + ."\n" + .'- http'."\n" + .'- telnet'."\n" + .'- ping.', 'type' => 'string', 'required' => false, 'example' => 'http', 'title' => ''], + 'Url' => ['description' => 'The callback URL. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Method' => ['description' => 'The request method of the HTTP callback. Valid values of N: 1 to 5.'."\n" + ."\n" + .'Only GET and POST are supported.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => 'aliyun-test', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ShowTaskStatistic', + 'name' => 'SlsParameters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to return the configuration details of metric import tasks for Alibaba Cloud services and the number of metric import tasks for third-party services. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false (default)'."\n", - 'type' => 'boolean', + 'description' => 'The Simple Log Service notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'LogStore' => ['description' => 'The Logstore of Simple Log Service. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'testlogstore', 'title' => ''], + 'Region' => ['description' => 'The region where Simple Log Service resides. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'Project' => ['description' => 'The project of Simple Log Service. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'testproject', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 5, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'OpenApiParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of API callback notification parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The API name.', 'type' => 'string', 'required' => false, 'example' => 'PutLogs', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Valid values of N: 1 to 5.'."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + .' - Service: the Alibaba Cloud service.'."\n" + .' - Region: the region ID.'."\n" + .' - Account: the Alibaba Cloud account ID.'."\n" + .' - ResourceType: the resource type.'."\n" + .' - ResourceId: the resource ID.', 'type' => 'string', 'required' => false, 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the API callback notification method.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Product' => ['description' => 'The ID of the Alibaba Cloud service to which the API belongs.', 'type' => 'string', 'required' => false, 'example' => 'log', 'title' => ''], + 'Region' => ['description' => 'The region where the resource resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'Role' => ['description' => 'The role name.', 'type' => 'string', 'required' => false, 'example' => 'MyRole', 'title' => ''], + 'Version' => ['description' => 'The API version.', 'type' => 'string', 'required' => false, 'example' => '2019-01-01', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'false', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1EC450A4-3221-5148-B77E-2827576CFE48', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Specified parameter PageSize is not valid.', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DescribeHybridMonitorNamespace' => [ - 'description' => 'The details of the namespaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'aliyun-test', - ], - 'CreateTime' => [ - 'description' => 'The timestamp that was generated when the namespace was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1652682744000', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'aliyun-test', - ], - 'IsDelete' => [ - 'description' => 'Indicates whether the namespace is deleted. Valid values:'."\n" - ."\n" - .'* 0: The namespace is not deleted.'."\n" - .'* 1: The namespace is deleted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Id' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => '3****', - ], - 'ModifyTime' => [ - 'description' => 'The timestamp that was generated when the namespace was last modified.'."\n", - 'type' => 'string', - 'example' => '1652682744000', - ], - 'Detail' => [ - 'description' => 'The details of the data retention period.'."\n", + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '409C64DA-CF14-45DF-B463-471C790DD15A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. The value true indicates success. The value false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailedParameterCount' => ['description' => 'The number of failed parameters.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'FailedContactParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactParameter' => [ + 'description' => 'This parameter is returned if the rule targets contain an alert contact group that failed to be created.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Spec' => [ - 'description' => 'The data retention period. Valid values:'."\n" - ."\n" - .'* cms.s1.large (Retention Period 15 Days)'."\n" - .'* cms.s1.xlarge (Retention Period 32 Days)'."\n" - .'* cms.s1.2xlarge (Retention Period 63 Days)'."\n" - .'* cms.s1.3xlarge (Retention Period 93 Days)'."\n" - .'* cms.s1.6xlarge (Retention Period 185 Days)'."\n" - .'* cms.s1.12xlarge (Retention Period 367 Days)'."\n", - 'type' => 'string', - 'example' => 'cms.s1.3xlarge', - ], - 'NamespaceRegion' => [ - 'description' => 'The region where the metric data is stored.'."\n" - ."\n" - .'> This parameter is returned if you select `m_prom_user` for `NamespaceType` when you create a namespace.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'SLSProject' => [ - 'description' => 'The project where the metric data is located.'."\n" - ."\n" - .'> This parameter is returned if you select `m_prom_user` for `NamespaceType` when you create a namespace.'."\n", - 'type' => 'string', - 'example' => 'cms-hybrid-120886317861****-cn-hangzhou-a83d', - ], - 'PrometheusInstanceId' => [ - 'type' => 'string', - ], + 'ContactGroupName' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'example' => 'Default alert contact group', 'title' => ''], + 'Id' => ['description' => 'The ID of the rule target.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Level' => ['description' => "\n" + .'The alert notification level. Valid values:'."\n" + ."\n" + .'- 2: phone call, text message, DingTalk, and email'."\n" + ."\n" + .'- 3: text message, DingTalk, and email'."\n" + ."\n" + .'- 4: DingTalk and email'."\n" + ."\n" + .'4: DingTalk and email'."\n" + ."\n" + .'4: DingTalk and email.', 'type' => 'string', 'example' => '4', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'NotAliyunTaskNumber' => [ - 'description' => 'The number of metric import tasks for third-party services.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AliyunProductMetricList' => [ - 'description' => 'The configuration details of metric import tasks for Alibaba Cloud services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'description' => 'The account that is used to create the namespace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120886317861****', - ], - 'NamespaceList' => [ - 'description' => 'The namespaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace for the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'MetricList' => [ - 'description' => 'The metrics for the Alibaba Cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Period' => [ - 'description' => 'The collection period of the metric.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'List' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metric.'."\n", - 'type' => 'string', - 'example' => '["cpu_total"]', - ], - ], - ], - ], - ], - ], - ], - ], - 'YAMLConfig' => [ - 'description' => 'The configuration file of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring.'."\n" - ."\n" - .'* namespace: the namespace of the Alibaba Cloud service.'."\n" - .'* metric_list: the metrics of the Alibaba Cloud service.'."\n" - .'* dimension: the resources of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring. If you do not specify a dimension, all resources of the Alibaba Cloud service are monitored.'."\n", - 'type' => 'string', - 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: \'\'', - ], - ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FailedMnsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MnsParameter' => [ + 'description' => 'This parameter is returned if the rule targets contain a Simple Message Queue (formerly MNS) instance that failed to be created.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Queue' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'testQueue', 'title' => ''], + 'Id' => ['description' => 'The ID of the rule target.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'NamespaceType' => [ - 'description' => 'The storage scheme of metric data. Valid values:'."\n" - ."\n" - .'* m_prom_user: The metric data is stored in Simple Log Service.'."\n" - .'* m_prom_pool: The metric data is stored in the storage space provided by CloudMonitor.'."\n", - 'type' => 'string', - 'example' => 'm_prom_user', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FailedFcParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FcParameter' => [ + 'description' => 'This parameter is returned if the rule targets contain a Function Compute service that failed to be created.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => ['description' => 'The name of the Function Compute service.', 'type' => 'string', 'example' => 'serviceTest1', 'title' => ''], + 'FunctionName' => ['description' => 'The name of the function.', 'type' => 'string', 'example' => 'functionTest1', 'title' => ''], + 'Id' => ['description' => 'The ID of the rule target.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Add or modify notification channels of an alert rule', + 'summary' => 'Adds or modifies the notification channels of an event-triggered alert rule by calling the PutEventRuleTargets operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-22T07:44:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-22T07:44:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-22T07:44:57.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutEventRuleTargets'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutEventRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\r\\n\\t1EC450A4-3221-5148-B77E-2827576CFE48\\r\\n\\t10\\r\\n\\t1\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t1652682744000\\r\\n\\t\\t\\r\\n\\t\\t1652682744000\\r\\n\\t\\t0\\r\\n\\t\\t3****\\r\\n\\t\\taliyun-test\\r\\n\\t\\t\\r\\n\\t\\t\\tcms.s1.3xlarge\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tSuccess\\r\\n\\ttrue\\r\\n\\t","errorExample":""}]', - 'title' => 'DescribeHybridMonitorNamespaceList', - 'description' => 'In this example, all namespaces within the current account are queried. The response shows that the current account has only one namespace named `aliyun-test`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","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\\": \\"Default alert contact group\\",\\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}","type":"json"}]', ], - 'CreateHybridMonitorTask' => [ - 'summary' => 'Creates a metric import task for an Alibaba Cloud service or creates a metric for logs imported from Simple Log Service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutExporterOutput' => [ + 'summary' => 'Creates or modifies a monitoring data export configuration by calling the PutExporterOutput operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'DestName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The name of the configuration.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'exporterConfig', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'ConfigJson', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the metric import task.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The configuration of the data export. The value is a JSONObject string that must contain the following fields:'."\n" + ."\n" + .'- endpoint: the domain name that corresponds to the data of Log Service (SLS).'."\n" + .'- project: the project.'."\n" + .'- logstore: the Logstore.'."\n" + .'- ak: the AccessKey ID.'."\n" + .'- as: the 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******"}', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'Desc', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric import task.'."\n" - ."\n" - .'* If the `TaskType` parameter is set to `aliyun_fc`, enter the name of the metric import task.'."\n" - .'* If the `TaskType` parameter is set to `aliyun_sls`, enter the name of the metric for logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'aliyun_task', - ], + 'schema' => ['description' => 'The description of the configuration.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'CPU metric export', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'DestType', 'in' => 'query', + 'schema' => ['description' => 'The product to which the data is exported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sls', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the metric import task. Valid values:'."\n" - ."\n" - .'* aliyun_fc: metric import tasks for Alibaba Cloud services.'."\n" - .'* aliyun_sls: metrics for logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'aliyun_fc' => 'aliyun_fc', - 'aliyun_sls' => 'aliyun_sls', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. The value true indicates that the call was successful. The value false indicates that the call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'example' => 'aliyun_fc', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'CollectTargetType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the collection target.'."\n" - ."\n" - .'* If the `TaskType` parameter is set to `aliyun_fc`, enter `aliyun_fc`.'."\n" - .'* If the `TaskType` parameter is set to `aliyun_sls`, enter the name of the Logstore group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun_fc', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Create or modify a monitoring data export configuration', + 'description' => '> Only Log Service (SLS) is supported. More products will be supported in the future.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-21T02:01:45.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutExporterOutput'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'CollectInterval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The collection period of the metric. Valid values:'."\n" - ."\n" - .'* 15'."\n" - .'* 60 (default)'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 15 => '15', - 60 => '60', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutExporterOutput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => '60', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D027\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'PutExporterRule' => [ + 'summary' => 'Invokes the PutExporterRule operation to create or modify export rules.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '3607****', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'YARMConfig', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration file of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring.'."\n" - ."\n" - .'* namespace: the namespace of the Alibaba Cloud service. For information about how to query the namespace of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~).'."\n" - .'* metric_list: the metrics of the Alibaba Cloud service. For information about how to query the metrics of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~).'."\n" - ."\n" - .'The following code shows a sample configuration file:'."\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" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', - ], + 'schema' => ['description' => 'The name of the rule.'."\n" + ."\n" + .'> If the rule name already exists, the existing rule is modified. Otherwise, a new rule is created.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rule1_****', 'title' => ''], ], [ - 'name' => 'TargetUserId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the member account.'."\n" - ."\n" - .'If you call this operation by using the management account of a resource directory, you can connect the Alibaba Cloud services that are activated for all members in the resource directory to Hybrid Cloud Monitoring. You can use the resource directory to monitor Alibaba Cloud services across enterprise accounts.'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '120886317861****', - ], + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service. For more information, see [Cloud service metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'AttachLabels', + 'name' => 'MetricName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags of the metric.'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The tag value of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testValue', - ], - 'Name' => [ - 'description' => 'The tag key of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app_service', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The metric name. For more information, see [Cloud service metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'CPUUtilization', 'title' => ''], ], [ - 'name' => 'TargetUserIdList', + 'name' => 'TargetWindows', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the member accounts. Separate multiple member account IDs with commas (,).'."\n" - ."\n" - .'> This parameter is required only if you call this operation by using the management account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '120886317861****', - ], + 'schema' => ['description' => 'The time windows for data export. Unit: seconds.'."\n" + ."\n" + .'> - To export data for multiple windows, separate the windows with commas (,).'."\n" + .'- Exporting data at intervals of less than 60 seconds is not supported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '60,300', 'title' => ''], ], [ - 'name' => 'SLSProcessConfig', + 'name' => 'Describe', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The configurations of the logs that are imported from Simple Log Service.'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The conditions that are used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Relation' => [ - 'description' => 'The relationship between multiple filter conditions. Valid values:'."\n" - ."\n" - .'* and (default): Logs are processed only if all filter conditions are met.'."\n" - .'* or: Logs are processed if one of the filter conditions is met.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'or' => 'or', - 'and' => 'and', - ], - 'example' => 'and', - ], - 'Filters' => [ - 'description' => 'The conditions that are used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'code', - ], - 'Operator' => [ - 'description' => 'The method that is used to filter logs imported from Simple Log Service. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `=`: equal to'."\n" - .'* `! =`: not equal to'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '=', - 'enum' => [ - '>', - '>=', - '=', - '<=', - '<', - '!=', - 'contain', - 'notContain', - ], - ], - 'Value' => [ - 'description' => 'The value of the key that is used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Statistics' => [ - 'description' => 'The method that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate the log data of a statistical period. Valid values:'."\n" - ."\n" - .'* count: counts the number.'."\n" - .'* sum: calculates the total value.'."\n" - .'* avg: calculates the average value.'."\n" - .'* max: calculates the maximum value.'."\n" - .'* min: calculates the minimum value.'."\n" - .'* value: collects samples within the statistical period.'."\n" - .'* countps: calculates the number of values of the specified field divided by the total number of seconds within a statistical period.'."\n" - .'* sumps: calculates the sum of the values of the specified field divided by the total number of seconds within a statistical period.'."\n" - .'* distinct: calculates the number of unique values of the specified field within a statistical period.'."\n" - .'* distribution: calculates the number of logs that meet a specified condition within the statistical period.'."\n" - .'* percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'level_count', - 'minLength' => 0, - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - 'Parameter1' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Simple Log Service.'."\n" - ."\n" - .'* If the `Function` parameter is set to `distribution`, this parameter specifies the lower limit of the statistical interval. For example, if you want to calculate the number of HTTP requests whose status code is 2XX, set this parameter to 200.'."\n" - .'* If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - 'Parameter2' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Simple Log Service.'."\n" - ."\n" - .'> This parameter is required only if the `Function` parameter is set to `distribution`. This parameter specifies the upper limit of the statistical interval. For example, if you want to calculate the number of HTTP requests whose status code is 2XX, set this parameter to 299.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '299', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'GroupBy' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'code', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ApiResult', - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Express' => [ - 'description' => 'The extended fields that specify the results of basic operations performed on aggregation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Express' => [ - 'description' => 'The extended field that specifies the result of basic operations performed on aggregation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success_count', - ], - 'Alias' => [ - 'description' => 'The alias of the extended field that specifies the result of basic operations performed on aggregation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SuccRate', - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The description of the export rules.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'desc_******', 'title' => ''], ], [ - 'name' => 'CloudAccessId', + 'name' => 'DstNames', 'in' => 'query', - 'style' => 'flat', + 'style' => 'repeatList', 'schema' => [ + 'description' => 'The destination for data export.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'maxItems' => 50, - 'minItems' => 1, + 'items' => ['description' => 'The destination for data export.', 'type' => 'string', 'required' => false, 'example' => 'dst_******', 'title' => ''], + 'required' => true, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'yamlConfigFail', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '28CEA2E0-3E90-51B2-A7E8-B1ED75534E49', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'TaskId' => [ - 'description' => 'The ID of the monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36****', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t36****\\n\\t28CEA2E0-3E90-51B2-A7E8-B1ED75534E49\\n\\t200\\n\\ttrue\\n\\t","errorExample":""}]', - 'title' => 'CreateHybridMonitorTask', - 'description' => '# [](#)Prerequisites'."\n" - ."\n" - .'* Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - .'* If you want to create a metric for logs imported from Simple Log Service, make sure that you have activated Simple Log Service and created a project and a Logstore. For more information, see [Getting Started](~~54604~~).'."\n" - ."\n" - .'# [](#)Description'."\n" - ."\n" - .'This topic provides an example on how to create a metric import task named `aliyun_task` for Elastic Compute Service (ECS). The task imports the `cpu_total` metric to the `aliyun` namespace. The response shows that the metric import task is created.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'ModifyHybridMonitorTask' => [ - 'summary' => 'Modifies a metric for the logs that are imported from Log Service.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create or modify a data export rule', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:14:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-10T10:46:10.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutExporterRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutExporterRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'PutGroupMetricRule' => [ + 'summary' => 'Creates or modifies an alert rule in a specified application group.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the metric import task.'."\n" - ."\n" - .'For information about how to obtain the ID of a metric import task, see [DescribeHybridMonitorTaskList](~~428624~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '36****', - ], + 'schema' => ['description' => 'The application group ID.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => true, 'example' => '17285****', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric import task.'."\n" - ."\n" - .'For information about how to obtain the ID of a metric import task, see [DescribeHybridMonitorTaskList](~~428624~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'SLS_task', - ], + 'schema' => ['description' => 'The alert rule ID.'."\n" + ."\n" + .'- To create an alert rule for the application group, enter the alert rule ID.'."\n" + ."\n" + .'- To modify a specified alert rule in the application group, obtain the alert rule ID. For information about how to obtain the alert rule ID, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the metric import task.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The abbreviation of the Alibaba Cloud service name.'."\n" + ."\n" + .'For information about how to obtain the abbreviation, see the `metricCategory` tag in the `Labels` response parameter of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], [ - 'name' => 'CollectInterval', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The collection period of the metric. Valid values:'."\n" - ."\n" - .'* 15'."\n" - .'* 60'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '15', - ], + 'schema' => ['description' => 'The alert rule name.'."\n" + ."\n" + .'- To create an alert rule for the application group, enter the alert rule name.'."\n" + ."\n" + .'- To modify a specified alert rule in the application group, obtain the alert rule name. For information about how to obtain the alert rule name, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => true, 'example' => 'Rule_01', 'title' => ''], ], [ - 'name' => 'AttachLabels', + 'name' => 'Namespace', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags of the metric.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The tag value of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testValue', - ], - 'Name' => [ - 'description' => 'The tag key of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app_service', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'For information about how to obtain the namespace, see [DescribeMetricMetaList](~~98846~~) or [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'SLSProcessConfig', + 'name' => 'MetricName', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The configurations of the logs that are imported from Simple Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The conditions that are used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Relation' => [ - 'description' => 'The relationship between multiple filter conditions. Valid values:'."\n" - ."\n" - .'* and (default): Logs are processed only if all filter conditions are met.'."\n" - .'* or: Logs are processed if one of the filter conditions is met.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'and', - ], - 'Filters' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'code', - ], - 'Operator' => [ - 'description' => 'The method that is used to filter logs imported from Simple Log Service. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `=`: equal to'."\n" - .'* `! =`: not equal to'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '=', - 'enum' => [ - '>', - '>=', - '=', - '<=', - '<', - '!=', - 'contain', - 'notContain', - ], - ], - 'Value' => [ - 'description' => 'The value of the key that is used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Statistics' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate the log data of a statistical period. Valid values:'."\n" - ."\n" - .'* count: counts the number.'."\n" - .'* sum: calculates the total value.'."\n" - .'* avg: calculates the average value.'."\n" - .'* max: calculates the maximum value.'."\n" - .'* min: calculates the minimum value.'."\n" - .'* value: collects samples within the statistical period.'."\n" - .'* countps: calculates the number of values of the specified field divided by the total number of seconds within the statistical period.'."\n" - .'* sumps: calculates the sum of the values of the specified field divided by the total number of seconds within the statistical period.'."\n" - .'* distinct: calculates the number of unique values of the specified field within the statistical period.'."\n" - .'* distribution: calculates the number of logs that meet a specified condition within the statistical period.'."\n" - .'* percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'level_count', - 'minLength' => 0, - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - 'Parameter1' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Simple Log Service.'."\n" - ."\n" - .'* If the `Function` parameter is set to `distribution`, this parameter specifies the lower limit of the statistical interval. For example, if you want to calculate the number of HTTP requests whose status code is 2XX, set this parameter to 200.'."\n" - .'* If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - 'Parameter2' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Simple Log Service.'."\n" - ."\n" - .'> This parameter is required only if the `Function` parameter is set to `distribution`. This parameter specifies the upper limit of the statistical interval. For example, if you want to calculate the number of HTTP requests whose status code is 2XX, set this parameter to 299.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '299', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'GroupBy' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'code', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ApiResult', - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Express' => [ - 'description' => 'The extended fields that specify the results of basic operations performed on aggregation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Express' => [ - 'description' => 'The extended field that specifies the result of basic operations performed on aggregation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success_count', - ], - 'Alias' => [ - 'description' => 'The alias of the extended field that specifies the result of basic operations performed on aggregation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SuccRate', - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - ], - 'required' => false, - ], - 'required' => false, + 'schema' => ['description' => 'The metric name.'."\n" + ."\n" + .'For information about how to obtain the metric name, see [DescribeMetricMetaList](~~98846~~) or [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => ['description' => 'The first-level dimensions of the alert rule in the application group.'."\n" + ."\n" + .'Format: a collection of `key:value` pairs, such as `{"userId":"120886317861****"}` and `{"instanceId":"i-m5e1qg6uo38rztr4****"}`.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', 'title' => ''], + ], + [ + 'name' => 'ExtraDimensionJson', + 'in' => 'query', + 'schema' => ['description' => 'The second-level or third-level dimensions of the alert rule in the application group.'."\n" + ."\n" + .'Format: a collection of `key:value` pairs, such as `port:80` and `/dev/xvda:d-m5e6yphgzn3aprwu****`.'."\n" + ."\n" + .'If the first-level dimension is `{"instanceId":"i-m5e1qg6uo38rztr4****"}`, the second-level dimension is the cloud disk of the instance: `{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}`.', 'type' => 'string', 'required' => false, 'example' => '{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}', 'title' => ''], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The effective period during which the alert rule takes effect.', 'type' => 'string', 'required' => false, 'example' => '05:31-23:59', 'title' => ''], + ], + [ + 'name' => 'NoEffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The time range during which the alert rule is ineffective.', 'type' => 'string', 'required' => false, 'example' => '00:00-05:30', 'title' => ''], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute period during which CloudMonitor does not repeatedly send alert notifications for the same metric.'."\n" + ."\n" + .'Unit: seconds. Default value: 86400.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The reporting period of monitoring data.'."\n" + ."\n" + .'The value of `Period` is 60 or a multiple of 60. Unit: seconds. Default value: 300.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The detection period of the alert rule. Unit: seconds.'."\n" + ."\n" + .'> Keep the detection period consistent with the data reporting period. If the detection period is shorter than the data reporting period, alerts may not be triggered due to insufficient data.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The callback URL to which a request is sent when an alert is triggered.'."\n" + ."\n" + .'Enter a URL that is accessible over the Internet. CloudMonitor sends a POST request to push alert information to this URL. Only the HTTP protocol is supported.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for Critical-level alerts. Separate multiple statistical methods with commas (,).'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the value, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for Critical-level alerts.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for Critical-level alerts.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for Warn-level alerts. Separate multiple statistical methods with commas (,).'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the value, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for Warn-level alerts.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for Warn-level alerts.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for Info-level alerts. Separate multiple statistical methods with commas (,).'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the value, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for Info-level alerts.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for Info-level alerts.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'NoDataPolicy', + 'in' => 'query', + 'schema' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + .'- KEEP_LAST_STATE (default): No action is performed.'."\n" + .'- INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.', 'type' => 'string', 'required' => false, 'example' => 'KEEP_LAST_STATE', 'title' => ''], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags of the alert rule.'."\n" + ."\n" + .'Tags are included in alert notifications.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Options', + 'in' => 'query', + 'schema' => ['description' => 'The advanced settings.'."\n" + ."\n" + .'Format: {"key1":"value1","key2":"value2"}. Example: {"NotSendOK":true}. This specifies whether to send alert recovery notifications. The key is NotSendOK, and the value is true (do not send) or false (send, which is the default).', 'type' => 'string', 'required' => false, 'example' => '{"NotSendOK":true}', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'Invalid.SLSConfig', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Result' => [ + 'description' => 'The result of creating or modifying the alert rule.', + 'type' => 'object', + 'properties' => [ + 'RuleId' => ['description' => 'The alert rule ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Create or modify an alert rule in a specified application group', + 'description' => 'This topic provides an example on how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the application group `17285****`. The alert rule ID is `123456`, the alert rule name is `Rule_test`, the alert level is `Critical`, the statistical method is `Average`, the comparison operator is `GreaterThanOrEqualToThreshold`, the threshold is `90`, and the retry count is `3`. The response shows that the alert rule is created. The alert rule ID is `123456`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-12-13T07:02:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-20T09:52:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-14T06:58:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-14T06:58:52.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutGroupMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutGroupMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'GroupMetricRule', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], ], - '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":"\\n 11145B76-566A-5D80-A8A3-FAD98D310079\\n 200\\n true\\n","errorExample":""}]', - 'title' => 'ModifyHybridMonitorTask', - 'description' => 'This topic provides an example on how to change the collection period of a metric import task whose ID is `36****` to `15` seconds. The task is used to monitor the logs that are imported from Log Service. The returned result indicates that the metric is modified.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'DeleteHybridMonitorTask' => [ - 'summary' => 'Deletes a metric import task for Alibaba Cloud services or a metric for the logs that are imported from Log Service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutHybridMonitorMetricData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the metric import task.'."\n" - ."\n" - .'For information about how to obtain the ID of a metric import task, see [DescribeHybridMonitorTaskList](~~428624~~).'."\n" - ."\n" - .'> This parameter is required only if you call this operation to delete metrics for the logs that are imported from Log Service. In this case, the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '36****', - ], - ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'The name can contain uppercase letters, lowercase letters, digits, and hyphens (-).'."\n" - ."\n" - .'> This parameter is required only if you call this operation to delete metric import tasks for Alibaba Cloud services. In this case, the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The name of the metric namespace.'."\n" + ."\n" + .'For information about how to obtain the name of a metric namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'example' => 'default-aliyun', 'title' => ''], ], [ - 'name' => 'TargetUserId', + 'name' => 'MetricList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the member account.'."\n" + 'title' => '', + 'description' => 'The list of monitoring data.'."\n" ."\n" - .'> This parameter is required only if you use a management account to call this operation to query metric import tasks that belong to a member in a resource directory. In this case, the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '120886317861****', + .'Valid values of N: 1 to 100.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'Format: The name can contain uppercase letters, lowercase letters, digits, and underscores (_). The name must start with an uppercase letter or a lowercase letter.', 'type' => 'string', 'required' => true, 'example' => 'CPU_Usage', 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]*$'], + 'Labels' => [ + 'title' => '', + 'description' => 'The list of labels of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The key of the label of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'Format: The key can contain uppercase letters, lowercase letters, digits, and underscores (_). The key must start with an uppercase letter, a lowercase letter, or an underscore (_).'."\n" + ."\n" + .'> Key and Value must be set at the same time.', 'type' => 'string', 'example' => 'IP', 'required' => false], + 'Value' => ['description' => 'The value of the label of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'> Key and Value must be set at the same time.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '[{"Key":"app","Value":"testApp"},{"Key":"ip","Value":"192.168.XX.XX"},{"Key":"hostName","Value":"host01"}]', + 'maxItems' => 20, + ], + 'Value' => ['title' => '', 'description' => 'The value of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'Format: an integer or a floating-point number.', 'type' => 'string', 'required' => true, 'example' => '90', 'pattern' => '^[0-9\\.]*$'], + 'TS' => ['title' => '', 'description' => 'The timestamp when the monitoring data was reported.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'Unit: milliseconds. Default value: the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1640776119473'], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'null', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D6B8103F-7BAD-5FEB-945F-71D991AB8834', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + 'Code' => ['title' => '', 'description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5DB1CBCA-D14A-55FA-814F-B4DBD9735F68'], + 'ErrorDetail' => [ + 'title' => '', + 'description' => 'The details of the invalid parameters.'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + .'If the request parameters that you specify do not meet the requirements, the details of the invalid parameters are displayed.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Index' => ['title' => '', 'description' => 'The position of the error information in the array.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ErrorMessage' => ['title' => '', 'description' => 'The error message that is returned for the invalid parameter.', 'type' => 'string', 'example' => 'label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Reports monitoring data to a metric namespace', + 'summary' => 'Reports the specified monitoring data to a specified metric namespace of Enterprise CloudMonitor by calling the PutHybridMonitorMetricData operation.', + 'description' => '## Prerequisites'."\n" + .'Make sure that you have activated Enterprise CloudMonitor. For more information, see [Activate Enterprise CloudMonitor](~~250773~~).'."\n" + ."\n" + .'## Limits'."\n" + .'The size of the monitoring data that you can report at a time cannot exceed 1 MB.'."\n" + ."\n" + .'## Usage notes'."\n" + .'This topic provides an example to show how to report the monitoring data of the `CPU_Usage` metric to the `default-aliyun` metric namespace of Enterprise CloudMonitor.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n" + ."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-24T03:08:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:08:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:08:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-24T03:08:24.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutHybridMonitorMetricData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutHybridMonitorMetricData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n D6B8103F-7BAD-5FEB-945F-71D991AB8834\\n 200\\n true\\n","errorExample":""}]', - 'title' => 'DeleteHybridMonitorTask', - 'description' => 'This topic provides an example on how to delete a metric import task whose ID is `36****`. The returned result indicates that the metric import task is deleted.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'DescribeHybridMonitorTaskList' => [ - 'summary' => 'Queries metric import tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutLogMonitor' => [ + 'summary' => 'Creates or modifies a log monitoring metric by calling the PutLogMonitor operation.', + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Keyword', + 'name' => 'LogId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used for the search.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'task', - ], + 'schema' => ['description' => 'The ID of the log monitoring metric.', 'type' => 'string', 'required' => false, 'example' => '16****', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'SlsRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the metric import task.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '36****', - ], + 'schema' => ['description' => 'The region where the Log Service project resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'SlsProject', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], + ], + [ + 'name' => 'SlsLogstore', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Log Service Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name. For information about the metrics supported by CloudMonitor for Alibaba Cloud services, see [Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'MetricExpress', + 'in' => 'query', + 'schema' => ['description' => 'The extended field. The extended field provides arithmetic operations on the results of the statistical methods.'."\n" + ."\n" + .'For example, if you configure the total number of HTTP status code requests (TotalNumber) and the number of requests with HTTP status codes greater than 499 (5xxNumber) in the statistical methods, you can use the extended field to calculate the server error rate: 5xxNumber/TotalNumber*100.'."\n" + ."\n" + .'JSON format: {"extend":{"errorPercent":"5xxNumber/TotalNumber*100"}}. Field description:'."\n" + ."\n" + .'- extend: required.'."\n" + ."\n" + .'- errorPercent: the alias of the new field generated from the calculation result. You can specify a custom name. '."\n" + ."\n" + .'- errorPercent: the calculation expression for existing fields.', 'type' => 'string', 'required' => false, 'example' => '{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '3607****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'ValueFilterRelation', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The logical operator used to combine log filter conditions. Valid values:'."\n" + ."\n" + .'- and'."\n" + ."\n" + .'- or'."\n" + ."\n" + .'> This parameter must be used together with `ValueFilter.N.Key`.', 'type' => 'string', 'required' => true, 'example' => 'and', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Tumblingwindows', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Pages start from page 1. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The tumbling window size for pre-aggregation. Unit: seconds. CloudMonitor performs an aggregation calculation on the data at the specified interval.', 'type' => 'string', 'required' => false, 'example' => '60,300', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Unit', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The unit.', 'type' => 'string', 'required' => false, 'example' => 'Percent', 'title' => ''], ], [ - 'name' => 'IncludeAliyunTask', + 'name' => 'Aggregates', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether the returned result includes metric import tasks for Alibaba Cloud services. Valid values:'."\n" - ."\n" - .'* true (default): The returned result includes metric import tasks for Alibaba Cloud services.'."\n" - .'* false: The returned result excludes metric import tasks for Alibaba Cloud services.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'The aggregate function definitions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The name of the original field for aggregation. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => true, 'example' => 'sourceCount', 'title' => ''], + 'Function' => ['description' => 'The statistical method used to aggregate log data within a statistical period. Valid values of N: 1 to 10. Valid values:'."\n" + .'- count: counts the number of occurrences.'."\n" + .'- sum: calculates the sum.'."\n" + .'- avg: calculates the average.'."\n" + .'- max: returns the maximum value.'."\n" + .'- min: returns the minimum value.'."\n" + .'- countps: calculates the average count per second for the specified field within the statistical period.'."\n" + .'- sumps: calculates the average sum per second for the specified field within the statistical period.'."\n" + .'- distinct: counts the number of occurrences of the specified field after deduplication within the statistical period.', 'type' => 'string', 'required' => true, 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the aggregate function. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => true, 'example' => 'Count', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TaskType', + 'name' => 'Groupbys', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the metric import task. Valid values:'."\n" - ."\n" - .'* aliyun_fc: metric import tasks for Alibaba Cloud services'."\n" - .'* aliyun_sls: metrics for logs imported from Log Service'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'aliyun_sls' => 'aliyun_sls', + 'description' => 'The dimensions used for spatial aggregation. This is equivalent to the Group By clause in SQL, which groups monitoring data by specified dimensions. If no dimension is specified, all monitoring data is aggregated based on the aggregate function.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The name of the Group By field. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'cpu', 'title' => ''], + 'Alias' => ['description' => 'The alias of the Group By field. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => 'aliyun_fc', + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TargetUserId', + 'name' => 'ValueFilter', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the member account.'."\n" - ."\n" - .'> This parameter is required only if you use a management account to call this operation to delete the metric import tasks that belong to a member in a resource directory. In this case, the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The filter rules, used together with ValueFilterRelation. This is equivalent to the Where clause in SQL. If this parameter is not specified, all data is processed. For example, if the log contains Level and Error fields and you want to count the number of Error occurrences per minute, you can define the statistical method to sum the Level field with the condition Level=Error.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The name of the log field to match. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'lh_source', 'title' => ''], + 'Value' => ['description' => 'The value of the log field to match. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Operator' => ['description' => 'The matching method for the field value. Valid values of N: 1 to 10. Valid values:'."\n" + .'- `contain`: contains.'."\n" + .'- `notContain`: does not contain.'."\n" + .'- `>`: greater than.'."\n" + .'- `<`: less than.'."\n" + .'- `>=`: greater than or equal to.'."\n" + .'- `<=`: less than or equal to.', 'type' => 'string', 'required' => false, 'example' => 'contain', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '120886317861****', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, the value `successful` is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TaskList' => [ - 'description' => 'The metric import tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'YARMConfig' => [ - 'description' => 'The configuration file of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring.'."\n" - ."\n" - .'* namespace: the namespace of the Alibaba Cloud service.'."\n" - .'* metric_list: the metrics of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the metric import task was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1639382496000', - ], - 'TaskName' => [ - 'description' => 'The name of the metric import task.'."\n", - 'type' => 'string', - 'example' => 'aliyun_task', - ], - 'Namespace' => [ - 'description' => 'The namespace to which the host belongs.'."\n", - 'type' => 'string', - 'example' => 'aliyun', - ], - 'UploadRegion' => [ - 'description' => 'The region where the host resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'NetworkType' => [ - 'description' => 'The network type of the host. Valid values:'."\n" - ."\n" - .'* `vpc`'."\n" - .'* `Internet`'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'CollectTimout' => [ - 'description' => 'The timeout period during which the CloudMonitor agent collects host monitoring data. Valid values:'."\n" - ."\n" - .'* 0'."\n" - .'* 15'."\n" - .'* 30'."\n" - .'* 60'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'CollectTargetEndpoint' => [ - 'description' => 'The URL of the destination from which the CloudMonitor agent collects host monitoring data.'."\n", - 'type' => 'string', - 'example' => 'http://localhost', - ], - 'TaskType' => [ - 'description' => 'The type of the metric import task. Valid values:'."\n" - ."\n" - .'* aliyun_fc: metric import tasks for Alibaba Cloud services'."\n" - .'* aliyun_sls: metrics for logs imported from Log Service'."\n", - 'type' => 'string', - 'example' => 'aliyun_sls', - ], - 'MatchExpressRelation' => [ - 'description' => 'The relationship between the conditions that are used to filter metric import tasks. Valid values:'."\n" - ."\n" - .'* or'."\n" - .'* and'."\n", - 'type' => 'string', - 'example' => 'or', - ], - 'Description' => [ - 'description' => 'The description of the metric import task.'."\n", - 'type' => 'string', - 'example' => 'aliyun', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '3607****', - ], - 'CollectInterval' => [ - 'description' => 'The interval at which the CloudMonitor agent collects host monitoring data. Valid values:'."\n" - ."\n" - .'* 15'."\n" - .'* 30'."\n" - .'* 60'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'TargetUserId' => [ - 'description' => 'The ID of the member account.'."\n" - ."\n" - .'> This parameter is displayed only when you call this operation by using a management account.'."\n", - 'type' => 'string', - 'example' => '120886317861****', - ], - 'CollectTargetPath' => [ - 'description' => 'The relative path from which the CloudMonitor agent collects monitoring data.'."\n", - 'type' => 'string', - 'example' => '/metrics', - ], - 'CollectTargetType' => [ - 'description' => 'The type of the monitoring data. Valid values: Spring, Tomcat, Nginx, Tengine, JVM, Redis, and MySQL.'."\n", - 'type' => 'string', - 'example' => 'nginx', - ], - 'TaskId' => [ - 'description' => 'The ID of the metric import task.'."\n", - 'type' => 'string', - 'example' => '36****', - ], - 'AttachLabels' => [ - 'description' => 'The tags of the metric import task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'MatchExpress' => [ - 'description' => 'The conditions that are used to match the instances in the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The keyword that corresponds to the instance name.'."\n", - 'type' => 'string', - 'example' => 'ECS_instance1', - ], - 'Name' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The method that is used to match the instance name. Valid values:'."\n" - ."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* all: matches all'."\n" - .'* equals: equals'."\n" - .'* contains: contains'."\n" - .'* notContains: does not contain'."\n", - 'type' => 'string', - 'example' => 'all', - ], - ], - ], - ], - 'Instances' => [ - 'description' => 'The instances where monitoring data is collected in batches.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'i-hp368focau7dp0hw****', - ], - ], - 'ExtraInfo' => [ - 'description' => 'The additional information of the instance.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'LogFilePath' => [ - 'description' => 'The path where on-premises log data is stored. On-premises log data is stored in the specified path of the host where CloudMonitor is deployed.'."\n" - ."\n" - .'* Windows: The log path must start with a drive letter. Example: `C:\\UserData\\log\\\\*.Log`. You cannot specify wildcard characters in a log path.'."\n" - .'* Linux: The log path must start with a forward slash (/). Example: `/home/appdata/log/**/*.log`. In this example, `/**/` is used to match all files in the appdata directory.'."\n", - 'type' => 'string', - 'example' => 'C:\\UserData\\log\\*.Log', - ], - 'LogSplit' => [ - 'description' => 'The result that is returned after on-premises log data is split based on the specified matching mode.'."\n" - ."\n" - .'> The matching modes of on-premises log data include full regex mode, delimiter mode, and JSON mode.'."\n", - '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' => 'The method that is used to aggregate on-premises log data.'."\n", - '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' => 'The sample on-premises log.'."\n", - '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' => 'The configurations of the logs that are imported from Log Service.'."\n", - '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' => 'The configurations of the logs that are imported from Log Service.'."\n" - ."\n" - .'> This parameter is returned only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The conditions that are used to filter logs imported from Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Relation' => [ - 'description' => 'The relationship between multiple filter conditions. Valid values:'."\n" - ."\n" - .'* and (default): Logs are processed only if all filter conditions are met.'."\n" - .'* or: Logs are processed if one of the filter conditions is met.'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'Filters' => [ - 'description' => 'The conditions that are used to filter logs imported from Log Service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The conditions that are used to filter logs imported from Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to filter logs imported from Log Service.'."\n", - 'type' => 'string', - 'example' => 'host', - ], - 'Operator' => [ - 'description' => 'The method that is used to filter logs imported from Log Service. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `=`: equal to'."\n" - .'* `! =`: not equal to'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'example' => '=', - ], - 'Value' => [ - 'description' => 'The value of the key that is used to filter logs imported from Log Service.'."\n", - 'type' => 'string', - 'example' => '200', - ], - ], - ], - ], - ], - ], - 'Statistics' => [ - 'description' => 'The methods that are used to aggregate logs imported from Log Service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method that is used to aggregate logs imported from Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Log Service.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate log data within a statistical period. Valid values:'."\n" - ."\n" - .'* count: counts the number.'."\n" - .'* sum: calculates the total value.'."\n" - .'* avg: calculates the average value.'."\n" - .'* max: calculates the maximum value.'."\n" - .'* min: calculates the minimum value.'."\n" - .'* value: collects samples within the statistical period.'."\n" - .'* countps: calculates the average number of the specified field per second by using the following formula: Counted number of the specified field/Total number of seconds within the statistical period.'."\n" - .'* sumps: calculates the average number of the specified field per second by using the following formula: Total value of the specified field/Total number of seconds within the statistical period.'."\n" - .'* distinct: counts the number of logs where the specified field appears within the statistical period.'."\n" - .'* distribution: counts the number of logs that meet a specified condition within the statistical period.'."\n" - .'* percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.'."\n", - 'type' => 'string', - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'example' => 'level_count', - ], - 'Parameter1' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Log Service.'."\n" - ."\n" - .'* If the `Function` parameter is set to `distribution`, this parameter indicates the lower limit of the statistical interval. For example, 200 indicates that the number of HTTP requests whose status code is 2XX is calculated.'."\n" - .'* If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Parameter2' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Log Service.'."\n" - ."\n" - .'> This parameter is returned only if the `Function` parameter is set to `distribution`. This parameter indicates the upper limit of the statistical interval. For example, 299 indicates that the number of HTTP requests whose status code is 2XX is calculated.'."\n", - 'type' => 'string', - 'example' => '299', - ], - ], - ], - ], - 'GroupBy' => [ - 'description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Log Service.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'example' => 'ApiResult', - ], - ], - ], - ], - 'Express' => [ - 'description' => 'The extended fields that indicate the results of basic operations that are performed on aggregation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The extended field that indicates the result of basic operations that are performed on aggregation results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Express' => [ - 'description' => 'The extended field that indicates the result of basic operations that are performed on aggregation results.'."\n", - 'type' => 'string', - 'example' => 'success_count', - ], - 'Alias' => [ - 'description' => 'The alias of the extended field that indicates the result of basic operations that are performed on aggregation results.'."\n", - 'type' => 'string', - 'example' => 'SuccRate', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Results:'."\n" + ."\n" + .'- If the operation is successful, `successful` is returned.'."\n" + ."\n" + .'- If the operation fails, an error message is returned, such as `alias of aggreate must be set value.`.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '91561287-0802-5F9C-9BDE-404C50D41B06', 'title' => ''], + 'LogId' => ['description' => 'The ID of the log monitoring metric.', 'type' => 'string', 'example' => '16****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: The operation is successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'LimitorError', 'errorMessage' => 'Log monitor limit is not enough', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\n\\t11145B76-566A-5D80-A8A3-FAD98D310079\\n\\t10\\n\\t1\\n\\t1\\n\\t\\n\\t\\t15\\n\\t\\t0\\n\\t\\t\\n\\t\\t36****\\n\\t\\t1639382496000\\n\\t\\t\\n\\t\\t\\n\\t\\taliyun\\n\\t\\t0\\n\\t\\t\\n\\t\\t{\\\\\\"express\\\\\\":[],\\\\\\"filter\\\\\\":{\\\\\\"filters\\\\\\":[]},\\\\\\"groupby\\\\\\":[],\\\\\\"interval\\\\\\":60,\\\\\\"labels\\\\\\":[],\\\\\\"statistics\\\\\\":[{\\\\\\"alias\\\\\\":\\\\\\"referer_count\\\\\\",\\\\\\"function\\\\\\":\\\\\\"count\\\\\\",\\\\\\"key\\\\\\":\\\\\\"referer\\\\\\"}]}\\n\\t\\t\\n\\t\\taliyun_task\\n\\t\\tunknown\\n\\t\\tvpc\\n\\t\\taliyun_sls\\n\\t\\t\\n\\t\\t\\n\\t\\n\\t200\\n\\ttrue\\n\\t","errorExample":""}]', - 'title' => 'DescribeHybridMonitorTaskList', - 'description' => 'This topic provides an example on how to query all metric import tasks that belong to the current Alibaba Cloud account. The returned result indicates that the current account has only one metric import task. The metric import task is named `aliyun_task`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'PutHybridMonitorMetricData' => [ - 'summary' => 'Imports the monitoring data of a metric to a namespace of Hybrid Cloud Monitoring.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create or modify a log monitoring metric', + 'description' => 'This topic provides an example of how to create a log monitoring metric named `cpu_total`. The response shows that the log monitoring metric is created. The log monitoring metric ID is `16****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-11-04T08:57:18.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-11-04T08:57:18.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutLogMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutLogMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"91561287-0802-5F9C-9BDE-404C50D41B06\\",\\n \\"LogId\\": \\"16****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'PutMetricRuleTargets' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-aliyun', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For information about how to obtain the alert rule ID, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ae06917_75a8c43178ab66****', 'title' => ''], ], [ - 'name' => 'MetricList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '上报的监控数据', - 'description' => 'The monitoring data.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '指标名，只能是英文字母、数字、下划线', - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'The name can contain letters, digits, and underscores (\\_). The name must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CPU_Usage', - 'maxLength' => 128, - 'minLength' => 1, - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]*$', - ], - 'Labels' => [ - 'title' => '标签，Key只能是英文字母、数字、下划线', - 'description' => 'The tags of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '只能是英文字母、数字、下划线', - 'description' => 'The tag key of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'The key can contain letters, digits, and underscores (\\_). The key must start with a letter or an underscore (\\_).'."\n" - ."\n" - .'> You must specify both the Key and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], - 'Value' => [ - 'description' => 'The tag value of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'> You must specify both the Key and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], - ], - 'required' => false, - ], - 'required' => false, - 'example' => 'app、ip、hostName等标识信息', - 'maxItems' => 20, - ], - 'Value' => [ - 'title' => '监控值，浮点或整型', - 'description' => 'The value of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'The value must be an integer or a floating-point number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '90', - 'pattern' => '^[0-9\\.]*$', - ], - 'TS' => [ - 'title' => '时间戳，unix毫秒数，如果不传会使用服务器时间', - 'description' => 'The time when the monitoring data is imported. The value is a timestamp.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'Unit: milliseconds. By default, the current time is used.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1640776119473', - ], + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert trigger target.'."\n" + ."\n" + .'For information about how to obtain the alert trigger target ID, see [DescribeMetricRuleTargets](~~121592~~).', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Simple Message Queue (formerly MNS), elastic scaling (ESS), Simple Log Service (SLS), and Function Compute (FC) are supported.'."\n" + ."\n" + .'The following section describes the ARN parameter metric description for Simple Message Queue (formerly MNS):'."\n" + ."\n" + .'`acs:mns:{regionId}:{userId}:/{Resource type}/{Resource name}/message`'."\n" + ."\n" + .'- {regionId}: the region where the MSMQ or topic of Simple Message Queue (formerly MNS) resides.'."\n" + .'- {userId}: the Alibaba Cloud account that owns the resource.'."\n" + .'- {Resource type}: the type of the resource that accepts alert notifications. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {Resource name}: the name of the resource.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.'."\n" + ."\n" + .'ARN for elastic scaling:'."\n" + ."\n" + .'acs:ess:{regionId}:{userId}:scalingGroupId/{Scaling group ID}:scalingRuleId/{Scaling rule ID}'."\n" + ."\n" + .'ARN for Simple Log Service:'."\n" + ."\n" + .'acs:log:{regionId}:{userId}:project/{Project name}/logstore/{Logstore name}'."\n" + ."\n" + .'ARN for Function Compute:'."\n" + ."\n" + .'acs:fc:{regionId}:{userId}:services/{Service name}/functions/{Function name}.', 'type' => 'string', 'required' => true, 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 100, - 'minItems' => 1, + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '返回code', - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5DB1CBCA-D14A-55FA-814F-B4DBD9735F68', - ], - 'ErrorDetail' => [ - 'title' => '不合法的指标信息', - 'description' => 'The details of invalid parameters.'."\n" - ."\n" - .'If a request parameter is invalid, the details of the invalid parameter are returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '错误数据在上报列表中的序号，从0开始', - 'description' => 'The position of the error message in the array.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ErrorMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message of the invalid parameter.'."\n", - 'type' => 'string', - 'example' => 'label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A569B0D-9055-58AF-9E82-BAEAF95C0FD5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: successful.'."\n" + ."\n" + .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailData' => [ + 'description' => 'The list of failures.', + 'type' => 'object', + 'properties' => [ + 'Targets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => 'The alert trigger targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert trigger target.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The ARN of the resource. Format: `acs:{Abbreviation of the Alibaba Cloud service}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Simple Message Queue (formerly MNS), elastic scaling (ESS), Simple Log Service (SLS), and Function Compute (FC) are supported. Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The following section describes the ARN parameter metric description for Simple Message Queue (formerly MNS):'."\n" + ."\n" + .'- {Abbreviation of the Alibaba Cloud service}: mns'."\n" + ."\n" + .'- {userId}: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: the region where the MSMQ or topic of Simple Message Queue (formerly MNS) resides.'."\n" + ."\n" + .'- {Resource type}: the type of the resource that accepts alert notifications. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {Resource name}: the name of the resource.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 200 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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":"\\r\\n\\t5DB1CBCA-D14A-55FA-814F-B4DBD9735F68\\r\\n\\t200\\r\\n\\t","errorExample":""}]', - 'title' => 'PutHybridMonitorMetricData', - 'description' => '## [](#)Prerequisites'."\n" - ."\n" - .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - ."\n" - .'## [](#)Limits'."\n" - ."\n" - .'The size of the monitoring data that you import at a time must be less than or equal to 1 MB.'."\n" - ."\n" - .'## [](#)Operation description'."\n" - ."\n" - .'This topic provides an example on how to import the monitoring data of the `CPU_Usage` metric to the `default-aliyun` namespace of Hybrid Cloud Monitoring.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Add or modify push channels for a specified alert rule', + 'summary' => 'Adds or modifies push channels for a specified alert rule by calling the PutMetricRuleTargets operation.', + 'description' => '## Usage notes'."\n" + .'This topic provides an example on how to associate the resource `acs:mns:ap-southeast-1:120886317861****:/queues/test/message` with the alert rule `ae06917_75a8c43178ab66****`. The alert trigger target ID is `1`. The response shows that the resource is associated.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeHybridMonitorDataList' => [ - 'summary' => 'Queries the monitoring data in a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-03-21T06:36:40.000Z', 'description' => 'Request parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMetricRuleTargets'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For more information about how to query the names of namespaces, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'default-aliyun', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutMetricRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'PutMonitorGroupDynamicRule' => [ + 'summary' => 'Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PromSQL', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'> PromQL statements are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'AliyunEcs_cpu_total', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Start', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => false, - 'example' => '1653804865', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'End', + 'name' => 'GroupRules', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'FilterRelation' => ['description' => 'The logical operator used between conditional expressions in the alert rule. Valid values of N: 1 to 3. Valid values:'."\n" + ."\n" + .'- and: The instances that meet all the conditional expressions are automatically added to the application group.'."\n" + ."\n" + .'- or: The instances that meet one of the conditional expressions are automatically added to the application group.', 'type' => 'string', 'required' => true, 'example' => 'and', 'title' => ''], + 'Filters' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value to be matched with the specified field. Valid values of N: 1 to 3.', 'type' => 'string', 'required' => true, 'example' => 'nginx', 'title' => ''], + 'Name' => ['description' => 'The name of the field based on which instances are filtered. Valid values of N: 1 to 3.'."\n" + ."\n" + .'Only hostnames are supported. Example: hostName.', 'type' => 'string', 'required' => true, 'example' => 'hostName', 'title' => ''], + 'Function' => ['description' => 'The method that is used to filter instances. Valid values of N: 1 to 3. Valid values:'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- notContains: does not contain'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix', 'type' => 'string', 'required' => true, 'example' => 'contains', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + 'Category' => ['description' => 'The cloud service to which the alert rule is applied. Valid values of N: 1 to 3. Valid values:'."\n" + ."\n" + .'- ecs: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'docRequired' => false, - 'example' => '1653805225', + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Period', + 'name' => 'IsAsync', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The mode for creating the alert rule. Valid values:'."\n" + ."\n" + .'- true: creates asynchronously'."\n" + ."\n" + .'- false (default): creates synchronously', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'end timestamp must not be before start time.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C240412F-3F5F-50E2-ACEC-DE808EF9C4BE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'TimeSeries' => [ - 'description' => 'The returned monitoring data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'AliyunEcs_cpu_total', - ], - 'Labels' => [ - 'description' => 'The tags of the time dimension.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'K' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], - 'V' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'i-rj99xc6cptkk64ml****', - ], - ], - ], - ], - 'Values' => [ - 'description' => 'The metric values that are collected at different timestamps.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'V' => [ - 'description' => 'The metric value.'."\n", - 'type' => 'string', - 'example' => '0.13', - ], - 'Ts' => [ - 'description' => 'The timestamp that indicates the time when the metric value is collected.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '1653804865', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E73F1AB-D195-438A-BCA7-2F4355789C58', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'Bad request.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + 412 => [ + ['errorCode' => 'OverLimit', 'errorMessage' => 'Matched instances count was over limit', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - '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":"\\n\\t\\n\\t\\tAliyunEcs_cpu_total\\n\\t\\t\\n\\t\\t\\t0.13\\n\\t\\t\\t1653804865\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t0.13\\n\\t\\t\\t1653804925\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t0.13\\n\\t\\t\\t1653804985\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t0.17\\n\\t\\t\\t1653805045\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t0.23\\n\\t\\t\\t1653805105\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t0.2\\n\\t\\t\\t1653805165\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t0.13\\n\\t\\t\\t1653805225\\n\\t\\t\\n\\t\\t\\n\\t\\t\\trg-acfmw3ty5y7****\\n\\t\\t\\trmgroup_id\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tESS\\n\\t\\t\\ttag_ess\\n\\t\\t\\n\\t\\t\\n\\t\\t\\thostname1\\n\\t\\t\\thostname\\n\\t\\t\\n\\t\\t\\n\\t\\t\\ti-rj99xc6cptkk64ml****\\n\\t\\t\\tinstanceId\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-hangzhou\\n\\t\\t\\tregionId\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t192.168.XX.XX\\n\\t\\t\\tipgroup\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t120886317861****\\n\\t\\t\\tuserId\\n\\t\\t\\n\\t\\n\\tC240412F-3F5F-50E2-ACEC-DE808EF9C4BE\\n\\t200\\n\\ttrue\\n\\t","errorExample":""}]', - 'title' => 'DescribeHybridMonitorDataList', - 'description' => '## [](#)Prerequisites'."\n" - ."\n" - .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - ."\n" - .'## [](#)Limits'."\n" - ."\n" - .'The size of monitoring data that is returned in each call cannot exceed 1.5 MB. If the returned data reaches the upper limit, the query fails. You must reset the query conditions.'."\n" - ."\n" - .'## [](#)Operation description'."\n" - ."\n" - .'This topic provides an example to show how to query the monitoring data of the `AliyunEcs_cpu_total` metric in the `default-aliyun` namespace from `1653804865` (14:14:25 on May 29, 2022) to `1653805225` (14:20:25 on May 29, 2022).'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'CreateHybridMonitorSLSGroup' => [ - 'summary' => 'Creates a Logstore group of Hybrid Cloud Monitoring.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'PutMonitorGroupDynamicRule', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-01-27T07:02:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-27T07:02:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-27T07:02:52.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMonitorGroupDynamicRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutMonitorGroupDynamicRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroup', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3E73F1AB-D195-438A-BCA7-2F4355789C58\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'PutMonitoringConfig' => [ + 'summary' => 'Calls the PutMonitoringConfig operation to set the global configuration of the CloudMonitor agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'SLSGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore group.'."\n" - ."\n" - .'The name must be 2 to 32 characters in length and can contain uppercase letters, lowercase letters, digits, and underscores (\\_). The name must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore_test', - ], - ], - [ - 'name' => 'SLSGroupDescription', + 'name' => 'AutoInstall', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the Logstore group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'This parameter is deprecated and can be ignored.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'SLSGroupConfig', + 'name' => 'EnableInstallAgentNewECS', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The configurations of the Logstore group.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSRegion' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'SLSProject' => [ - 'description' => 'The Simple Log Service project.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-project', - ], - 'SLSLogstore' => [ - 'description' => 'The Logstore.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore-ECS', - ], - 'SLSUserId' => [ - 'description' => 'The member ID.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n" - ."\n" - .'If you call this operation by using the management account of a resource directory, you can connect the Alibaba Cloud services that are activated for all members in the resource directory to Hybrid Cloud Monitoring. You can use the resource directory to monitor Alibaba Cloud services across enterprise accounts.'."\n" - ."\n" - .'> If a member uses CloudMonitor for the first time, you must make sure that the service-linked role AliyunServiceRoleForCloudMonitor is attached to the member. For more information, see [Manage the service-linked role for CloudMonitor](~~170423~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '120886317861****', - ], - ], - 'required' => true, - ], - 'required' => true, - 'maxItems' => 30, - 'minItems' => 1, - ], + 'schema' => ['description' => 'Specifies whether to automatically install the CloudMonitor agent on newly purchased ECS instances. Valid values:'."\n" + .'- true (default): The CloudMonitor agent is automatically installed on newly purchased ECS instances.'."\n" + ."\n" + .'- false: The CloudMonitor agent is not automatically installed on newly purchased ECS instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\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' => 'Duplicate.SLSGroup', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter EnableInstallAgentNewECS is not valid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'The parameter is missing or invalid. %s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], ], 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', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Specified parameter EnableInstallAgentNewECS is not valid.\\",\\n \\"RequestId\\": \\"109C8095-6FAD-4DBB-B013-6ED18CE4C0B1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Set the global configuration of the cloudMonitor agent', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMonitoringConfig'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutMonitoringConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n 66683237-7126-50F8-BBF8-D67ACC919A17\\n 200\\n true\\n","errorExample":""}]', - 'title' => 'CreateHybridMonitorSLSGroup', - 'description' => '### [](#)Prerequisites'."\n" - ."\n" - .'Simple Log Service is activated. A project and a Logstore are created in Simple Log Service. For more information, see [Getting Started](~~54604~~).'."\n" - ."\n" - .'### [](#)Operation description'."\n" - ."\n" - .'This topic provides an example on how to create a Logstore group named `Logstore_test`. The region ID is `cn-hangzhou`. The project is `aliyun-project`. The Logstore is `Logstore-ECS`. The response shows that the Logstore group is created.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", ], - 'ModifyHybridMonitorSLSGroup' => [ - 'summary' => 'Modifies a Logstore group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutResourceMetricRule' => [ + 'summary' => 'Sets an alert rule.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'SLSGroupName', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore group.'."\n" - ."\n" - .'For information about how to obtain the name of a Logstore group, see [DescribeHybridMonitorSLSGroup](~~429526~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore_test', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'You can enter a new alert rule ID or use the ID of an existing alert rule in CloudMonitor. For more information about how to query alert rule IDs, see [DescribeMetricRuleList](~~114941~~).'."\n" + ."\n" + .'> If you enter a new alert rule ID, a threshold alert rule is created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', 'title' => ''], ], [ - 'name' => 'SLSGroupDescription', + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'You can enter a new alert rule name or use the name of an existing alert rule in CloudMonitor. For more information about how to query alert rule names, see [DescribeMetricRuleList](~~114941~~).'."\n" + ."\n" + .'> If you enter a new alert rule name, a threshold alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'test123', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service. For more information about how to query the namespace of an Alibaba Cloud service, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> If you create a Prometheus alert rule for Hybrid Cloud Monitoring, set this parameter to `acs_prometheus`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric. For more information about how to query metric names, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> If you create a Prometheus alert rule for Hybrid Cloud Monitoring, this parameter specifies the name of the metric repository. For more information about how to obtain the metric repository name, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => ['description' => 'The resource information, such as `[{"instanceId":"i-uf6j91r34rnwawoo****"}]` or `[{"userId":"100931896542****"}]`.'."\n" + ."\n" + .'For more information about the supported monitoring dimensions, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group. Alert notifications are sent to the alert contacts in the alert contact group.'."\n" + ."\n" + .'> An alert contact group is a group of alert contacts that can contain one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered.', 'type' => 'string', 'required' => false, 'example' => 'https://alert.aliyun.com.com:8080/callback', 'title' => ''], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The effective period of the alert rule.', 'type' => 'string', 'required' => false, 'example' => '00:00-23:59', 'title' => ''], + ], + [ + 'name' => 'NoEffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The time range during which the alert rule is ineffective.', 'type' => 'string', 'required' => false, 'example' => '00:00-06:00', 'title' => ''], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute period. Unit: seconds. Default value: 86400.'."\n" + ."\n" + .'> The mute period specifies the interval at which an alert notification is re-sent if the alert does not recover to Normal.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '86400', 'example' => '86400', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of the metric. Unit: seconds. The default value is the original reporting period of the metric.'."\n" + ."\n" + .'> For more information about how to query the statistical period of a metric, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The trigger period of the alert rule. Unit: seconds.'."\n" + ."\n" + .'> For more information about how to query the statistical period of a metric, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance alert', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for the Critical level.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> At least one of the alert levels Critical (critical), Warn (warning), or Info (information) must be settings. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for the Critical level. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for the Critical level.'."\n" + ."\n\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for the Critical level.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for the Warn level.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> At least one of the alert levels Critical (critical), Warn (warning), or Info (information) must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for the Warn level. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for the Warn level.'."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for the Warn level.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for the Info level.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> At least one of the alert levels Critical (critical), Warn (warning), or Info (information) must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for the Info level. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for the Info level.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for the Info level.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'NoDataPolicy', + 'in' => 'query', + 'schema' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + ."\n" + .'- KEEP\\_LAST\\_STATE (default): No action is performed.'."\n" + .'- INSUFFICIENT\\_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.', 'type' => 'string', 'required' => false, 'example' => 'KEEP_LAST_STATE', 'title' => ''], + ], + [ + 'name' => 'CompositeExpression', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The description of the Logstore group.'."\n", - 'type' => 'string', + 'description' => 'The alert conditions for multiple metrics.'."\n" + ."\n" + .'> Single-metric and multi-metric alert conditions are mutually exclusive and cannot be set at the same time.', + 'type' => 'object', + 'properties' => [ + 'ExpressionList' => [ + 'description' => 'The list of alert conditions created in standard mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name of the Alibaba Cloud service.', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of the metric.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method of the metric. Valid values:'."\n" + .'- $Maximum: maximum value.'."\n" + .'- $Minimum: minimum value.'."\n" + .'- $Average: average value.'."\n" + .'- $Availability: availability rate (typically used for site monitoring).'."\n" + ."\n" + .'> `$` is the unified prefix for metrics. For more information about supported Alibaba Cloud services, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '$Maximum', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator for the threshold. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ExpressionListJoin' => ['description' => 'The relationship between multi-metric alert conditions. Valid values: '."\n" + ."\n" + .'- `&&`: An alert is triggered only when all metrics meet the alert conditions. An alert is triggered only when all expressions in ExpressionList evaluate to `true`.'."\n" + ."\n" + .'- `||`: An alert is triggered when any metric meets the alert conditions.', 'type' => 'string', 'required' => false, 'example' => '||', 'title' => ''], + 'ExpressionRaw' => ['description' => 'The alert condition created by using an expression. This includes but is not limited to the following scenarios:'."\n" + ."\n" + .'- Set an alert blacklist for specific resources. For example, `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50` specifies that no alert is triggered for the instance `i-io8kfvcpp7x5****` even if its `Average` exceeds 50.'."\n" + .'- Set a special alert threshold for a specific instance in the rule. For example, `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)` specifies that an alert is triggered for the instance `i-io8kfvcpp7x5****` only when its `Average` exceeds 80, while an alert is triggered for other instances when their `Average` exceeds 50.'."\n" + .'- Limit the number of instances that exceed the threshold. For example, `count($Average > 20) > 3` specifies that an alert is triggered only when more than three instances in the alert rule have an `Average` greater than 20.', 'type' => 'string', 'required' => false, 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL: critical.'."\n" + .'- WARN: warning.'."\n" + .'- INFO: information.', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert condition must be met before an alert notification is sent.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], 'required' => false, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'SLSGroupConfig', + 'name' => 'Labels', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The configurations of the Logstore group.'."\n" + 'description' => 'When the metric meets the alert condition and an alert is triggered, the labels are written to the metric and displayed in the alert notification.'."\n" ."\n" - .'Valid values of N: 1 to 25.'."\n", + .'> This feature is the same as the Label feature in Prometheus alerting.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', - 'properties' => [ - 'SLSRegion' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'SLSProject' => [ - 'description' => 'The Simple Log Service project.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-project', - ], - 'SLSLogstore' => [ - 'description' => 'The Logstore.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore-aliyun-all', - ], - 'SLSUserId' => [ - 'description' => 'The member ID.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n" - ."\n" - .'If you call this operation by using the management account of a resource directory, you can connect the Alibaba Cloud services that are activated for all members in the resource directory to Hybrid Cloud Monitoring. You can use the resource directory to monitor Alibaba Cloud services across enterprise accounts.'."\n" - ."\n" - .'> If a member uses CloudMonitor for the first time, you must make sure that the service-linked role AliyunServiceRoleForCloudMonitor is attached to the member. For more information, see [Manage the service-linked role for CloudMonitor](~~170423~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '120886317861****', - ], + 'properties' => [ + 'Key' => ['description' => 'The label key.', 'type' => 'string', 'required' => false, 'example' => 'tagKey1', 'title' => ''], + 'Value' => ['description' => 'The label value.'."\n" + ."\n" + .'> The label value supports template parameters. Template parameters are replaced with actual label values.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - 'maxItems' => 30, - 'minItems' => 1, + 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Prometheus', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'The Prometheus alert configuration.'."\n" + ."\n" + .'> Set this parameter only when you create a Prometheus alert rule for Hybrid Cloud Monitoring.', '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' => 'NotFound.SLSGroup', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + 'PromQL' => ['description' => 'The PromQL query statement.'."\n" + ."\n" + .'> The data retrieved by the PromQL query statement is the alert data. Include the alert threshold in this statement.', 'type' => 'string', 'required' => false, 'example' => 'cpuUsage{instanceId="xxxx"}[1m]>90', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL: critical.'."\n" + .'- WARN: warning.'."\n" + .'- INFO: information.', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert condition must be met before an alert notification is sent.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Annotations' => [ + 'description' => 'The annotations for Prometheus alerting. The annotation keys and values are rendered to help you understand the metrics or alert rules.'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + .'> This feature is equivalent to the Annotation feature in Prometheus.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The annotation key.', 'type' => 'string', 'required' => false, 'example' => 'summary', 'title' => ''], + 'Value' => ['description' => 'The annotation value.', 'type' => 'string', 'required' => false, 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - '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":"\\n 66683237-7126-50F8-BBF8-D67ACC919A17\\n 200\\n true\\n","errorExample":""}]', - 'title' => 'ModifyHybridMonitorSLSGroup', - 'description' => 'In this example, a Logstore group named `Logstore_test` is modified. The Logstore of the `aliyun-project` project in the `cn-hangzhou` region is changed to `Logstore-aliyun-all`. The response shows that the Logstore group is modified.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DeleteHybridMonitorSLSGroup' => [ - 'summary' => 'Deletes a Logstore group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'SLSGroupName', + 'name' => 'SendOK', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore group.'."\n" - ."\n" - .'For information about how to obtain the name of a Logstore group, see [DescribeHybridMonitorSLSGroup](~~429526~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore_test', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to send a recovery notification.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The 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' => 'RESOURCE_NOT_FOUND', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '85198BFF-1DE6-556E-B6A4-C77C51C62B8D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9436', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 429 => [ + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Set a threshold alert rule for a specified metric of a specified resource', + 'description' => 'This topic provides an example on how to set a threshold alert rule for the `cpu_total` metric of the Elastic Computing Service (ECS) instance `i-uf6j91r34rnwawoo****` in the `acs_ecs_dashboard` namespace. The alert contact group is `ECS_Group`, the alert rule name is `test123`, the alert rule ID is `a151cd6023eacee2f0978e03863cc1697c89508****`, the statistical method for the Critical level is `Average`, the comparison operator for the Critical level is `GreaterThanOrEqualToThreshold`, the threshold for the Critical level is `90`, and the retry count for the Critical level is `3`.'."\n" + .'> As of August 15, 2024, Statistics validation is increased. The statistical value must match the Statistics of the corresponding metric. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-01T02:36:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-27T11:46:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-26T09:11:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-07-29T09:41:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutResourceMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutResourceMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n 85198BFF-1DE6-556E-B6A4-C77C51C62B8D\\n 200\\n true\\n","errorExample":""}]', - 'title' => 'DeleteHybridMonitorSLSGroup', - 'description' => 'This topic provides an example on how to delete a Logstore group named `Logstore_test`. The response shows that the Logstore group is deleted.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'DescribeHybridMonitorSLSGroup' => [ - 'summary' => 'Queries Logstore groups.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutResourceMetricRules' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to search for Logstore groups.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Logstore', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Minimum value: 1. Default value: 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'Rules', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The page number.'."\n" + 'description' => 'The list of threshold alert rules.'."\n" ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'SLSGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Logstore_test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" + .'Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => ['description' => 'The threshold for Info-level alerts.'."\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' => 'NotFound.SLSGroup', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => '', - ], - 'List' => [ - 'description' => 'The queried Logstore groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSGroupName' => [ - 'description' => 'The name of the Logstore group.'."\n", - 'type' => 'string', - 'format' => 'int64', - 'example' => 'Logstore_test', - ], - 'SLSGroupDescription' => [ - 'description' => 'The description of the Logstore group.'."\n", - 'type' => 'string', - 'example' => '', + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'For more information about how to query metric names, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + 'Escalations.Warn.Threshold' => ['description' => 'The threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The effective period of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => '00:00-23:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time range during which the alert rule is ineffective.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => '00:00-06:00', 'title' => ''], + 'RuleId' => ['description' => 'The alert rule ID.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'You can enter a new alert rule ID or use an existing alert rule ID in CloudMonitor. For more information about how to query alert rule IDs, see [DescribeMetricRuleList](~~114941~~).'."\n" + ."\n" + .'> If you enter a new alert rule ID, a threshold alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', 'title' => ''], + 'Escalations.Critical.Times' => ['description' => 'The retry count for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Escalations.Critical.Threshold' => ['description' => 'The threshold for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'Escalations.Critical.Statistics' => ['description' => 'The statistics method for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service. Examples: Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical (critical), Warn (warning), or Info (information). For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.ComparisonOperator' => ['description' => 'The comparison operator for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Info.Times' => ['description' => 'The retry count for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Resources' => ['description' => 'The resource information, such as `[{"instanceId":"i-uf6j91r34rnwawoo****"}]` or `[{"userId":"100931896542****"}]`.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'For more information about the supported dimensions, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', 'title' => ''], + 'SilenceTime' => ['description' => 'The mute period.'."\n" + ."\n" + .'Unit: seconds. Default value: 86400.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> The mute period specifies the interval at which an alert notification is sent again if the alert is not cleared.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'https://alert.aliyun.com.com:8080/callback', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group. Alert notifications are sent to the alert contacts in the alert contact group.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> An alert contact group contains one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~).', 'type' => 'string', 'required' => true, 'example' => 'ECS_Group', 'title' => ''], + 'Namespace' => ['description' => 'The data namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'For more information about how to query the data namespace of an Alibaba Cloud service, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'EmailSubject' => ['description' => 'The subject of the alert email.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance alert', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the metric.'."\n" + ."\n" + .'Unit: seconds. Default value: the original reporting period of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> For more information about how to query the statistical period of a metric, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + 'RuleName' => ['description' => 'The alert rule name.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'You can enter a new alert rule name or use an existing alert rule name in CloudMonitor. For more information about how to query alert rule names, see [DescribeMetricRuleList](~~114941~~).'."\n" + ."\n" + .'> If you enter a new alert rule name, a threshold alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'test123', 'title' => ''], + 'Escalations.Info.Statistics' => ['description' => 'The statistics method for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service. Examples: Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical (critical), Warn (warning), or Info (information). For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.Times' => ['description' => 'The retry count for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Escalations.Info.ComparisonOperator' => ['description' => 'The comparison operator for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Interval' => ['description' => 'The trigger period of the alert rule.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> For more information about how to query the statistical period of a metric, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + 'Escalations.Critical.ComparisonOperator' => ['description' => 'The comparison operator for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Warn.Statistics' => ['description' => 'The statistics method for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service. Examples: Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical (critical), Warn (warning), or Info (information). For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'NoDataPolicy' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + ."\n" + .'- KEEP_LAST_STATE (default): No action is taken.'."\n" + .'- INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'KEEP_LAST_STATE', 'title' => ''], + 'Labels' => [ + 'description' => 'When the metric reaches the alert condition and an alert is triggered, the labels are written to the metric and displayed in the alert notification.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The label key.', 'type' => 'string', 'required' => false, 'example' => 'tagKey1', 'title' => ''], + 'Value' => ['description' => 'The label value.'."\n" + ."\n" + .'> The label value supports template parameters. Template parameters are replaced with actual label values.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], - 'SLSGroupConfig' => [ - 'description' => 'The configurations of the Logstore group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSRegion' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'SLSProject' => [ - 'description' => 'The Simple Log Service project.'."\n", - 'type' => 'string', - 'example' => 'aliyun-project', - ], - 'SLSLogstore' => [ - 'description' => 'The Logstore.'."\n", - 'type' => 'string', - 'example' => 'Logstore-aliyun-all', - ], - 'SLSUserId' => [ - 'description' => 'The member ID.'."\n" + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', + ], + 'SendOK' => ['description' => 'Specifies whether to send a recovery notification.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 500, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15D1440E-BF24-5A41-93E4-36864635179E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailedListResult' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => 'The list of failed results for setting alert rules on resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'RuleId' => ['description' => 'The alert rule ID.', 'type' => 'string', 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', 'title' => ''], + 'Result' => [ + 'description' => 'The failure result.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" - .'**Description** This parameter is returned when you call the operation by using an administrative account.', - 'type' => 'string', - 'example' => '120886317861****', + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the Logstore group was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1652845630000', - ], - 'UpdateTime' => [ - 'description' => 'The time when the Logstore group was modified.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1652845630000', - ], + 'title' => '', + 'example' => '', ], ], - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 422 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Create multiple threshold alert rules for a specified metric of a specified resource', + 'summary' => 'Calls the PutResourceMetricRules operation to create multiple threshold alert rules for a specified metric of a specified resource.', + 'description' => 'This topic provides an example of how to create a threshold alert rule for the `cpu_total` metric of the Elastic Computing Service (ECS) instance `i-uf6j91r34rnwawoo****` in the `acs_ecs_dashboard` namespace. The alert contact group is set to `ECS_Group`, the alert rule name is set to `test123`, the alert rule ID is set to `a151cd6023eacee2f0978e03863cc1697c89508****`, the statistics method for the Critical level is set to `Average`, the comparison operator for the Critical level is set to `GreaterThanOrEqualToThreshold`, the threshold for the Critical level is set to `90`, and the retry count for the Critical level is set to `3`.'."\n" + .'> As of August 15, 2024, Statistics validation is added. You can set the statistics value only to the Statistics value that corresponds to the metric. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutResourceMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutResourceMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n 66683237-7126-50F8-BBF8-D67ACC919A17\\n 10\\n 1\\n 2\\n \\n 1652845630000\\n Logstore_test\\n 1652845630000\\n \\n \\n aliyun-project\\n cn-hangzhou\\n Logstore-aliyun-all\\n \\n \\n \\n 1649230049000\\n Logstore_aliyun\\n 1649230049000\\n \\n \\n aliyun-test\\n cn-qingdao\\n oss_log\\n \\n \\n 200\\n true\\n","errorExample":""}]', - 'title' => 'DescribeHybridMonitorSLSGroup', - 'description' => 'In this example, all Logstore groups within the current account are queried. The response shows that the current account has two Logstore groups: `Logstore_test` and `Logstore_aliyun`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'Cursor' => [ - 'summary' => 'Defines the range of monitoring data that you want to export. The Cursor information is returned. When you call the BatchExport operation for the first time, you must specify the Cursor information.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveTags' => [ + 'summary' => 'The RemoveTags operation removes one or more tags.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'Metric', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about the metrics of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_idle', - ], - ], - [ - 'name' => 'Period', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The time interval based on which the metric value is measured.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> Generally, the time interval is 60 seconds. For more information about specific values, see the `Period` parameter in [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '60', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. For example, 2023-01-01T00:00:00Z indicates January 1, 2023, 00:00:00 UTC.'."\n" - ."\n" - .'> In CloudMonitor, the TTL of monitoring data varies with the time granularity. Specify a proper time interval based on the TTL corresponding to the value of the `Period` parameter.'."\n", - 'type' => 'string', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n" + ."\n" + .'> You must specify both the tag key (`Tag.N.Key`) and the tag value (`Tag.N.Value`).', 'type' => 'string', 'required' => true, 'example' => 'Key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n" + ."\n" + .'> You must specify both the tag key (`Tag.N.Key`) and the tag value (`Tag.N.Value`).', 'type' => 'string', 'required' => true, 'example' => 'Value1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '1641627000000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. For example, 2023-01-01T00:00:00Z indicates January 1, 2023, 00:00:00 UTC.'."\n" - ."\n" - .'* If you do not set the end time, the end time is infinite. You can leave this parameter empty in real-time export scenarios.'."\n" - .'* In CloudMonitor, the TTL of monitoring data varies with the time granularity. Specify a proper time interval based on the TTL corresponding to the value of the `Period` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1641645000000', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Matchers', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The dimension information of the metric.'."\n", + 'description' => 'The ID of the application group.', 'type' => 'array', - 'items' => [ - 'description' => 'The dimension information of the metric.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Matcher', - ], - 'required' => false, + 'items' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + 'required' => true, + 'example' => '12345', + 'maxItems' => 20, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'CursorPopResponse', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Cursor' => [ - 'description' => 'Cursor is used as an input parameter for data export in the [BatchExport](~~2329847~~) operation.'."\n", - 'type' => 'string', - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '915C2D7A-E6A4-17C3-8E13-4DBDD61E7919', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Illegal parameters.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '195390D2-69D0-4D9E-81AA-A7F5BC1B91EB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Tag' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => ['description' => 'The list of removed tags.', 'type' => 'string', 'example' => 'tag1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'RemoveTags', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTags'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:RemoveTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n\\t915C2D7A-E6A4-17C3-8E13-4DBDD61E7919\\n\\tsuccess\\n\\t\\n\\t\\teyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****\\n\\t\\n\\t200\\n\\ttrue\\n\\t","errorExample":""}]', - 'title' => 'Cursor', - 'description' => '### [](#)Prerequisites'."\n" - ."\n" - .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - ."\n" - .'### [](#)Background information'."\n" - ."\n" - .'You can call this operation to obtain the Cursor information and then call the [BatchExport](~~2329847~~) operation to export the monitoring data.'."\n" - ."\n" - .'### [](#)Description'."\n" - ."\n" - .'This topic provides an example on how to define the monitoring data of a specified metric for a specified cloud service. In this example, the namespace of the cloud service is set to `acs_ecs_dashboard`, the metric is set to `cpu_idle`, the start time is set to `1641627000000`, and the end time is set to `1641645000000`. The number of idle CPU cores on your Elastic Compute Service (ECS) instances is measured every 60 seconds from 15:30:00, January 8, 2022 to 20:30:00, January 8, 2022. The `Cursor` information is returned.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'BatchExport' => [ - 'summary' => 'Exports the monitoring data that is defined in the Cursor operation.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SendDryRunSystemEvent' => [ + 'summary' => 'Debugs a system event of an Alibaba Cloud service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> The value of this parameter must be the same as the value of the request parameter `Namespace` in the Cursor operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'name' => 'Product', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud service.'."\n" + ."\n" + .'> For information about the Alibaba Cloud services that are supported by CloudMonitor, see [Supported cloud services and their system events](~~167388~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'Metric', - 'in' => 'formData', + 'name' => 'EventName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the system event.'."\n" + ."\n" + .'> For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent_Status_Stopped', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'EventContent', + 'in' => 'query', + 'schema' => ['description' => 'The content of the system event.'."\n" + ."\n" + .'> The value of this parameter is a JSON object. We recommend that you include the `product`, `resourceId`, and `regionId` fields in the JSON object.', '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"}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about the metrics of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> The value of this parameter must be the same as the value of the request parameter `Metric` in the Cursor operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_idle', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'Cursor', - 'in' => 'formData', - 'schema' => [ - 'description' => 'When you call this operation to export data, you must specify the `Cursor` parameter. You can obtain the value of the `Cursor` parameter by using one of the following methods:'."\n" - ."\n" - .'* When you call this operation for the first time, you must call the Cursor operation to obtain the `Cursor` value. For more information, see [Cursor](~~2330730~~).'."\n" - .'* When you call this operation again, you can obtain the `Cursor` value from the returned data of the last call.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'SendDryRunSystemEvent', + 'description' => 'Tests whether a system event can be triggered as expected. Simulates a system event and verifies the response when the event triggers an alert.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDryRunSystemEvent'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:SendDryRunSystemEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'UninstallMonitoringAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Length', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum number of data entries that can be returned in each response.'."\n" - ."\n" - .'Valid values: 1 to 10000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1000', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Measurements', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The statistical methods used to customize the returned data. By default, the measurements based on all statistical methods are returned.'."\n" - ."\n" - .'For example, the `cpu_idle` metric of ECS (`acs_ecs_dashboard`) has three statistical methods: `Average`, `Maximum`, and `Minimum`. If you want to return only the measurements based on the `Average` and `Maximum` statistical methods, set this parameter to `["Average", "Maximum"]`.'."\n" - ."\n" - .'The statistical methods of metrics are displayed in the `Statistics` column on the Metrics page of each cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The statistical method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Maximum', - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the host.', 'type' => 'string', 'required' => true, 'example' => 'host-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '251402CD-305C-1617-808E-D8C11FC8138D', - ], - 'Cursor' => [ - 'description' => 'The Cursor information that is used to call this operation again.'."\n" - ."\n" - .'> If `null` is returned, the monitoring data is exported.'."\n", - 'type' => 'string', - 'example' => 'v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***', - ], - 'Length' => [ - 'description' => 'The number of data entries returned in this call.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Anchor' => [ - 'description' => 'The timestamp of the data requested by the backend. A larger timestamp indicates that the data export time is closer to the current time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1678781819000', - ], - 'HasNext' => [ - 'description' => 'Indicates whether the data has been exported. Valid values:'."\n" - ."\n" - .'* true: Some data is not exported.'."\n" - .'* false: All the data is exported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DataResults' => [ - 'description' => 'The data returned in this call.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The exported data. The following parameters are involved:'."\n" - ."\n" - .'* Namespace: the namespace of the cloud service. Example: `acs_ecs_dashboard`.'."\n" - .'* Metric: the name of the metric. Example: `cpu_idle`.'."\n" - .'* Timestamp: the timestamp of the monitoring data. Unit: milliseconds. Example: 1641454680000.'."\n" - .'* Period: the statistical period of the monitoring data. Unit: seconds. Example: 60.'."\n" - .'* Dimensions: the dimensions used to identify the monitored instance, for example, `[{"Label":"userId", "Value":""20654616023382****"}, {"Label":"InstanceId", "Value":""i-2ze2d6j5uhg20x4****"}]`.'."\n" - .'* Associated: the additional information about the monitored instance, such as the tags in key-value pairs. Example: `{"group":"test****", "name":"Alice"}`.'."\n" - .'* Measurements: the statistical methods of the metric. Multiple values are displayed by default. Example: `{"Average":60,"Maximum":85}`.'."\n" - .'* LogTime: the time when the monitoring data is recorded. Unit: milliseconds. For non-raw data (aggregated data), the value of `LogTime` is null.'."\n", - '$ref' => '#/components/schemas/MetricStat', - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Successfully', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '466902B9-2842-40B0-B796-00FE772B6EF3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 412 => [ + ['errorCode' => 'AgentStateError', 'errorMessage' => 'Expected agent running state is stopped.', 'description' => 'Uninstall the plug-in when the status is Stopped.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'UninstallMonitoringAgent', + 'summary' => 'Uninstalls the CloudMonitor agent from a third-party host.', + 'description' => '> This API operation is not applicable to Elastic Compute Service (ECS) instances. To uninstall the agent from an ECS instance, see [Install and uninstall the CloudMonitor agent](~~183482~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-27T07:31:04.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallMonitoringAgent'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:UninstallMonitoringAgent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"\\n \\n \\n \\n \\n 1270676***********\\n \\n \\n \\n r-rj9f9s*********\\n \\n \\n \\n r-rj9f9s19lsu*******\\n \\n \\n acs_kvstore\\n 1678781700000\\n SplitrwProxyMaxResponseSize\\n 60\\n \\n 0.583\\n 0.583\\n \\n \\n 733A3B5A-F082-1092-B429-1208168FC07F\\n 200\\n 10\\n success\\n v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy04ZGMwLTZlY2QxZGVhZGY***************\\n true\\n true\\n 1678781819000\\n","errorExample":""}]', - 'title' => 'BatchExport', - 'description' => '### [](#)Prerequisites'."\n" - ."\n" - .'The `Cursor` information is returned by calling the [Cursor](~~2330730~~) operation.'."\n" - ."\n" - .'### [](#)Description'."\n" - ."\n" - .'This topic provides an example on how to export the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The `Cursor` information is specified. A maximum of 1,000 data entries can be returned in each response.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successfully\\",\\n \\"RequestId\\": \\"466902B9-2842-40B0-B796-00FE772B6EF3\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-beijing.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhengzhou-jva.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-heyuan.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-northeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-northeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-3.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-5.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-5.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-6.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-7.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'ap-southeast-8', 'regionName' => 'Malaysia (Johor)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-8.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-8.aliyuncs.com', 'vpc' => 'cms-vpc.ap-southeast-8.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'regionName' => 'China (Zhongwei)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhongwei.aliyuncs.com', 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', 'vpc' => 'cms-vpc.cn-zhongwei.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-qingdao.aliyuncs.com', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-shanghai.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-hongkong.aliyuncs.com', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-shenzhen.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-nanjing.aliyuncs.com', 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-nanjing.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-fuzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-fuzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-chengdu.aliyuncs.com', 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-guangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-huhehaote.aliyuncs.com', 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-hangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-southeast-1', 'regionName' => 'US（Atlanta）', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-west-1.aliyuncs.com', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'regionName' => 'France (Paris)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-west-2.aliyuncs.com', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com', 'vpc' => 'cms-vpc.eu-west-2.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-central-1.aliyuncs.com', 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-east-1.aliyuncs.com', 'endpoint' => 'metrics.us-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-west-1.aliyuncs.com', 'endpoint' => 'metrics.us-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.na-south-1.aliyuncs.com', 'endpoint' => 'metrics.na-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.na-south-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.me-east-1.aliyuncs.com', 'endpoint' => 'metrics.me-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.ap-south-1.aliyuncs.com', 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.me-central-1.aliyuncs.com', 'endpoint' => 'metrics.me-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu-gic-1', 'regionName' => 'China (Ulanqab) GIC', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'vpc' => 'cms-vpc.cn-wulanchabu-gic-1.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan-acdr-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-north-2-gov-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessDeniedException', 'message' => 'You do not have the authority to operate this rule.', 'http_code' => 401, 'description' => 'ess rules cannot be modified in the cloud monitoring console.'], + ['code' => 'AccessForbidden', 'message' => 'No permission, please use Ram for authorization.', 'http_code' => 403, 'description' => 'No permission, please use Ram for authorization.'], + ['code' => 'AgentStateError', 'message' => 'Expected agent running state is stopped.', 'http_code' => 412, 'description' => 'Uninstall the plug-in when the status is Stopped.'], + ['code' => 'BadRequest', 'message' => 'Bad request.', 'http_code' => 400, 'description' => 'Error Parameter Request'], + ['code' => 'ContactNotExists', 'message' => 'ContactName does not exist.', 'http_code' => 404, 'description' => 'The contact name was not found.'], + ['code' => 'CSS_CREATE_ORDER_ERROR', 'message' => 'Create order error', 'http_code' => 400, 'description' => 'Failed to create order'], + ['code' => 'EmptyProbeList', 'message' => 'The selected probe list is empty.', 'http_code' => 400, 'description' => 'The selected probe list is empty'], + ['code' => 'ExceedingQuota', 'message' => 'You have exceeded the task limit.', 'http_code' => 406, 'description' => 'You have exceeded the task limit'], + ['code' => 'ExceedingQuota', 'message' => 'Exceeding quota limits.', 'http_code' => 406, 'description' => 'The number of tasks exceeds the limit'], + ['code' => 'Forbidden', 'message' => 'You are not authorized to operate the specified resource.', 'http_code' => 403, 'description' => 'No permission, please use RAM to authorize'], + ['code' => 'FrequencyLimit', 'message' => 'Frequency too high, please try again later.', 'http_code' => 429, 'description' => 'Frequency too high, please try again later'], + ['code' => 'Illegal Task Name', 'message' => 'The task name of the sitemonitor task is illegal.', 'http_code' => 400, 'description' => 'Site monitoring task name is illegal.'], + ['code' => 'IllegalAddress', 'message' => 'illegal address.', 'http_code' => 400, 'description' => 'Illegal Address'], + ['code' => 'Illgeal Task Name', 'message' => 'The task name for sitemonitor task is illegal.', 'http_code' => 400, 'description' => 'Site monitoring task name is illegal'], + ['code' => 'InsecureParams', 'message' => 'The params for site monitor is insecure.', 'http_code' => 400, 'description' => 'There is a security risk to the parameters of the site monitoring task'], + ['code' => 'InternalError', 'message' => '%s.', 'http_code' => 500, 'description' => '%s'], + ['code' => 'InternalUnknownError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'A service runtime error occurred.'], + ['code' => 'InternetServerError', 'message' => 'System internal error.', 'http_code' => 500, 'description' => 'System internal error'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied', 'http_code' => 403, 'description' => 'Permission denied.'], + ['code' => 'InvalidAuthorization', 'message' => 'InvalidAuthorization.', 'http_code' => 403, 'description' => 'You do not have the required permissions.'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied.', 'http_code' => 403, 'description' => 'You do not have the required permissions.'], + ['code' => 'InvalidAuthorizationTokenExpire', 'message' => 'Authentication token expired, please re-authenticate.', 'http_code' => 403, 'description' => 'Authentication token expired, please re-authenticate'], + ['code' => 'InvalidClientTokenId', 'message' => 'not allow this operation.', 'http_code' => 403, 'description' => 'No permission'], + ['code' => 'InvalidParameter', 'message' => '%s is missing or invalid.', 'http_code' => 400, 'description' => 'The request parameters are invalid or required parameters are missing (such as GroupName, WorkspaceId, GroupId, or region being empty).'], + ['code' => 'InvalidParameter', 'message' => 'Invalid parameter.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'InvalidParameterValue', 'message' => 'Illegal parameters.', 'http_code' => 400, 'description' => 'Illegal parameters.'], + ['code' => 'InvalidQueryParameter', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => 'Query parameter error'], + ['code' => 'InvalidQueryParameter', 'message' => 'Invalid query parameter.', 'http_code' => 400, 'description' => 'Bad query parameters'], + ['code' => 'MaxRcaTimesExceed', 'message' => 'The maximum reanalysis limit has been reached.', 'http_code' => 400, 'description' => 'The maximum reanalysis limit has been reached.'], + ['code' => 'NameRepeat', 'message' => 'The task name already exists.', 'http_code' => 400, 'description' => 'The task name already exists. Make sure that the task name is not used in protocol-based synthetic tests and synthetic tests for browsers.'], + ['code' => 'NotAuthSLR', 'message' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', 'http_code' => 403, 'description' => 'The service-linked role AliyunServiceRoleForCloudMonitor is required.'], + ['code' => 'NotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The corresponding resource was not found.'], + ['code' => 'NotFound.EndpointConnector', 'message' => 'endpoint connector not found.', 'http_code' => 404, 'description' => 'endpoint connector does not exist'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid Isp.', 'http_code' => 400, 'description' => 'Invalid Isp'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid IspCity for certain probes.', 'http_code' => 400, 'description' => 'The isp or city of certain probes provided is invalid.'], + ['code' => 'OperatorCityInvalid', 'message' => 'The synthetic probe info provided is incorrect. The incorrect probe info are as below. %s.', 'http_code' => 400, 'description' => 'The synthetic probe info provided is incorrect.'], + ['code' => 'ParameterInvalid', 'message' => 'The parameter is missing or invalid. %s', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'ParameterInvalid', 'message' => 'Parameter invalid.', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'PhoneIsEmptyOrNotVerified', 'message' => 'Contact does not have a phone number configured or not verified.', 'http_code' => 400, 'description' => 'Contact does not have a phone number configured or not verified'], + ['code' => 'RateLimit', 'message' => 'Service rate limit.', 'http_code' => 400, 'description' => 'Service load is high, please try again later'], + ['code' => 'ResourceExist', 'message' => 'Resource already exist .', 'http_code' => 400, 'description' => 'The resource already exists.'], + ['code' => 'ResourceLimit', 'message' => 'Namespace limited.', 'http_code' => 400, 'description' => 'A maximum of 30 indicator warehouses can be created for one account.'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The specified resource is not found.'], + ['code' => 'ResourceNotFound', 'message' => 'Resource % not found.', 'http_code' => 404, 'description' => '已废弃'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource %s is not found.', 'http_code' => 404, 'description' => 'The specified resource% s does not exist.'], + ['code' => 'ResourceOverLimit', 'message' => 'The resource has exceeded the limit. %s', 'http_code' => 429, 'description' => 'The quantity limit has been exceeded.'], + ['code' => 'RestrictedUser', 'message' => 'The user has no access to this operation. %s.', 'http_code' => 403, 'description' => 'The user does not have permission for the current action.'], + ['code' => 'RmcNotEnabled', 'message' => 'ResourceCenter Service is not enabled.', 'http_code' => 403, 'description' => 'You have not activated Resource Center.'], + ['code' => 'StrategyNameConflict', 'message' => 'The specified strategy name exits already.', 'http_code' => 400, 'description' => 'The specified strategy name already exists'], + ['code' => 'TaskIdNotExist', 'message' => 'Task does not exist.', 'http_code' => 404, 'description' => 'Task does not exist'], + ['code' => 'TaskNotExist', 'message' => 'Task does not exist.', 'http_code' => 400, 'description' => 'Site monitoring task does not exist'], + ['code' => 'TaskNotExist', 'message' => 'The specified task does not exist.', 'http_code' => 404, 'description' => 'The specified task does not exist.'], + ['code' => 'UnauthorizedTasks', 'message' => 'You are not permitted to operate the specified tasks.', 'http_code' => 403, 'description' => 'You are not permitted to operate the specified tasks.'], + ['code' => 'UnsupportedWorkspaceRegion', 'message' => 'Synthetic monitoring is not supported in this workspace region.', 'http_code' => 400, 'description' => 'Synthetic monitoring is not supported in this workspace region.'], + ['code' => 'VerifyCodeIsSent', 'message' => 'Verification code sent too often, please try again later.', 'http_code' => 400, 'description' => 'The verification code is sent too often, please try again later.'], + ['code' => 'WorkspaceNotExist', 'message' => 'The specified workspace does not exist.', 'http_code' => 400, 'description' => 'The workspace does not exist.'], + ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid or a required parameter is missing.', 'http_code' => 400, 'description' => 'The request parameter is invalid or a required parameter is missing.'], + ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults parameter is invalid.', 'http_code' => 400, 'description' => 'The MaxResults parameter is invalid, must be a positive integer within the allowed limit.'], + ['code' => 'InvalidParameter.NextToken', 'message' => 'The NextToken is invalid or does not match the request parameters.', 'http_code' => 400, 'description' => 'The NextToken is invalid or does not match the request parameters.'], + ['code' => 'InvalidParameter.RegionId', 'message' => 'Unable to determine the region for the observe group.', 'http_code' => 400, 'description' => 'Unable to determine the region: the account has not enabled CloudResource and no central region can be derived.'], + ['code' => 'ObserveGroup.AlreadyExists', 'message' => 'An observe group with the same name already exists in the workspace.', 'http_code' => 409, 'description' => 'An observe group with the same name already exists in the workspace.'], + ['code' => 'DatabaseError', 'message' => 'A database error occurred while processing the request.', 'http_code' => 500, 'description' => 'A database error occurred. Please retry later or contact the administrator.'], + ['code' => 'ObserveGroup.NotFound', 'message' => 'The specified observe group does not exist.', 'http_code' => 404, 'description' => 'The specified observe group does not exist. Please check the ObserveGroupId.'], + ['code' => 'InternalError', 'message' => 'An internal error occurred while processing the request.', 'http_code' => 500, 'description' => 'An internal error occurred (e.g. failed to update Diamond config or deliver MetaQ). Please retry later.'], + ['code' => 'Workspace.NotFound', 'message' => 'The specified workspace does not exist or you have no permission.', 'http_code' => 404, 'description' => 'The specified workspace does not exist or you have no access.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddTags'], + ], + 'createdAt' => '2024-08-28T10:01:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2024-08-05T11:10:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2024-07-31T06:53:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2024-05-16T06:57:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2024-05-16T06:24:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteCustomMetric'], + ], + 'createdAt' => '2024-04-23T06:11:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2024-04-01T02:36:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDynamicTagRuleList'], + ], + 'createdAt' => '2024-03-13T08:11:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ApplyMetricRuleTemplate'], + ], + 'createdAt' => '2024-02-27T07:25:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricData'], + ], + 'createdAt' => '2024-01-23T02:42:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorTask'], + ], + 'createdAt' => '2023-12-21T08:29:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGroupMetricRules'], + ['description' => 'Request parameters changed', 'api' => 'PutGroupMetricRule'], + ], + 'createdAt' => '2023-12-13T07:03:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogCount'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogHistogram'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogList'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeSystemEventAttribute'], + ], + 'createdAt' => '2023-12-07T03:29:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'createdAt' => '2023-11-24T04:02:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorNamespace'], + ['description' => 'Response parameters changed', 'api' => 'DescribeHybridMonitorNamespaceList'], + ], + 'createdAt' => '2023-11-21T10:00:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeProductsOfActiveMetricRule'], + ], + 'createdAt' => '2023-10-25T07:41:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertingMetricRuleResources'], + ], + 'createdAt' => '2023-10-20T09:21:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMonitorResourceQuotaAttribute'], + ], + 'createdAt' => '2023-10-07T08:33:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteExporterOutput'], + ['description' => 'Response parameters changed', 'api' => 'PutExporterOutput'], + ], + 'createdAt' => '2023-09-21T02:02:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeEventRuleList'], + ], + 'createdAt' => '2023-09-19T07:38:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2023-09-04T08:23:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleAttribute'], + ], + 'createdAt' => '2023-08-31T02:53:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteExporterRule'], + ['description' => 'Response parameters changed', 'api' => 'DescribeExporterOutputList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeExporterRuleList'], + ['description' => 'Response parameters changed', 'api' => 'PutExporterRule'], + ], + 'createdAt' => '2023-08-30T08:15:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Request parameters changed', 'api' => 'DescribeSiteMonitorLog'], + ], + 'createdAt' => '2023-08-22T07:50:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSiteMonitor'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Request parameters changed', 'api' => 'ModifySiteMonitor'], + ], + 'createdAt' => '2023-08-04T03:00:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogCount'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogHistogram'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogList'], + ], + 'createdAt' => '2023-07-27T09:50:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'createdAt' => '2023-07-19T08:43:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMetricRuleBlackList'], + ], + 'createdAt' => '2023-07-11T01:55:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateSiteMonitor'], + ['description' => 'Error codes changed', 'api' => 'EnableSiteMonitors'], + ['description' => 'Error codes changed', 'api' => 'ModifySiteMonitor'], + ], + 'createdAt' => '2023-06-19T07:12:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2023-06-15T04:29:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMonitoringAgentHosts'], + ], + 'createdAt' => '2023-05-25T09:45:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorList'], + ], + 'createdAt' => '2023-05-22T07:54:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'createdAt' => '2023-05-04T09:07:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateMetricRuleBlackList'], + ], + 'createdAt' => '2023-04-23T03:10:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2023-04-06T11:21:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorLog'], + ], + 'createdAt' => '2023-04-03T11:31:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricList'], + ], + 'createdAt' => '2023-03-24T08:24:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleAttribute'], + ], + 'createdAt' => '2023-03-24T08:23:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateGroupMonitoringAgentProcess'], + ], + 'createdAt' => '2023-03-24T08:22:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDynamicTagGroup'], + ], + 'createdAt' => '2023-03-24T08:22:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricData'], + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricList'], + ], + 'createdAt' => '2023-01-10T11:07:35.000Z', + 'description' => 'metric-master查询类API新加坡region转新加坡服务', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteExporterRule'], + ['description' => 'Response parameters changed', 'api' => 'PutExporterRule'], + ], + 'createdAt' => '2023-01-10T10:47:11.000Z', + 'description' => 'metric-master海外请求转海外服务', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-12-27T11:48:08.000Z', + 'description' => '报警接口字段N私有', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateHybridMonitorNamespace'], + ['description' => 'Error codes changed', 'api' => 'CreateHybridMonitorTask'], + ['description' => 'Error codes changed', 'api' => 'CreateSiteMonitor'], + ['description' => 'Error codes changed', 'api' => 'DeleteSiteMonitors'], + ['description' => 'Error codes changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Error codes changed', 'api' => 'DescribeSiteMonitorQuota'], + ['description' => 'Error codes changed', 'api' => 'InstallMonitoringAgent'], + ['description' => 'Error codes changed', 'api' => 'PutMonitorGroupDynamicRule'], + ['description' => 'Error codes changed', 'api' => 'UninstallMonitoringAgent'], + ], + 'createdAt' => '2022-12-27T07:33:46.000Z', + 'description' => '更新默认错误码的返回信息', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-12-26T09:12:32.000Z', + 'description' => '报警规则及模板相关API，支持参数N，表示累计了次数后才报警。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ], + 'createdAt' => '2022-12-22T02:15:23.000Z', + 'description' => '查询报警模板API，增加Labels的查询返回。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMonitoringAgentHosts'], + ['description' => 'Request parameters changed', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'createdAt' => '2022-11-29T02:47:37.000Z', + 'description' => '增加SysOM探测任务api，并优化主机监控状态的api。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDynamicTagRuleList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeMonitorGroups'], + ], + 'createdAt' => '2022-11-14T08:16:27.000Z', + 'description' => '1、从资源组创建的动态分组，查询返回对应资源组的id。2、动态分组Tag规则，增加返回的TagKey。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAlertLogList'], + ], + 'createdAt' => '2022-09-29T06:59:38.000Z', + 'description' => '报警日志详情，增加了日志Id字段。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAlertingMetricRuleResources'], + ], + 'createdAt' => '2022-09-01T02:54:22.000Z', + 'description' => '正在报警展示原始的报警表达式。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteHybridMonitorTask'], + ], + 'createdAt' => '2022-08-09T02:57:45.000Z', + 'description' => '删除企业云监控导入任务的时候，TaskId改为非必填。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGroupMonitoringAgentProcess'], + ['description' => 'Request parameters changed', 'api' => 'CreateHostAvailability'], + ['description' => 'Request parameters changed', 'api' => 'ModifyGroupMonitoringAgentProcess'], + ['description' => 'Request parameters changed', 'api' => 'ModifyHostAvailability'], + ['description' => 'Error codes changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-08-05T04:06:23.000Z', + 'description' => '1、可用性监控、进程监控支持MNS、SLS、FC等触发规则。2、优化报警规则超配额的错误信息。', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateHybridMonitorSLSGroup'], + ], + 'createdAt' => '2022-08-04T08:56:16.000Z', + 'description' => '优化企业云监控创建日志分组的错误提示信息。', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ModifySiteMonitor'], + ], + 'createdAt' => '2022-08-03T06:49:25.000Z', + 'description' => '增加站点监控断言相关api参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-07-29T09:42:21.000Z', + 'description' => 'PutResourceMetricRule中Resources字段改为非必填，适应Prometheus报警。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'BatchCreateInstantSiteMonitor'], + ], + 'createdAt' => '2022-07-22T08:21:08.000Z', + 'description' => '优化一次性拨测api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'BatchCreateInstantSiteMonitor'], + ], + 'createdAt' => '2022-07-21T06:24:36.000Z', + 'description' => '增加一次性拨测api，老的拼写错误', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeHybridMonitorTaskList'], + ], + 'createdAt' => '2022-07-20T10:30:20.000Z', + 'description' => '优化企业云监控处理阿里云数据任务的管控API。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutGroupMetricRule'], + ], + 'createdAt' => '2022-07-20T09:53:51.000Z', + 'description' => '创建分组报警规则的时候Category改为非必填。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDynamicTagGroup'], + ], + 'createdAt' => '2022-07-13T10:10:24.000Z', + 'description' => '1、Tag创建应用分组，支持最多3个条件2、可用性监控错误信息，会直接透传。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyHybridMonitorTask'], + ], + 'createdAt' => '2022-07-11T06:45:29.000Z', + 'description' => '更新企业云监控任务，TaskName调整为非必填。', ], - 'DescribeSyntheticProbeList' => [ - 'summary' => 'Queries detection points.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchCreateIntantSiteMonitor'], + ['description' => 'Error codes changed', 'api' => 'CreateInstantSiteMonitor'], + ['description' => 'Error codes changed', 'api' => 'CreateSiteMonitor'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-06-22T09:31:05.000Z', + 'description' => '优化站点监控Api返回的错误信息。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeHybridMonitorSLSGroup'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-06-20T02:43:08.000Z', + 'description' => 'DescribeHybridMonitorSLSGroup查询返回的组名称，修改为string类型。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorList'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'createdAt' => '2022-06-17T07:35:16.000Z', + 'description' => '增加是否在任务失败后自动触发对目标IP地址的MTR网络诊断是否在任务失败后自动触发对目标IP的ping网络延时检测', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateHybridMonitorTask'], + ['description' => 'Response parameters changed', 'api' => 'DescribeHybridMonitorTaskList'], + ['description' => 'Error codes changed', 'api' => 'ModifyHybridMonitorNamespace'], ], - 'parameters' => [ - [ - 'name' => 'Isp', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'City', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Ipv4', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'Ipv6', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ViewAll', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'MbProbe', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'LmProbe', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'IdcProbe', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], + 'createdAt' => '2022-06-09T09:39:44.000Z', + 'description' => '查询企业云监控任务管控API错误码、返回值优化。', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeHybridMonitorDataList'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'IspCityList' => [ - 'description' => 'The queried detection points.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection point.'."\n", - 'type' => 'object', - 'properties' => [ - 'AreaCn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AreaEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Huabei', - ], - 'City' => [ - 'description' => '', - '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' => 'The IP addresses of the monitored nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address of the node.'."\n", - 'type' => 'string', - 'example' => '1.1.1.1', - ], - ], - 'Isp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '232', - ], - 'IspCn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'IspEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'China-Unicom', - ], - 'LmProbeCount' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IdcV6ProbeCount' => [ - 'description' => 'The number of IPv6 nodes in data centers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - ], + 'createdAt' => '2022-05-30T06:46:19.000Z', + 'description' => '当参数或返回信息过大的时候，调整错误返回码。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorList'], ], - '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.', - ], - ], + 'createdAt' => '2022-05-30T06:35:31.000Z', + 'description' => '增加返回参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorTask'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-05-23T04:52:13.000Z', + 'description' => '创建企业云监控采集任务，导入其他账号的数据，支持传入多个用户信息', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateGroupMetricRules'], ], - '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' => 'DescribeSyntheticProbeList', + 'createdAt' => '2022-05-19T10:19:48.000Z', + 'description' => '增加对STS的支持，优化错误码。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorTask'], + ['description' => 'Request parameters changed', 'api' => 'ModifyHybridMonitorTask'], + ], + 'createdAt' => '2022-05-06T03:54:52.000Z', + 'description' => '增加企业云监控采集任务管控Api。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-04-25T08:58:01.000Z', + 'description' => '报警规则支持PromQL。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorNamespace'], + ['description' => 'Request parameters changed', 'api' => 'DeleteHybridMonitorNamespace'], + ['description' => 'Request parameters changed', 'api' => 'DescribeHybridMonitorNamespaceList'], + ['description' => 'Request parameters changed', 'api' => 'ModifyHybridMonitorNamespace'], + ], + 'createdAt' => '2022-04-24T08:30:40.000Z', + 'description' => '增加企业云监控数据源相关API。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleTargetList'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRuleTargets'], + ], + 'createdAt' => '2022-04-22T10:15:21.000Z', + 'description' => '报警规则target增加消息服务的target', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMonitorGroups'], + ], + 'createdAt' => '2022-04-22T08:01:23.000Z', + 'description' => '1、支持查询ess分组2、创建企业云监控数据归集的时候，支持传入多个账号', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'PutMonitorGroupDynamicRule'], + ], + 'createdAt' => '2022-04-22T06:18:29.000Z', + 'description' => '在异步创建动态分组规则的时候，如果分组没有初始化结束，调整返回的错误信息。', ], - ], - 'endpoints' => [ [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutLogMonitor'], + ], + 'createdAt' => '2022-04-21T07:37:29.000Z', + 'description' => '调整filter数量', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'BatchCreateIntantSiteMonitor'], + ], + 'createdAt' => '2022-04-20T06:16:11.000Z', + 'description' => '增加新版本的创建一次性api', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGroupMetricRules'], + ['description' => 'Request parameters changed', 'api' => 'PutGroupMetricRule'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRules'], + ], + 'createdAt' => '2022-04-20T06:14:16.000Z', + 'description' => '报警规则增加Labels。', ], [ - 'regionId' => 'cn-zhengzhou-jva', - 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRules'], + ], + 'createdAt' => '2022-04-20T06:13:58.000Z', + 'description' => '修改label属性', ], [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'BatchCreateOnceSiteMonitor'], + ], + 'createdAt' => '2022-04-18T03:06:12.000Z', + 'description' => '增加一次性拨测api', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'PutLogMonitor'], + ], + 'createdAt' => '2022-04-11T03:35:36.000Z', + 'description' => '增加上报日志监控错误信息映射。', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutMonitorGroupDynamicRule'], + ], + 'createdAt' => '2022-04-01T03:59:02.000Z', + 'description' => '创建动态规则增加引导。', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-03-24T05:52:16.000Z', + 'description' => '增加了多指标监控', ], [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateHostAvailability'], + ['description' => 'Request parameters changed', 'api' => 'DescribeMetricRuleTemplateList'], + ], + 'createdAt' => '2022-03-22T08:55:37.000Z', + 'description' => '1、报警模板增加排序功能2、优化可用性监控的错误码，当达到限制的时候，会返回正确的错误信息。3、增加批量清理分组的api。', ], [ - 'regionId' => 'cn-fuzhou', - 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeEventRuleAttribute'], + ], + 'createdAt' => '2022-03-21T07:09:30.000Z', + 'description' => '增加个通道沉默', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleTargets'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRuleTargets'], + ['description' => 'Request parameters changed', 'api' => 'PutMetricRuleTargets'], + ], + 'createdAt' => '2022-03-21T06:46:38.000Z', + 'description' => '增加报警规则回调参数。', ], [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMetricRuleList'], + ['description' => 'Error codes changed', 'api' => 'PutResourceMetricRules'], + ], + 'createdAt' => '2022-03-21T06:00:07.000Z', + 'description' => '增加动态报警相关的api', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutMonitorGroupDynamicRule'], + ], + 'createdAt' => '2022-03-03T05:26:10.000Z', + 'description' => '增加检查数量', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2022-02-22T11:34:11.000Z', + 'description' => '站点检控详情里头增加isBase64Encode 字段', ], [ - 'regionId' => 'cn-wuhan-lr', - 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2022-02-21T06:46:00.000Z', + 'description' => '事件目标增加为20个', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2022-01-21T08:52:40.000Z', + 'description' => '增加事件报警功能的sql过滤', ], [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogList'], + ], + 'createdAt' => '2022-01-13T07:25:23.000Z', + 'description' => '报警历史查询支持RuleId参数。', ], [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeContactGroupList'], + ], + 'createdAt' => '2022-01-11T11:57:53.000Z', + 'description' => '增加查询不到联系人组的错误码映射。', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2022-01-11T11:33:01.000Z', + 'description' => '控制台支持资源组权限隔离', ], [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'PutHybridMonitorMetricData'], + ], + 'createdAt' => '2021-12-30T11:51:43.000Z', + 'description' => '调整上报企业云监控数据的API错误提示信息，防止误解。', ], [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'PutHybridMonitorMetricData'], + ], + 'createdAt' => '2021-12-24T03:58:17.000Z', + 'description' => '返回值中增加对格式参数错误指标的提示信息。', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2021-12-24T03:36:44.000Z', + 'description' => '修复sdk的问题', ], [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutHybridMonitorMetricData'], + ], + 'createdAt' => '2021-12-24T03:29:57.000Z', + 'description' => '调整labels的格式为repeatList。', ], [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2021-12-24T03:21:02.000Z', + 'description' => '修正生成不了sdk的问题', ], [ - 'regionId' => 'cn-zhongwei', - 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutHybridMonitorMetricData'], + ], + 'createdAt' => '2021-12-24T03:09:23.000Z', + 'description' => '调整labels的格式，从map改为List的Key-Value。', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleTargetList'], + ], + 'createdAt' => '2021-12-22T08:43:39.000Z', + 'description' => '查询targetapi增加新的方式', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutEventRuleTargets'], + ], + 'createdAt' => '2021-12-22T07:45:45.000Z', + 'description' => '增加一个target', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2021-12-09T10:17:44.000Z', + 'description' => '事件增加沉默周期', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstantSiteMonitor'], + ], + 'createdAt' => '2021-12-07T15:36:24.000Z', + 'description' => '修复一次性探测探测问题', ], [ - 'regionId' => 'na-south-1', - 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeSiteInstantMonitorLog'], + ], + 'createdAt' => '2021-12-01T09:57:33.000Z', + 'description' => '增加了一次性拨测探测日志查询功能。', ], [ - 'regionId' => 'us-southeast-1', - 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorList'], + ], + 'createdAt' => '2021-11-18T05:37:00.000Z', + 'description' => 'dns探测匹配类型， dns_match_rule, 原先和http共享了一个参数，类型不一样。', ], [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallMonitoringAgent'], + ], + 'createdAt' => '2021-11-18T05:36:49.000Z', + 'description' => 'agent安装支持对用户的全量agent进行操作', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDynamicTagGroup'], + ], + 'createdAt' => '2021-11-04T06:31:02.000Z', + 'description' => '创建tag组express参数为必须参数选项', ], [ - 'regionId' => 'me-central-1', - 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDynamicTagRuleList'], + ], + 'createdAt' => '2021-11-04T06:05:13.000Z', + 'description' => '查询动态tag组增加报警联系人的返回', ], [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSiteMonitor'], + ], + 'createdAt' => '2021-11-03T13:42:17.000Z', + 'description' => '修改一个不用的单位参数', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAlertLogList'], + ], + 'createdAt' => '2021-10-29T08:11:11.000Z', + 'description' => '移除了total字段，增加了sendresult', ], [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRules'], + ], + 'createdAt' => '2021-10-28T09:57:48.000Z', + 'description' => '增加多指标监控和无数据监控参数设置', ], [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGroupMetricRules'], + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutGroupMetricRule'], + ], + 'createdAt' => '2021-10-28T09:45:49.000Z', + 'description' => '增加多指标相关的参数和返回', ], [ - 'regionId' => 'cn-heyuan-acdr-1', - 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorISPCityList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorISPCityList'], + ], + 'createdAt' => '2021-10-28T09:21:47.000Z', + 'description' => '修复问题', ], [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateDynamicTagGroup'], + ['description' => 'Response parameters changed', 'api' => 'CreateMonitorGroupByResourceGroupId'], + ], + 'createdAt' => '2021-10-25T13:10:51.000Z', + 'description' => '创建分组，增加返回id', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorNamespaceList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorSLSGroup'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHostAvailability'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutContact'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomMetric'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentStatuses'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDynamicTagGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProjectMeta'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomMetricRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHostAvailability'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMonitorGroupInstances'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricMetaList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactGroup'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorNamespace'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUnhealthyHostAvailability'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRuleTargets'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorSLSGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricTop'], + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleTargetList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupDynamicRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventCount'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorAgentProcess'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveMetricRuleList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutEventRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorISPCityList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMetricRuleTemplate'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetricRuleBlackList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomMetric'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleAttribute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleBlackList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitoringAgentProcess'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleTemplate'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleBlackList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableEventRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorDataList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutContactGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventCount'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableMetricRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupNotifyPolicy'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupDynamicRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMetricRuleBlackList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleResources'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSyntheticProbeList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHostInfo'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitoringAgentProcess'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupMonitoringAgentProcess'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupMonitoringAgentProcess'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertingMetricRuleResources'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventAttribute'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorSLSGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventMetaList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTemplateList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupNotifyPolicyList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutResourceMetricRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomEventRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDynamicTagGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactListByContactGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogMonitorAttribute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleTargets'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorData'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSiteMonitors'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventHistogram'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutHybridMonitorMetricData'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorTaskList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleList'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutLogMonitor'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomMetricList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorNamespace'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomEvent'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstantSiteMonitor'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTagValueList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetricRules'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMetricRuleTargets'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Cursor'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricData'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHostAvailability'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTags'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateInstantSiteMonitor'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchExport'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventHistogram'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDynamicTagRuleList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactGroupList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogCount'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogHistogram'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorStatistics'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallMonitoringAgent'], + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroups'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventAttribute'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProductResourceTagKeyList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMonitorGroup'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutResourceMetricRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleBlackList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRules'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableActiveMetricRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentProcesses'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSiteMonitors'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutEventRuleTargets'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDryRunSystemEvent'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupMonitoringAgentProcess'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentHosts'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableEventRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogMonitorList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupMetricRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorAttribute'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSiteMonitors'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSiteMonitor'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHostAvailability'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutGroupMetricRule'], + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupCategories'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProductsOfActiveMetricRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableActiveMetricRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHostAvailabilityList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorSLSGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleCount'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMonitorGroupDynamicRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorResourceQuotaAttribute'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMonitoringConfig'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTargets'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogMonitor'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorLog'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleResources'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupByResourceGroupId'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySiteMonitor'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroup'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentAccessKey'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallMonitoringAgent'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorNamespace'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTagKeyList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyMetricRuleTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContact'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHostAvailability'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTags'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorQuota'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyGroupMonitoringAgentProcess'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupNotifyPolicy'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupInstanceAttribute'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricLast'], ], + 'product' => ['code' => 'cms', 'title' => 'Cms'], + ], + 'ram' => [ + 'productCode' => 'CloudMonitorService', + 'productName' => 'Cloud Monitor', + 'ramCodes' => ['cms', 'log', 'arms'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; diff --git a/data/en_us/cms/2024-03-30/api-docs.php b/data/en_us/cms/2024-03-30/api-docs.php index 58f41b1..8194fe6 100644 --- a/data/en_us/cms/2024-03-30/api-docs.php +++ b/data/en_us/cms/2024-03-30/api-docs.php @@ -1,2638 +1,1548 @@ '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'Cms', - 'version' => '2024-03-30', - ], + 'info' => ['style' => 'ROA', 'product' => 'Cms', 'version' => '2024-03-30'], 'directories' => [ [ - 'id' => 372127, - 'title' => null, + 'children' => ['ExecuteQuery'], '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', - ], + 'title' => 'Datasets', ], [ - 'id' => 372150, - 'title' => null, + 'children' => ['CreateContextStore', 'UpdateContextStore', 'ListContextStores', 'GetContextStore', 'DeleteContextStore', 'AddContexts', 'UpdateContext', 'SearchContext', 'GetContext', 'DeleteContexts', 'DeleteContext', 'CreateContextStoreAPIKey', 'ListContextStoreAPIKeys', 'DeleteContextStoreAPIKey'], 'type' => 'directory', - 'children' => [ - 'CreateChat', - 'CreateDigitalEmployee', - 'GetDigitalEmployee', - 'UpdateDigitalEmployee', - 'ListDigitalEmployees', - 'DeleteDigitalEmployee', - 'CreateThread', - 'GetThread', - 'GetThreadData', - 'ListThreads', - 'UpdateThread', - 'DeleteThread', - ], + 'title' => 'Context library', ], [ - 'id' => 372163, - 'title' => null, + 'children' => ['UpdateMemoryStore', 'UpdateMemory', 'ListMemoryStores', 'GetMemoryStore', 'GetMemoryHistory', 'GetMemory', 'GetMemories', 'DeleteMemoryStore', 'DeleteMemory', 'DeleteMemories', 'AddMemories', 'CreateMemoryStore'], 'type' => 'directory', - 'children' => [ - 'UpdateIntegrationPolicy', - 'DeleteIntegrationPolicy', - 'CreateIntegrationPolicy', - 'UpdateAddonRelease', - 'ListIntegrationPolicyStorageRequirements', - 'ListIntegrationPolicyPodMonitors', - 'ListIntegrationPolicyDashboards', - 'ListIntegrationPolicyCustomScrapeJobRules', - 'ListIntegrationPolicies', - 'ListAddonReleases', - 'GetIntegrationPolicy', - 'GetAddonRelease', - 'DeleteAddonRelease', - 'CreateAddonRelease', - ], + 'title' => 'Memory library', ], [ - 'id' => 372178, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'GetServiceObservability', - 'DeleteService', - 'UpdateService', - 'GetService', - 'CreateService', - 'ListServices', - 'ListServices', + 'PutWorkspace', 'GetWorkspace', 'ListWorkspaces', 'DeleteWorkspace', 'CreateCloudResource', 'GetCloudResource', 'GetCloudResourceData', 'DeleteCloudResource', 'CreateEntityStore', 'GetEntityStore', 'GetEntityStoreData', 'DeleteEntityStore', 'CreateUmodel', 'GetUmodel', 'UpdateUmodel', 'DeleteUmodel', 'GetUmodelData', 'UpsertUmodelData', 'DeleteUmodelData', 'GetUmodelCommonSchemaRef', + 'DeleteUmodelCommonSchemaRef', 'UpsertUmodelCommonSchemaRef', ], + 'type' => 'directory', + 'title' => 'Workspaces', ], [ - 'id' => 372185, - 'title' => null, + 'children' => ['GetAddon', 'GetAddonSchema', 'UpdateIntegrationPolicy', 'DeleteIntegrationPolicy', 'CreateIntegrationPolicy', 'UpdateAddonRelease', 'ListIntegrationPolicyStorageRequirements', 'ListIntegrationPolicyPodMonitors', 'ListIntegrationPolicyDashboards', 'ListIntegrationPolicyCustomScrapeJobRules', 'ListIntegrationPolicies', 'GetIntegrationPolicy', 'GetAddonRelease', 'CreateAddonRelease', 'ListIntegrationPolicyServiceMonitors', 'ListIntegrationPolicyCollectors', 'ListIntegrationPolicyAddons'], 'type' => 'directory', - 'children' => [ - 'CreatePrometheusVirtualInstance', - 'ListPrometheusVirtualInstances', - 'GetAggTaskGroup', - 'CreateAggTaskGroup', - 'DeleteAggTaskGroup', - 'UpdateAggTaskGroupStatus', - 'UpdateAggTaskGroup', - 'ListAggTaskGroups', - 'DeletePrometheusInstance', - 'DeletePrometheusView', - 'GetPrometheusInstance', - 'GetPrometheusView', - 'ListPrometheusDashboards', - 'UpdatePrometheusView', - 'UpdatePrometheusInstance', - 'ListPrometheusViews', - 'ListPrometheusInstances', - 'CreatePrometheusInstance', - 'CreatePrometheusView', - ], + 'title' => 'Data access', ], [ - 'id' => 372210, - 'title' => null, + 'children' => ['CreateServiceObservability', 'GetServiceObservability', 'DeleteService', 'UpdateService', 'GetService', 'CreateService', 'ListServices'], 'type' => 'directory', - 'children' => [ - 'ListAlertActions', - 'UpdateSubscription', - 'CreateAlertWebhook', - 'DeleteAlertWebhooks', - 'ListAlertWebhooks', - 'UpdateAlertWebhook', - 'UpdateNotifyStrategy', - ], + 'title' => 'Application monitoring/user experience monitoring', ], [ - 'id' => 372218, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'CreateTicket', + 'CreatePrometheusInstance', 'GetPrometheusInstance', 'ListPrometheusInstances', 'UpdatePrometheusInstance', 'DeletePrometheusInstance', 'DeleteDeliveryTask', 'UpdateDeliveryTask', 'ListDeliveryTasks', 'GetDeliveryTask', 'CreateDeliveryTask', 'CreatePrometheusVirtualInstance', 'ListPrometheusVirtualInstances', 'DeletePrometheusVirtualInstance', 'GetAggTaskGroup', 'CreateAggTaskGroup', 'DeleteAggTaskGroup', 'UpdateAggTaskGroupStatus', 'UpdateAggTaskGroup', 'ListAggTaskGroups', 'ListPrometheusDashboards', + 'DeletePrometheusView', 'GetPrometheusView', 'UpdatePrometheusView', 'ListPrometheusViews', 'CreatePrometheusView', ], + 'type' => 'directory', + 'title' => 'Prometheus', ], [ - 'id' => 372220, - 'title' => null, + 'children' => ['ListAlertActions', 'CreateAlertWebhook', 'DeleteAlertWebhooks', 'ListAlertWebhooks', 'UpdateAlertWebhook', 'UpdateNotifyStrategy'], 'type' => 'directory', - 'children' => [ - 'TagResources', - 'UntagResources', - 'ListTagResources', - 'ChangeResourceGroup', - ], + 'title' => 'Alerting', ], [ - 'id' => 372225, - 'title' => null, + 'children' => ['CreateTicket'], 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - ], + 'title' => 'Console embedding', ], [ - 'id' => 372227, - 'title' => null, + 'children' => ['GetCmsService'], 'type' => 'directory', - 'children' => [ - 'GetCmsService', - ], + 'title' => 'Service activation', ], [ - 'id' => 372229, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'CreateBizTrace', - 'CreateServiceObservability', - 'DeleteBizTrace', - 'GetAddon', - 'GetAddonCodeTemplate', - 'GetAddonSchema', - 'GetBizTrace', - 'GetIntegrationVersionForCS', - 'GetPrometheusUserSetting', - 'ListAddons', - 'ListBizTraces', - 'ListIntegrationPolicyAddons', - 'ListIntegrationPolicyCollectors', - 'ListIntegrationPolicyServiceMonitors', - 'UpdateBizTrace', - 'UpdatePrometheusUserSetting', + 'CreateBizTrace', 'DeleteBizTrace', 'GetAddonCodeTemplate', 'GetBizTrace', 'GetIntegrationVersionForCS', 'GetPrometheusUserSetting', 'ListAlertRobots', 'ListBizTraces', 'ListContactGroups', 'ListContacts', 'OpenCmsService', 'UpdateBizTrace', 'UpdatePrometheusUserSetting', 'ChangeResourceGroup', 'CreateDataset', 'CreatePipeline', 'DeleteAddonRelease', 'DeleteDataset', 'DeletePipeline', 'DescribeRegions', + 'GetDataset', 'GetPipeline', 'ListAddonReleases', 'ListAddons', 'ListDatasets', 'ListPipelines', 'ListTagResources', 'ManageAlertRules', 'QueryAlertRules', 'SearchMemories', 'TagResources', 'UntagResources', 'UpdateDataset', 'UpdatePipeline', 'UpdateSubscription', 'DescribeMetricMetaList', 'CreateServiceRecord', 'DeleteServiceRecord', 'GetServiceRecord', 'ListServiceRecords', + 'UpdateServiceRecord', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ - 'AddonMeta' => [ - 'description' => '', - 'visibility' => 'Public', + 'ActionIntegrationConfig' => [ + 'description' => 'Contains configuration for action integration.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - 'backendName' => 'name', - ], - 'version' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.0.1', - 'backendName' => 'version', - ], - 'language' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh', - 'backendName' => 'language', - ], - 'description' => [ - 'description' => '', - 'visibility' => 'Public', - '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.', - 'backendName' => 'description', - ], - 'scene' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'feature', - 'backendName' => 'scene', - ], - 'alias' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'enabled' => ['description' => 'Indicates whether action integration is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'actions' => [ + 'description' => 'A list of actions to perform.', + 'type' => 'array', + 'items' => ['description' => 'The name of the action to perform.', 'type' => 'string', 'title' => '', 'example' => ''], + 'title' => '', 'example' => '', - 'backendName' => 'alias', - ], - 'icon' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'assets/logos/ecs.svg', - 'backendName' => 'icon', ], + ], + 'title' => '', + 'example' => '', + ], + 'AddonMeta' => [ + 'description' => 'Information about the integration component.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the component.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'cloud-acs-ecs'], + 'version' => ['description' => 'The version number.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'version', 'title' => '', 'example' => '0.0.1'], + 'language' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'- zh: Chinese (default)'."\n" + ."\n" + .'- en: English', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'language', 'title' => '', 'example' => 'zh'], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', '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' => 'The scenario.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'scene', 'title' => '', 'example' => 'feature'], + 'alias' => ['description' => 'The alias of the component. This is the display name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'alias', 'title' => '', 'example' => 'ECS 监控'], + 'icon' => ['description' => 'The icon of the component.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'icon', 'title' => '', 'example' => 'assets/logos/ecs.svg'], 'keywords' => [ - 'description' => '', + 'description' => 'The list of keywords.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Monitor', - 'extendType' => 'true', - ], + 'items' => ['description' => 'A keyword.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'Monitor'], 'backendName' => 'keywords', + 'title' => '', + 'example' => '', ], - 'once' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'once', - ], + 'once' => ['description' => 'Indicates whether the component can be installed only once under a policy.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'once', 'title' => '', 'example' => 'true/false'], 'environments' => [ - 'description' => '', + 'description' => 'The list of supported environment types.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The description of the integration environment type.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'CS/ECS/Cloud/Client', - 'backendName' => 'name', - ], - 'enable' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'enable', - ], - 'label' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'label', - ], - 'description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'description', - ], + 'name' => ['description' => 'The name of the environment type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'CS/ECS/Cloud/Client'], + 'enable' => ['description' => 'Indicates whether the environment type is enabled.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enable', 'title' => '', 'example' => 'true/false'], + 'label' => ['description' => 'The display name of the environment type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'label', 'title' => '', 'example' => '容器环境'], + 'description' => ['description' => 'The description of the environment type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '支持容器集群的工作覆盖监控'], 'policies' => [ - 'description' => '', + 'description' => 'Information about the control policy group for the component.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'defaultInstall' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'defaultInstall', - ], - 'targetAddonName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - 'backendName' => 'targetAddonName', - ], - 'alertDefaultStatus' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', - 'backendName' => 'alertDefaultStatus', - ], + 'defaultInstall' => ['description' => 'Indicates whether the component is installed by default.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'defaultInstall', 'title' => '', 'example' => 'true/false'], + 'targetAddonName' => ['description' => 'The name of the target component for redirection.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'targetAddonName', 'title' => '', 'example' => 'cloud-acs-ecs'], + 'alertDefaultStatus' => ['description' => 'Indicates whether the alert rule is enabled by default after installation.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'alertDefaultStatus', 'title' => '', 'example' => 'RUNNING'], 'protocols' => [ - 'description' => '', + 'description' => 'The list of supported client protocols.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Information about the protocol.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Prometheus', - 'backendName' => 'name', - ], - 'label' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'label', - ], - 'description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'description', - ], - 'icon' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'assets/logos/ecs.svg'."\n", - 'backendName' => 'icon', - ], + 'name' => ['description' => 'The name of the protocol.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'Prometheus'], + 'label' => ['description' => 'The display name of the protocol.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'label', 'title' => '', 'example' => 'Prometheus 协议'], + 'description' => ['description' => 'The description of the protocol.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '使用 Prometheus 协议写入指标数据'], + 'icon' => ['description' => 'The display icon for the protocol.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'icon', 'title' => '', 'example' => 'assets/logos/ecs.svg'."\n"], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'protocols', + 'title' => '', + 'example' => '', ], 'metricCheckRule' => [ - 'description' => '', + 'description' => 'The data check rule after the component is integrated.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'promQL' => [ - 'description' => '', + 'description' => 'The Prometheus Query Language (PromQL) for the check rule.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'up{job="acs-ecs"}==1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The PromQL for the check rule.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'up{job="acs-ecs"}==1'], 'backendName' => 'promQL', + 'title' => '', + 'example' => '', ], ], 'backendName' => 'metricCheckRule', + 'title' => '', + 'example' => '', ], - 'needRestartAfterIntegration' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'needRestartAfterIntegration', - ], - 'enableServiceAccount' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'enableServiceAccount', - ], + 'needRestartAfterIntegration' => ['description' => 'Indicates whether to prompt for a workload restart after integration.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'needRestartAfterIntegration', 'title' => '', 'example' => 'true/false'], + 'enableServiceAccount' => ['description' => 'Indicates whether to enable internal authorization token allocation.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enableServiceAccount', 'title' => '', 'example' => 'true/false'], 'bindEntity' => [ - 'description' => '', + 'description' => 'Information about the attached target entity.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'entityGroupMode' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'entityGroupMode', - ], - 'singleEntityMode' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false'."\n", - 'backendName' => 'singleEntityMode', - ], - 'entityType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs.ecs.instance', - 'backendName' => 'entityType', - ], - 'vpcIdFieldKey' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpcId', - 'backendName' => 'vpcIdFieldKey', - ], + 'entityGroupMode' => ['description' => 'Indicates whether group mode is used.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'entityGroupMode', 'title' => '', 'example' => 'true/false'], + 'singleEntityMode' => ['description' => 'Indicates whether single-entity mode is used.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'singleEntityMode', 'title' => '', 'example' => 'true/false'."\n"], + 'entityType' => ['description' => 'The entity type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'entityType', 'title' => '', 'example' => 'acs.ecs.instance'], + 'vpcIdFieldKey' => ['description' => 'The field in the entity from which to fetch the VPC ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'vpcIdFieldKey', 'title' => '', 'example' => 'vpcId'], ], 'backendName' => 'bindEntity', + 'title' => '', + 'example' => '', ], - 'bindDefaultPolicy' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - 'backendName' => 'bindDefaultPolicy', - ], + 'bindDefaultPolicy' => ['description' => 'The default mode. This integration mode does not require attaching an entity.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'bindDefaultPolicy', 'title' => '', 'example' => 'true/false'], ], 'backendName' => 'policies', + 'title' => '', + 'example' => '', ], 'dependencies' => [ - 'description' => '', + 'description' => 'The dependency description.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'features' => [ - 'description' => '', + 'description' => 'The probe dependency description. This is the component name. In later versions, this field is replaced by the collectors field.', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true/false', - ], + 'additionalProperties' => ['description' => 'Indicates whether there is a dependency.', 'visibility' => 'Public', 'type' => 'boolean', 'title' => '', 'example' => 'true/false'], 'backendName' => 'features', + 'title' => '', + 'example' => '', ], 'services' => [ - 'description' => '', + 'description' => 'The list of dependent services.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cmee', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The code name of the service. The service check is performed by the frontend.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'cmee'], 'backendName' => 'services', + 'title' => '', + 'example' => '', ], 'clusterTypes' => [ - 'description' => '', + 'description' => 'The supported cluster types.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ManagedKubernetes/Default', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The name of the cluster type.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'ManagedKubernetes/Default'], 'backendName' => 'clusterTypes', + 'title' => '', + 'example' => '', ], ], 'backendName' => 'dependencies', + 'title' => '', + 'example' => '', ], - 'policyType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ECS', - 'backendName' => 'policyType', - ], + 'policyType' => ['description' => 'The policy type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'policyType', 'title' => '', 'example' => 'ECS'], 'commonSchemaRefs' => [ - 'description' => '', + 'description' => 'The list of attached CommonSchemas.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'group' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs-ecs', - 'backendName' => 'group', - ], - 'version' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.1.0', - 'backendName' => 'version', - ], + 'group' => ['description' => 'The group name of the CommonSchema.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'group', 'title' => '', 'example' => 'acs-ecs'], + 'version' => ['description' => 'The group version of the CommonSchema.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'version', 'title' => '', 'example' => '0.1.0'], ], 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], 'backendName' => 'commonSchemaRefs', + 'title' => '', + 'example' => '', ], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'environments', + 'title' => '', + 'example' => '', ], 'categories' => [ - 'description' => '', + 'description' => 'The categorization information of the component.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'infrastructure', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The category name.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'infrastructure'], 'backendName' => 'categories', + 'title' => '', + 'example' => '', ], 'dashboards' => [ - 'description' => '', + 'description' => 'A list of component diagrams.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A list of diagrams.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'name', - ], - 'url' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'assets/dashboards/ecs.png'."\n", - 'backendName' => 'url', - ], - 'description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'description', - ], + 'name' => ['description' => 'The name of the diagram.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'ECS 监控概览大盘'], + 'url' => ['description' => 'The URL of the diagram.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'url', 'title' => '', 'example' => 'assets/dashboards/ecs.png'."\n"], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '描述信息'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'dashboards', + 'title' => '', + 'example' => '', ], - 'weight' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - 'backendName' => 'weight', - ], - 'latestReleaseCreateTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-10-25 09:12:12', - 'backendName' => 'latestReleaseCreateTime', - ], + 'weight' => ['description' => 'The sorting weight of the component.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'weight', 'title' => '', 'example' => '1000'], + 'latestReleaseCreateTime' => ['description' => 'The last time the component was integrated.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'latestReleaseCreateTime', 'title' => '', 'example' => '2025-10-25 09:12:12'], ], + 'title' => '', + 'example' => '', ], 'AlertEventIntegrationPolicyForModify' => [ 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The entity.', 'type' => 'object', 'properties' => [ 'transformerSetting' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The transform settings.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TransformAction', - ], - 'backendName' => 'transformerSetting', - ], - 'description' => [ + 'items' => ['description' => 'A single transform configuration.', '$ref' => '#/components/schemas/TransformAction', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], 'title' => '', - 'description' => '', + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'integrationSetting' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"region":"cn-hangzhou"}', - 'backendName' => 'integrationSetting', - ], - 'type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ALERT_CUSTOM', - 'backendName' => 'type', - ], - 'alertEventIntegrationPolicyName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test integration', - 'backendName' => 'alertEventIntegrationPolicyName', + 'backendName' => 'transformerSetting', ], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'test', 'visibility' => 'Public', 'backendName' => 'description'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'filterSetting'], + 'integrationSetting' => ['title' => '订阅设置', 'description' => 'The subscription settings.', 'type' => 'string', 'example' => '{"region":"cn-hangzhou"}', 'visibility' => 'Public', 'backendName' => 'integrationSetting'], + 'type' => ['title' => '类型', 'description' => 'The type.', 'type' => 'string', 'example' => 'ALERT_CUSTOM', 'visibility' => 'Public', 'backendName' => 'type'], + 'alertEventIntegrationPolicyName' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => 'test integration', 'visibility' => 'Public', 'backendName' => 'alertEventIntegrationPolicyName'], ], + 'example' => '', + 'visibility' => 'Public', ], 'AlertEventIntegrationPolicyForView' => [ 'title' => 'A short description of struct', - 'description' => '', + 'description' => 'The entity for viewing.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'description' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'updateTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-12-16T02:00:23Z', - 'backendName' => 'updateTime', - ], - 'type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ALERT_CUSTOM', - 'backendName' => 'type', - ], - 'userId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123', - 'backendName' => 'userId', - ], - 'alertEventIntegrationPolicyId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'alertEventIntegrationPolicyId', - ], - 'token' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10-16818f1445e10a1d012922b285bfb334', - 'backendName' => 'token', - ], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'workspace-test'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'workspace test'], + 'filterSetting' => ['description' => 'The filter configuration.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'description' => 'The time when the policy was last updated.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'updateTime', 'example' => '2024-12-16T02:00:23Z'], + 'type' => ['title' => '类型', 'description' => 'The type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'example' => 'ALERT_CUSTOM'], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'example' => '123123'], + 'alertEventIntegrationPolicyId' => ['title' => 'UUID', 'description' => 'The universally unique identifier (UUID).', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'alertEventIntegrationPolicyId', 'example' => '123123123'], + 'token' => ['description' => 'The key for the integration\'s reporting endpoint.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'token', 'title' => '', 'example' => '10-16818f1445e10a1d012922b285bfb334'], 'transformerSetting' => [ - 'description' => '', + 'description' => 'The transformation settings.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TransformAction', - ], + 'items' => ['description' => 'A single transformation configuration.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction', 'title' => '', 'example' => ''], 'backendName' => 'transformerSetting', - ], - 'createTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', - ], - 'enable' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', - ], - 'integrationSetting' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"region":"cn-hangzhou"}', - 'backendName' => 'integrationSetting', - ], - 'alertEventIntegrationPolicyName' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, 'example' => '', - 'backendName' => 'alertEventIntegrationPolicyName', ], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the policy was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'createTime', 'example' => '2025-03-11T08:21:58Z'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enabled', 'example' => 'true'], + 'integrationSetting' => ['title' => '订阅设置', 'description' => 'The subscription settings.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'integrationSetting', 'example' => '{"region":"cn-hangzhou"}'], + 'alertEventIntegrationPolicyName' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'alertEventIntegrationPolicyName', 'example' => '集成名'], ], + 'example' => '', ], 'AlertRuleAction' => [ - 'description' => '', + 'description' => 'The action integration configuration for the alert rule.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'actions' => [ - 'description' => '', + 'description' => 'A list of action integration IDs.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myTestAction', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The action integration ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myTestAction'], 'backendName' => 'actions', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricFilterDef' => [ - 'description' => 'Alert Rule Alert Metric Filter Definition Object.', + 'description' => 'An object that defines the metric filter for an alert rule.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'opt' => [ - 'description' => 'Filter Condition Operator.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '=', - 'backendName' => 'opt', - ], - 'hidden' => [ - 'title' => '', - 'description' => 'Whether to hide. If hidden, it will not be displayed in the frontend UI, but its value can still be included when rendering the PromQL. A typical example is the "pid" filter condition in APM scenarios, which is generally not exposed through configurable UI elements but instead presented as a separate application search list in the frontend.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'hidden', - ], - 'displayNameCn' => [ - 'description' => 'Display Name (Chinese).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Application Status', - 'backendName' => 'displayNameCn', - ], - 'dim' => [ - 'description' => 'Dimension in APM metrics.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'status', - 'backendName' => 'dim', - ], - 'displayNameEn' => [ - 'description' => 'Display Name (English).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Application Status', - 'backendName' => 'displayNameEn', - ], - 'labelDisabled' => [ - 'title' => '', - 'description' => 'When true, the filter item will not appear in the label filter of the PromQL.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'labelDisabled', - ], - 'dimDisabled' => [ - 'title' => '', - 'description' => 'When true, the filter item will not appear in the GROUP BY clause of the PromQL.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'dimDisabled', - ], + 'opt' => ['description' => 'The operator for the filter condition.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'opt', 'title' => '', 'example' => '='], + 'hidden' => ['title' => '是否隐藏。 如果隐藏则在前端交互中不显示，但在渲染promQL时可将该过滤条件的值上传上来。 典型的例子是APM场景中的pid这个过滤条件，一般不会通过配置化的方式进行显示，而是前端显为独立的应用搜索列表。', 'description' => 'Specifies whether to hide the filter. If hidden, the filter does not appear in the frontend UI. However, its value can be uploaded when rendering a PromQL query. For example, in an Application Performance Management (APM) scenario, the pid filter is typically hidden from the configuration UI. The frontend displays it as a separate application search list.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'hidden', 'example' => 'true'], + 'displayNameCn' => ['description' => 'The display name in Chinese.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'displayNameCn', 'title' => '', 'example' => '应用状态'], + 'dim' => ['description' => 'The dimension in APM metrics.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dim', 'title' => '', 'example' => 'status'], + 'displayNameEn' => ['description' => 'The display name in English.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'displayNameEn', 'title' => '', 'example' => 'Application Status'], + 'labelDisabled' => ['title' => '为true时，过滤项不出现在promQL的label filter中', 'description' => 'If set to \\`true\\`, the filter item does not appear in the label filter of a PromQL query.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'labelDisabled', 'example' => 'true'], + 'dimDisabled' => ['title' => '为true是，过滤项不出现在promQL的group by中', 'description' => 'If set to \\`true\\`, the filter item does not appear in the \\`group by\\` clause of a PromQL query.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'dimDisabled', 'example' => 'true'], 'supportedOpts' => [ - 'description' => 'List of supported options.', + 'description' => 'A list of supported options.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => 'Supported options.', + 'description' => 'A supported option.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'displayNameCn' => [ - 'description' => 'Display Name (Chinese).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Online', - 'backendName' => 'displayNameCn', - ], - 'displayNameEn' => [ - 'description' => 'Display Name (English).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Online', - 'backendName' => 'displayNameEn', - ], - 'value' => [ - 'description' => 'Matching value.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'online', - 'backendName' => 'value', - ], + 'displayNameCn' => ['description' => 'The display name in Chinese.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'displayNameCn', 'title' => '', 'example' => '在线'], + 'displayNameEn' => ['description' => 'The display name in English.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'displayNameEn', 'title' => '', 'example' => 'Online'], + 'value' => ['description' => 'The matching value.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'title' => '', 'example' => 'online'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'supportedOpts', 'itemName' => 'opt', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricFilterDef_array' => [ - 'description' => '', + 'description' => 'An array of alert metric filter definition objects.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/AlertRuleAlertMetricFilterDef', - ], + 'items' => ['description' => 'An alert metric filter definition object.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricFilterDef', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricInput' => [ - 'description' => 'Predefined Metric Input Configuration.', + 'description' => 'The input configuration for a predefined metric.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'filterValues' => [ - 'title' => '', - 'description' => 'List of user-provided filter conditions. The supported parameters and filter conditions for the metric can be queried via ListAlertMetrics.', + 'title' => '用户输入的过滤条件列表。指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'description' => 'A list of filter conditions. Call the ListAlertMetrics operation to query the lists of parameters and filter conditions that the metric supports.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Filter Item Configuration.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/AlertRuleAlertMetricInputFilterValue', - ], + 'items' => ['description' => 'The configuration of a filter item.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricInputFilterValue', 'title' => '', 'example' => ''], 'backendName' => 'filterValues', + 'example' => '', ], 'paramValues' => [ - 'title' => '', - 'description' => 'List of input parameters. The metric\'s supported parameters and filter conditions can be queried via ListAlertMetrics.', + 'title' => '输入的参数列表。 指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'description' => 'A list of parameters. Call the ListAlertMetrics operation to query the lists of parameters and filter conditions that the metric supports.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Predefined Metric Parameter Configuration.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/AlertRuleAlertMetricInputParamValue', - ], + 'items' => ['description' => 'The parameter configuration for the predefined metric.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/AlertRuleAlertMetricInputParamValue', 'title' => '', 'example' => ''], 'backendName' => 'paramValues', + 'example' => '', ], - 'metricId' => [ - 'title' => '', - 'description' => 'Key of the predefined metric selected by the user.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'appstat.jvm.GcPsMarkSweepCount', - 'backendName' => 'metricKey', - ], - 'groupId' => [ - 'title' => '', - 'description' => 'Key of the metric group selected by the user.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'apm.jvm'."\n", - 'backendName' => 'groupKey', - ], + 'metricId' => ['title' => '用户所选预定义指标的key', 'description' => 'The key of the predefined metric.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'metricKey', 'example' => 'appstat.jvm.GcPsMarkSweepCount'], + 'groupId' => ['title' => '用户所选指标组的key', 'description' => 'The key of the metric group.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'groupKey', 'example' => 'apm.jvm'."\n"], ], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricInputFilterValue' => [ - 'description' => 'Filter Condition Configuration Object.', - 'visibility' => 'Public', + 'description' => 'The configuration object for the filter condition.', 'type' => 'object', 'properties' => [ - 'opt' => [ - 'title' => '', - 'description' => 'Filter Condition Operator.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ALL', - 'backendName' => 'opt', - ], - 'dim' => [ - 'title' => '', - 'description' => 'Dimension of the filter condition.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'rootIp', - 'backendName' => 'dim', - ], - 'value' => [ - 'description' => 'Filter Condition Value.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '127.0.0.1', - 'backendName' => 'value', - ], + 'opt' => ['title' => '过滤条件操作符', 'description' => 'The operator for the filter condition.', 'type' => 'string', 'required' => true, 'example' => 'ALL', 'visibility' => 'Public', 'backendName' => 'opt'], + 'dim' => ['title' => '过滤条件的维度', 'description' => 'The dimension of the filter condition.', 'type' => 'string', 'required' => true, 'example' => 'rootIp', 'visibility' => 'Public', 'backendName' => 'dim'], + 'value' => ['description' => 'The value of the filter condition.', 'type' => 'string', 'title' => '', 'example' => '127.0.0.1', 'visibility' => 'Public', 'backendName' => 'value'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'AlertRuleAlertMetricInputParamValue' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The parameter settings object for a predefined metric.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'paramName', - 'backendName' => 'name', - ], - 'value' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'paramValue', - 'backendName' => 'value', - ], + 'name' => ['description' => 'The name of the predefined metric parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'paramName', 'visibility' => 'Public', 'backendName' => 'name'], + 'value' => ['description' => 'The value of the predefined metric parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'paramValue', 'visibility' => 'Public', 'backendName' => 'value'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'AlertRuleAlertMetricParamDef' => [ - 'description' => '', + 'description' => 'Defines the alert metric parameters for an alert rule.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'placeholderEn' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Enter value', - 'backendName' => 'placeholderEn', - ], - 'placeholderCn' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'placeholderCn', - ], + 'placeholderEn' => ['title' => '仅对INPUT_PARAM有效。用于前端展示的英文展位符', 'description' => 'The English placeholder text displayed on the frontend. This parameter is valid only for INPUT\\_PARAM.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'placeholderEn', 'example' => 'Enter value'], + 'placeholderCn' => ['title' => '仅对INPUT_PARAM有效。用于前端展示的中文展位符', 'description' => 'The Chinese placeholder text displayed on the frontend. This parameter is valid only for INPUT\\_PARAM.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'placeholderCn', 'example' => '请输入值'], 'values' => [ - 'title' => '', - 'description' => '', + 'title' => '仅对SELECT_PARAM有效。 下拉列表的可选值列表。', + 'description' => 'The list of available options in the drop-down list. This parameter is valid only for SELECT\\_PARAM.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'An object that represents an option.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'labelCn' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'labelCn', - ], - 'labelEn' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Staging', - 'backendName' => 'labelEn', - ], - 'value' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'staging', - 'backendName' => 'value', - ], + 'labelCn' => ['title' => '选项的中文显示名称', 'description' => 'The Chinese display name of the option.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'labelCn', 'example' => '测试环境'], + 'labelEn' => ['title' => '选项的英文显示名称', 'description' => 'The English display name of the option.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'labelEn', 'example' => 'Staging'], + 'value' => ['description' => 'The value.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'title' => '', 'example' => 'staging'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'backendName' => 'values', 'itemName' => 'value', + 'example' => '', ], - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'env', - 'backendName' => 'name', - ], - 'minWidth' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'backendName' => 'minWidth', - ], - 'type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'TEXT_PARAM', - 'backendName' => 'type', - ], - 'value' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'staging', - 'backendName' => 'value', - ], - 'maxWidth' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'backendName' => 'maxWidth', - ], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => 'env'], + 'minWidth' => ['title' => '输入框的最小宽度，仅对SELECT_PARAM、INPUT_PARAM生效', 'description' => 'The minimum width of the input control. This parameter is valid only for SELECT\\_PARAM and INPUT\\_PARAM.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'minWidth', 'example' => '100'], + 'type' => ['title' => '● TEXT_PARAM: 只读文本参数，由后台定义，前端不显示用户输入控件'."\n" + .'● INPUT_PARAM：输入框参数'."\n" + .'● SELECT_PARAM：选择框参数', 'description' => '● TEXT\\_PARAM: A read-only text parameter defined by the backend. No user input control is displayed on the frontend.● INPUT\\_PARAM: An input box parameter.● SELECT\\_PARAM: A selection box parameter.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'example' => 'TEXT_PARAM'], + 'value' => ['description' => 'The value.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'title' => '', 'example' => 'staging'], + 'maxWidth' => ['title' => '输入框的最大宽度，仅对SELECT_PARAM、INPUT_PARAM生效', 'description' => 'The maximum width of the input control. This parameter is valid only for SELECT\\_PARAM and INPUT\\_PARAM.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'maxWidth', 'example' => '200'], ], + 'title' => '', + 'example' => '', ], 'AlertRuleAlertMetricParamDef_array' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'A list of parameter definition objects for alert rule metrics.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/AlertRuleAlertMetricParamDef', - ], + 'items' => ['description' => 'A parameter definition object for an alert rule metric.', '$ref' => '#/components/schemas/AlertRuleAlertMetricParamDef', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'AlertRuleCondition' => [ - 'description' => 'Alert rule condition configuration. The fields included in this configuration object depend on the condition type (the "type" field), and different condition types use different fields.', - 'visibility' => 'Public', + 'description' => 'The alert rule condition configuration. The fields included in this configuration object depend on the condition type (the type field). Different condition types use different fields.', 'type' => 'object', 'properties' => [ - 'alertCount' => [ + 'alertCount' => ['title' => '', 'description' => 'Applicable condition type: SLS_CONDITION.'."\n" + ."\n" + .'The number of times the condition must be met before an alert is triggered. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'pattern' => '', 'default' => '1', 'example' => '1'], + 'caseList' => [ 'title' => '', 'description' => 'Applicable condition type: SLS_CONDITION.'."\n" - .'Number of times the condition must be met before triggering an alert, default is 1.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'pattern' => '', - 'backendName' => 'alertCount', - 'sensitive' => false, - 'default' => '1', - ], - 'caseList' => [ - 'title' => '', - 'description' => 'Applicable condition type: SLS_CONDITION.'."\n" - .'SLS alert condition list.', - 'visibility' => 'Public', + ."\n" + .'The list of Simple Log Service alert conditions.', 'type' => 'array', 'items' => [ - 'description' => 'SLS alert condition object.', - 'visibility' => 'Public', + 'description' => 'The SLS alert condition object.', 'type' => 'object', 'properties' => [ - 'condition' => [ - 'title' => '', - 'description' => 'Matching expression, example: logLevel: error.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'logLevel: error', - 'backendName' => 'condition', - ], - 'countCondition' => [ - 'title' => '', - 'description' => 'Count matching expression, examples: range combination: count >= 3 && count <= 10; single range: count >= 3.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'count >= 3', - 'backendName' => 'countCondition', - ], - 'level' => [ - 'title' => '', - 'description' => 'Alert severity level after condition is met.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'backendName' => 'level', - ], + 'condition' => ['title' => '', 'description' => 'The match expression. Example: logLevel: error.', 'type' => 'string', 'example' => 'logLevel: error'], + 'countCondition' => ['title' => '', 'description' => 'The count match expression. Examples:'."\n" + .'Range combination: __count__ >= 3 && __count__ <= 10'."\n" + .'Single range: __count__ >= 3', 'type' => 'string', 'example' => 'count >= 3'], + 'level' => ['title' => '', 'description' => 'The alert level when the condition is met.', 'type' => 'string', 'example' => 'INFO'], 'type' => [ 'title' => '', - 'description' => 'Matching type: Has data / Has a specific number of data entries / Has matching data / Has a specific number of matching entries.'."\n" + 'description' => 'The match type: has data, has a specific number of data entries, has data match, or has a specific number of data matches.'."\n" ."\n" .'Valid values:'."\n" - ."\n" - .'- HasData: Has data.'."\n" - .'- HasDataCount: Has a specific number of data entries.'."\n" - .'- HasDataMatch: Has matching data.'."\n" - .'- HasDataMatchCount: Has a specific number of matching entries.', - 'visibility' => 'Public', + .'- HasData: has data'."\n" + .'- HasDataCount: has a specific number of data entries'."\n" + .'- HasDataMatch: has data match'."\n" + .'- HasDataMatchCount: has a specific number of data matches', 'type' => 'string', + 'enum' => ['HasData', 'HasDataCount', 'HasDataMatch', 'HasDataMatchCount'], 'example' => 'HasData', - 'backendName' => 'type', - 'enum' => [ - 'HasData', - 'HasDataCount', - 'HasDataMatch', - 'HasDataMatchCount', - ], ], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'caseList', - 'sensitive' => false, + 'example' => '', ], 'compareList' => [ 'title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" - .'APM alert comparison condition list.', - 'visibility' => 'Public', + ."\n" + .'The list of Application Performance Monitoring (APM) alert comparison conditions.', 'type' => 'array', 'items' => [ - 'description' => 'APM alert condition object.', - 'visibility' => 'Public', + 'description' => 'The APM alert condition object.', 'type' => 'object', 'properties' => [ 'aggregate' => [ 'title' => '', - 'description' => 'Time series post-aggregation functions:'."\n" + 'description' => 'The aggregate functions applied after time series aggregation.'."\n" + ."\n" .'- count'."\n" - .'- sum '."\n" - .'- avg'."\n" - .'- min'."\n" - .'- max'."\n" - .'- p90'."\n" - .'- p95'."\n" - .'- p99', - 'visibility' => 'Public', + .'- sum'."\n" + .'- avg'."\n" + .'- min'."\n" + .'- max'."\n" + .'- p90'."\n" + .'- p95'."\n" + .'- p99', + 'enumValueTitles' => ['p99' => 'p99', 'avg' => 'avg', 'min' => 'min', 'max' => 'max', 'p90' => 'p90', 'count' => 'count', 'sum' => 'sum', 'p95' => 'p95'], 'type' => 'string', - 'enumValueTitles' => [ - 'p99' => 'p99', - 'avg' => 'avg', - 'min' => 'min', - 'max' => 'max', - 'p90' => 'p90', - 'count' => 'count', - 'sum' => 'sum', - 'p95' => 'p95', - ], 'example' => 'count', - 'backendName' => 'aggregate', ], 'oper' => [ 'title' => '', - 'description' => 'Comparison operations to determine whether it is year-over-year (YoY) or month-over-month (MoM):'."\n" - .'- Greater than (GT),'."\n" - .'- Greater than or equal to (GTE),'."\n" - .'- Less than (LT),'."\n" - .'- Less than or equal to (LTE),'."\n" - .'- Equal to (EQ),'."\n" - .'- Not equal to (NE),'."\n" - .'- Year-over-year increase (YOY_UP),'."\n" - .'- Year-over-year decrease (YOY_DOWN).', - 'visibility' => 'Public', + 'description' => 'The comparison operator. Determines whether year-over-year or period-over-period comparison is used.'."\n" + ."\n" + .'- Greater than: GT'."\n" + .'- Greater than or equal to: GTE'."\n" + .'- Less than: LT'."\n" + .'- Less than or equal to: LTE'."\n" + .'- Equal to: EQ'."\n" + .'- Not equal to: NE'."\n" + .'- Year-over-year increase: YOY_UP'."\n" + .'- Year-over-year decrease: YOY_DOWN', + 'enumValueTitles' => ['YOY_DOWN' => 'YOY_DOWN', 'YOY_UP' => 'YOY_UP', 'NE' => 'NE', 'LT' => 'LT', 'GTE' => 'GTE', 'LTE' => 'LTE', 'EQ' => 'EQ', 'GT' => 'GT'], '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', - 'backendName' => 'oper', - ], - 'value' => [ - 'title' => '', - 'description' => 'Comparison threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - 'backendName' => 'value', ], + 'value' => ['title' => '', 'description' => 'The comparison threshold.', 'type' => 'number', 'format' => 'double', 'example' => '50'], 'valueLevelList' => [ 'title' => '', - 'description' => 'List of alert severity levels for different values.', - 'visibility' => 'Public', + 'description' => 'The list of alert levels for different values.', 'type' => 'array', 'items' => [ - 'description' => 'Alert severity levels for different values, used in multi-level severity scenarios.', - 'visibility' => 'Public', + 'description' => 'The alert level for a specific value. Used in multi-level scenarios.', 'type' => 'object', 'properties' => [ - 'level' => [ - 'title' => '', - 'description' => 'Severity level corresponding to the threshold.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'backendName' => 'level', - ], - 'value' => [ - 'title' => '', - 'description' => 'Comparison threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '120', - 'backendName' => 'value', - ], + 'level' => ['title' => '', 'description' => 'The level corresponding to the threshold.', 'type' => 'string', 'example' => 'INFO'], + 'value' => ['title' => '', 'description' => 'The comparison threshold.', 'type' => 'number', 'format' => 'double', 'example' => '120'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'valueLevelList', - ], - 'yoyTimeUnit' => [ - 'title' => '', - 'description' => 'Year-over-year time unit (only applicable when oper=YOY_UP/YOY_DOWN): minute, hour, day, week, month.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'month', - 'backendName' => 'yoyTimeUnit', - ], - 'yoyTimeValue' => [ - 'title' => '', - 'description' => 'Year-over-year time value, used in conjunction with yoyTimeUnit.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'yoyTimeValue', - ], - 'baseUnit' => [ - 'title' => '数据单位', - 'description' => 'Data unit.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '%', - 'backendName' => 'baseUnit', - ], - 'displayUnit' => [ - 'title' => '展示单位', - 'description' => 'Display unit.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '%', - 'backendName' => 'displayUnit', + 'example' => '', ], + 'yoyTimeUnit' => ['title' => '', 'description' => 'The time unit for year-over-year comparison. Valid only when oper is set to YOY_UP or YOY_DOWN.'."\n" + .'Valid values: minute, hour, day, week, month.', 'type' => 'string', 'example' => 'month'], + 'yoyTimeValue' => ['title' => '', 'description' => 'The value of the year-over-year time period. Used together with yoyTimeUnit.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'baseUnit' => ['title' => '', 'description' => 'The data unit.', 'type' => 'string', 'example' => '%'], + 'displayUnit' => ['title' => '', 'description' => 'The display unit.', 'type' => 'string', 'example' => '%'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'compareList', - ], - 'noDataAppendValue' => [ - 'title' => '', - 'description' => 'Applicable condition type: APM_CONDITION.'."\n" - .'Fallback value when no data is available.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - 'backendName' => 'noDataAppendValue', - ], - 'noDataAlertLevel' => [ - 'title' => '', - 'description' => 'Applicable condition type: APM_CONDITION.'."\n" - .'Alert severity level when no data is available; if not specified, no alert will be triggered for missing data.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'pattern' => '', - 'backendName' => 'noDataAlertLevel', - 'sensitive' => false, - 'default' => '', + 'example' => '', ], + 'noDataAppendValue' => ['title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" + ."\n" + .'The compensation value when no data is available.', 'type' => 'string', 'example' => '1'], + 'noDataAlertLevel' => ['title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" + ."\n" + .'The alert level when no data is available. If this parameter is not specified, no alert is triggered when no data is available.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'INFO'], 'type' => [ 'title' => '', - 'description' => 'Rule condition type, valid values:'."\n" - ."\n" - .'SLS_CONDITION (SLS alert condition),'."\n" - .'APM_CONDITION (APM alert condition),'."\n" - .'CMS_BASIC_CONDITION (Basic Cloud Monitoring alert condition).', - 'visibility' => 'Public', + 'description' => 'The rule condition type. Valid values:'."\n" + .'- SLS_CONDITION: Simple Log Service alert condition.'."\n" + .'- APM_CONDITION: APM alert condition.'."\n" + .'- CMS_BASIC_CONDITION: CloudMonitor Basic monitoring alert condition.', + 'enumValueTitles' => ['SLS_CONDITION' => 'SLS alert condition.', 'CMS_BASIC_CONDITION' => 'CloudMonitor alerts condition.', 'APM_CONDITION' => 'APM alert condition.'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'SLS_CONDITION' => '', - 'CMS_BASIC_CONDITION' => '', - 'APM_CONDITION' => '', - ], - 'example' => 'SLS_CONDITION', 'pattern' => '', - 'backendName' => 'type', - 'sensitive' => false, 'default' => 'SLS_CONDITION', - 'enum' => [ - 'SLS_CONDITION', - 'APM_CONDITION', - 'CMS_BASIC_CONDITION', - 'BASIC_CONDITION', - ], + 'enum' => ['SLS_CONDITION', 'APM_CONDITION', 'CMS_BASIC_CONDITION', 'PROMETHEUS_MULTI_CONDITION', 'BASIC_CONDITION', 'LOG_SET_CONDITION', 'UMODEL_METRICSET_MULTI_CONDITION'], + 'example' => 'SLS_CONDITION', ], 'relation' => [ 'title' => '', 'description' => 'Applicable condition type: APM_CONDITION.'."\n" - .'Logical relationship between multiple conditions. Valid values: and, or.', - 'visibility' => 'Public', + ."\n" + .'The logical relationship between multiple conditions. Valid values:'."\n" + .'- and'."\n" + .'- or', + 'enumValueTitles' => ['or' => 'OR.', 'and' => 'AND.'], 'type' => 'string', - 'enumValueTitles' => [ - 'or' => '', - 'and' => '', - ], 'example' => 'and', - 'backendName' => 'relation', - ], - 'escalationType' => [ - 'title' => '', - 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Valid values:'."\n" - .'- simple: Simple metric condition,'."\n" - .'- composite: Composite metric condition,'."\n" - .'- express: Expression condition.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'simple', - 'backendName' => 'escalationType', ], + 'escalationType' => ['title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- simple: simple metric condition.'."\n" + .'- composite: composite metric condition.'."\n" + .'- express: expression condition.', 'type' => 'string', 'example' => 'simple'], 'simpleEscalation' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Only valid when escalationType=simple; specifies the alert condition for a single metric.', - 'visibility' => 'Public', + ."\n" + .'This parameter takes effect only when escalationType is set to simple. The alert condition configured for a single metric.', 'type' => 'object', 'properties' => [ - 'metricName' => [ - 'title' => '', - 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Metric associated with the alert condition.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cpu_total', - 'backendName' => 'metricName', - ], - 'period' => [ - 'title' => '', - 'description' => 'Metric time window, in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - 'backendName' => 'period', - ], + 'metricName' => ['title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" + ."\n" + .'The metric associated with the alert condition.', 'type' => 'string', 'example' => 'cpu_total'], + 'period' => ['title' => '', 'description' => 'The time window of the metric. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], 'escalations' => [ 'title' => '', - 'description' => 'List of conditions; for an alert rule with multiple severity levels, each level corresponds to one condition object.', - 'visibility' => 'Public', + 'description' => 'The list of conditions. When an alert rule corresponds to multiple levels, each level has a condition object.', 'type' => 'array', 'items' => [ - 'description' => 'Alert condition object.', - 'visibility' => 'Public', + 'description' => 'The alert condition object.', 'type' => 'object', 'properties' => [ 'level' => [ 'title' => '', - 'description' => 'Alert severity level triggered when the condition is met (expression-based alerts support only one level): '."\n" - .'- CRITICAL '."\n" - .'- WARNING '."\n" + 'description' => 'The alert level triggered when the condition is met. Expression-based alerts support only one level.'."\n" + ."\n" + .'- CRITICAL'."\n" + .'- WARNING'."\n" .'- INFO', - 'visibility' => 'Public', + 'enumValueTitles' => ['INFO' => 'INFO', 'WARNING' => 'WARNING', 'CRITICAL' => 'CRITICAL'], 'type' => 'string', - 'enumValueTitles' => [ - 'INFO' => 'INFO', - 'WARNING' => 'WARNING', - 'CRITICAL' => 'CRITICAL', - ], 'example' => 'INFO', - 'backendName' => 'level', - ], - 'comparisonOperator' => [ - 'title' => '', - 'description' => 'Threshold comparison operator, valid values:'."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" - .'- GreaterThanThreshold: greater than.'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" - .'- LessThanThreshold: less than.'."\n" - .'- NotEqualToThreshold: not equal to.'."\n" - .'- EqualToThreshold: equal to.'."\n" - .'- GreaterThanYesterday: increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: increased compared to the previous period (MoM).'."\n" - .'- LessThanLastPeriod: decreased compared to the previous period (MoM).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - 'backendName' => 'comparisonOperator', - ], - 'statistics' => [ - 'title' => '', - 'description' => 'Statistical method; the value of this parameter is determined by the Statistics column corresponding to the specified cloud product\'s MetricName, for example: Maximum, Minimum, and Average.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Average', - 'backendName' => 'statistics', - ], - 'times' => [ - 'title' => '', - 'description' => 'Number of times the condition must be met to trigger an alert.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'times', - ], - 'threshold' => [ - 'title' => '', - 'description' => 'Alert threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - 'backendName' => 'threshold', ], + 'comparisonOperator' => ['title' => '', 'description' => 'The threshold comparison operator. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- EqualToThreshold: Equal to.'."\n" + .'- GreaterThanYesterday: Year-over-year increase compared with the same time yesterday.'."\n" + .'- LessThanYesterday: Year-over-year decrease compared with the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Year-over-year increase compared with the same time last week.'."\n" + .'- LessThanLastWeek: Year-over-year decrease compared with the same time last week.'."\n" + .'- GreaterThanLastPeriod: Period-over-period increase compared with the previous period.'."\n" + .'- LessThanLastPeriod: Period-over-period decrease compared with the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold'], + 'statistics' => ['title' => '', 'description' => 'The statistical method. The value of this parameter is determined by the Statistics column corresponding to the MetricName of the specified cloud service. Examples: Maximum, Minimum, and Average.', 'type' => 'string', 'example' => 'Average'], + 'times' => ['title' => '', 'description' => 'The number of times the condition must be met to trigger an alert.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'threshold' => ['title' => '', 'description' => 'The alert threshold.', 'type' => 'number', 'format' => 'double', 'example' => '100'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'escalations', + 'example' => '', ], ], - 'backendName' => 'simpleEscalation', + 'example' => '', ], 'compositeEscalation' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Valid only when escalationType=composite; composite metric alert condition.', - 'visibility' => 'Public', + ."\n" + .'This parameter takes effect only when escalationType is set to composite. The composite metric alert condition.', 'type' => 'object', 'properties' => [ 'relation' => [ 'title' => '', - 'description' => 'Relationship between multiple metric conditions; valid values are "and" or "or".', - 'visibility' => 'Public', + 'description' => 'The relationship between multiple metric conditions. Valid values: and, or.', + 'enumValueTitles' => ['or' => 'or', 'and' => 'and'], 'type' => 'string', - 'enumValueTitles' => [ - 'or' => 'or', - 'and' => 'and', - ], 'example' => 'and', - 'backendName' => 'relation', - ], - 'level' => [ - 'title' => '', - 'description' => 'Alert severity level triggered when the condition is met (multi-metric composite alerts support only one level).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'backendName' => 'level', - ], - 'times' => [ - 'title' => '', - 'description' => 'Number of times the condition must be met to trigger an alert.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'times', ], + 'level' => ['title' => '', 'description' => 'The alert level triggered when the condition is met. Composite metric alerts support only one level.', 'type' => 'string', 'example' => 'INFO'], + 'times' => ['title' => '', 'description' => 'The number of times the condition must be met to trigger an alert.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'escalations' => [ 'title' => '', - 'description' => 'List of multi-metric composite conditions.', - 'visibility' => 'Public', + 'description' => 'The list of composite conditions for multiple metrics.', 'type' => 'array', 'items' => [ - 'description' => 'Condition object.', - 'visibility' => 'Public', + 'description' => 'The condition object.', 'type' => 'object', 'properties' => [ - 'comparisonOperator' => [ - 'title' => '', - 'description' => 'Threshold comparison operator, valid values:'."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" - .'- GreaterThanThreshold: greater than.'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" - .'- LessThanThreshold: less than.'."\n" - .'- NotEqualToThreshold: not equal to.'."\n" - .'- EqualToThreshold: equal to.'."\n" - .'- GreaterThanYesterday: increased compared to the same time yesterday.'."\n" - .'- LessThanYesterday: decreased compared to the same time yesterday.'."\n" - .'- GreaterThanLastWeek: increased compared to the same time last week.'."\n" - .'- LessThanLastWeek: decreased compared to the same time last week.'."\n" - .'- GreaterThanLastPeriod: increased compared to the previous period (MoM).'."\n" - .'- LessThanLastPeriod: decreased compared to the previous period (MoM).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - 'backendName' => 'comparisonOperator', - ], - 'metricName' => [ - 'title' => '', - 'description' => 'Metric name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cpu_total', - 'backendName' => 'metricName', - ], - 'period' => [ - 'title' => '', - 'description' => 'Metric time window.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - 'backendName' => 'period', - ], - 'statistics' => [ - 'title' => '', - 'description' => 'Statistical method; the value of this parameter is determined by the Statistics column corresponding to the specified cloud product\'s MetricName. This represents the statistical method for the monitoring metric. Example values:'."\n" - .'- $Maximum: maximum value.'."\n" - .'- $Minimum: minimum value.'."\n" - .'- $Average: average value.'."\n" - .'- $Availability: availability (typically used for site monitoring).'."\n" - .'Note: "$" is a unified prefix symbol for monitoring metrics.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '$Maximum', - 'backendName' => 'statistics', - ], - 'threshold' => [ - 'title' => '', - 'description' => 'Alert threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - 'backendName' => 'threshold', - ], + 'comparisonOperator' => ['title' => '', 'description' => 'The threshold comparison operator. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: Greater than or equal to.'."\n" + .'- GreaterThanThreshold: Greater than.'."\n" + .'- LessThanOrEqualToThreshold: Less than or equal to.'."\n" + .'- LessThanThreshold: Less than.'."\n" + .'- NotEqualToThreshold: Not equal to.'."\n" + .'- EqualToThreshold: Equal to.'."\n" + .'- GreaterThanYesterday: Year-over-year increase compared with the same time yesterday.'."\n" + .'- LessThanYesterday: Year-over-year decrease compared with the same time yesterday.'."\n" + .'- GreaterThanLastWeek: Year-over-year increase compared with the same time last week.'."\n" + .'- LessThanLastWeek: Year-over-year decrease compared with the same time last week.'."\n" + .'- GreaterThanLastPeriod: Period-over-period increase compared with the previous period.'."\n" + .'- LessThanLastPeriod: Period-over-period decrease compared with the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold'], + 'metricName' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total'], + 'period' => ['title' => '', 'description' => 'The time window of the metric.', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'statistics' => ['title' => '', 'description' => 'The statistical method. The value of this parameter is determined by the Statistics column corresponding to the MetricName of the specified cloud service. Example values for the statistical method of a metric:'."\n" + ."\n" + .'- $Maximum: Maximum value.'."\n" + .'- $Minimum: Minimum value.'."\n" + .'- $Average: Average value.'."\n" + .'- $Availability: Availability rate (typically used for site monitoring).'."\n" + ."\n" + .'Note: $ is the unified prefix symbol for metrics.', 'type' => 'string', 'example' => '$Maximum'], + 'threshold' => ['title' => '', 'description' => 'The alert threshold.', 'type' => 'number', 'format' => 'double', 'example' => '50'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'escalations', + 'example' => '', ], ], - 'backendName' => 'compositeEscalation', + 'example' => '', ], 'expressEscalation' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Valid only when escalationType=composite; multi-metric composite alert condition.', - 'visibility' => 'Public', + ."\n" + .'This parameter takes effect only when escalationType is set to composite. The multi-metric composite alert condition.', 'type' => 'object', 'properties' => [ - 'level' => [ - 'title' => '', - 'description' => 'Alert severity level triggered when the condition is met (expression-based alerts support only one level): '."\n" - ."\n" - .'- CRITICAL '."\n" - .'- WARNING '."\n" - .'- INFO', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'backendName' => 'level', - ], - 'times' => [ - 'description' => 'Number of times the condition must be met to trigger an alert.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'times', - ], - 'rawExpression' => [ - 'title' => '', - 'description' => 'Alert condition expression.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '@cpu_total[60].$Average > 60', - 'backendName' => 'rawExpression', - ], + 'level' => ['title' => '', 'description' => 'The alert level triggered when the condition is met. Expression-based alerts support only one level.'."\n" + ."\n" + .'- CRITICAL'."\n" + .'- WARNING'."\n" + .'- INFO', 'type' => 'string', 'example' => 'INFO'], + 'times' => ['description' => 'The number of times the condition must be met to trigger an alert.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'rawExpression' => ['title' => '', 'description' => 'The alert condition expression.', 'type' => 'string', 'example' => '@cpu_total[60].$Average > 60'], ], - 'backendName' => 'expressEscalation', + 'example' => '', ], 'noDataPolicy' => [ 'title' => '', 'description' => 'Applicable condition type: CMS_BASIC_CONDITION.'."\n" - .'Handling method when no monitoring data is available. Valid values:'."\n" + ."\n" + .'The method used to handle alerts when no monitoring data is available. Valid values:'."\n" ."\n" .'- KEEP_LAST_STATE (default): No action is taken.'."\n" - .'- INSUFFICIENT_DATA: Alert with "insufficient data" message.'."\n" - .'- OK: Treat as normal.', - 'visibility' => 'Public', + .'- INSUFFICIENT_DATA: The alert content indicates that no data is available.'."\n" + .'- OK: Normal.', + 'enumValueTitles' => ['KEEP_LAST_STATE' => 'No action is taken.', 'INSUFFICIENT_DATA' => 'The alert content indicates no data.', 'OK' => 'Treated as normal.'], 'type' => 'string', - 'enumValueTitles' => [ - 'KEEP_LAST_STATE' => '', - 'INSUFFICIENT_DATA' => '', - 'OK' => '', - ], 'example' => 'KEEP_LAST_STATE', - 'backendName' => 'noDataPolicy', ], - 'oper' => [ - 'description' => 'Comparison operations to determine whether it is year-over-year (YoY) or month-over-month (MoM):'."\n" - ."\n" - .'- Greater than (GT),'."\n" - .'- Greater than or equal to (GTE),'."\n" - .'- Less than (LT),'."\n" - .'- Less than or equal to (LTE),'."\n" - .'- Equal to (EQ),'."\n" - .'- Not equal to (NE),'."\n" - .'- Year-over-year increase (YOY_UP),'."\n" - .'- Year-over-year decrease (YOY_DOWN).', - 'visibility' => 'Public', + 'oper' => ['title' => '', 'description' => 'The comparison operator. Specifies whether to use year-over-year or period-over-period comparison. Valid values:'."\n" + ."\n" + .'- GT: greater than.'."\n" + .'- GTE: greater than or equal to.'."\n" + .'- LT: less than.'."\n" + .'- LTE: less than or equal to.'."\n" + .'- EQ: equal to.'."\n" + .'- NE: not equal to.'."\n" + .'- YOY_UP: year-over-year increase.'."\n" + .'- YOY_DOWN: year-over-year decrease.', 'type' => 'string', 'example' => 'LT'], + 'value' => ['title' => '', 'description' => 'The threshold that triggers the alert.', 'type' => 'number', 'format' => 'double', 'example' => '60'], + 'min' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'max' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'matchField' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'matchOperator' => [ + 'title' => '', 'type' => 'string', - 'example' => 'LT', - 'backendName' => 'oper', + 'description' => '', + 'example' => '', + 'enum' => ['PRESENT', 'NOT_PRESENT', 'CONTAINS', 'EQUALS', 'REGEX'], ], - 'value' => [ - 'description' => 'Alert triggering threshold.', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '60', - 'backendName' => 'value', + 'matchValue' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'countOperator' => [ + 'title' => '', + 'type' => 'string', + 'description' => '', + 'example' => '', + 'enum' => ['GTE', 'GT', 'EQ', 'LTE', 'LT'], + ], + 'countThreshold' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'thresholdList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'severity' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'threshold' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'min' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'max' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'triggers' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'severity' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'durationSecs' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'expression' => [ + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'logicOperator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'conditions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'expressionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'queryName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'threshold' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'double'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', ], + 'enableSeveritySuppression' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'AlertRuleDataSource' => [ - 'description' => 'Alert rule data source configuration. The fields included in this configuration object depend on the data source type (the "type" field), and different data source types support different fields.', - 'visibility' => 'Public', + 'description' => 'The data source configuration for the alert rule. The fields in this object depend on the data source type specified in the type field. Different data source types use different fields.', 'type' => 'object', 'properties' => [ 'dsList' => [ - 'title' => '', - 'description' => 'Applicable data source type: SLS_MULTI_DS.'."\n" - .'List of sub-data sources.', - 'visibility' => 'Public', + 'title' => 'type=SLS_MULTI_DS时才需要指定，子数据源列表', + 'description' => 'Applies to the SLS\\_MULTI\\_DS data source type.'."\n" + ."\n" + .'A list of sub-data sources.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'project' => [ - 'title' => 'sls project', - 'description' => 'SLS project', - 'visibility' => 'Public', + 'project' => ['title' => 'sls project', 'description' => 'The SLS project.', 'type' => 'string', 'example' => 'mySlsProject'], + 'regionId' => ['title' => 'sls project所在的region', 'description' => 'The region where the SLS project is located.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'store' => ['title' => 'log/metric store名称', 'description' => 'The name of the LogStore or MetricStore.', 'type' => 'string', 'example' => 'mySlsLogStore'], + 'type' => [ + 'title' => 'sls数据子源的类型：'."\n" + .'SLS_LOG_DS: log store数据源'."\n" + .'SLS_METRIC_DS： metric store数据源', + 'description' => 'The type of the SLS sub-data source. Valid values:'."\n" + ."\n" + .'- SLS\\_LOG\\_DS: A LogStore data source.'."\n" + ."\n" + .'- SLS\\_METRIC\\_DS: A MetricStore data source.', 'type' => 'string', - 'example' => 'mySlsProject', - 'backendName' => 'project', - ], - 'regionId' => [ - 'title' => '', - 'description' => 'The region where the SLS project is located.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', - ], - 'store' => [ - 'title' => '', - 'description' => 'LogStore/MetricStore name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mySlsLogStore', - 'backendName' => 'store', - ], - 'type' => [ - 'title' => '', - 'description' => 'Type of SLS data sub-source:'."\n" - ."\n" - .'- SLS_LOG_DS: LogStore data source.'."\n" - .'- SLS_METRIC_DS: MetricStore data source.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SLS_LOG_DS', - 'backendName' => 'type', - 'default' => 'SLS_LOG_DS', - 'enum' => [ - 'SLS_LOG_DS', - 'SLS_METRIC_DS', - ], + 'default' => 'SLS_LOG_DS', + 'enum' => ['SLS_LOG_DS', 'SLS_METRIC_DS'], + 'example' => 'SLS_LOG_DS', ], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'dsList', - 'sensitive' => false, - ], - 'instanceId' => [ - 'title' => '', - 'description' => 'Applicable data source type: PROMETHEUS_DS.'."\n" - .'Prometheus instance ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rw-bbe8961b4a59be0', - 'pattern' => '', - 'backendName' => 'instanceId', - 'sensitive' => false, - 'default' => '', - ], - 'namespace' => [ - 'title' => '', - 'description' => 'Applicable data source type: ENTERPRISE_DS.'."\n" - .'Name of the enterprise cloud monitoring metric repository.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'aliyun-default', - 'backendName' => 'namespace', + 'example' => '', ], + 'instanceId' => ['title' => 'type=PROMETHUES_DS时需指定prometheus实例id', 'description' => 'Applies to the PROMETHEUS\\_DS data source type.'."\n" + ."\n" + .'The ID of the Prometheus instance.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'rw-bbe8961b4a59be0'], + 'namespace' => ['title' => 'type=ENTERPRISE_DS时需指定，企业云监控指标仓库的名称', 'description' => 'Applies to the ENTERPRISE\\_DS data source type.'."\n" + ."\n" + .'The name of the Hybrid Cloud Monitoring metric repository.', 'type' => 'string', 'example' => 'aliyun-default'], 'type' => [ - 'title' => '', - 'description' => 'Data source type.'."\n" + 'title' => '数据源类型:'."\n" + .'ENTERPRISE_DS： 企业云监控数据源'."\n" + .'PROMETHEUS_DS：Prometheus数据源(ARMS)'."\n" + .'SLS_MULTI_DS：sls数据源'."\n" + .'APM_DS: APM数据源'."\n" + .'CMS_BASIC_DS: 基础云监控数据源', + 'description' => 'The data source type.'."\n" + ."\n" .'Valid values:'."\n" - .'- PROMETHEUS_DS: Prometheus data source.'."\n" - .'- SLS_MULTI_DS: SLS data source.'."\n" - .'- APM_DS: Application monitoring data source.'."\n" - .'- CMS_BASIC_DS: Basic cloud monitoring data source.'."\n" - .'- ENTERPRISE_DS: Enterprise cloud monitoring data source.', - 'visibility' => 'Public', + ."\n" + .'- PROMETHEUS\\_DS: A Prometheus data source.'."\n" + ."\n" + .'- SLS\\_MULTI\\_DS: An SLS data source.'."\n" + ."\n" + .'- APM\\_DS: An Application Monitoring data source.'."\n" + ."\n" + .'- CMS\\_BASIC\\_DS: A basic Cloud Monitor data source.'."\n" + ."\n" + .'- ENTERPRISE\\_DS: A Hybrid Cloud Monitoring data source.', + 'enumValueTitles' => ['CMS_BASIC_DS' => '基础云监控数据源', 'APM_DS' => '应用监控数据源', 'ENTERPRISE_DS' => '企业云监控数据源', 'SLS_MULTI_DS' => 'SLS数据源', 'PROMETHEUS_DS' => 'Prometheus数据源'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'CMS_BASIC_DS' => '', - 'APM_DS' => '', - 'ENTERPRISE_DS' => '', - 'SLS_MULTI_DS' => '', - 'PROMETHEUS_DS' => '', - ], - 'example' => 'PROMETHEUS_DS', 'pattern' => '', - 'backendName' => 'type', - 'sensitive' => false, 'default' => '', - 'enum' => [ - 'ENTERPRISE_DS', - 'PROMETHEUS_DS', - 'SLS_MULTI_DS', - 'APM_DS', - 'CMS_BASIC_DS', - 'ENTITY_DS', - ], - ], - 'regionId' => [ - 'title' => '', - 'description' => 'Applicable data source types: APM_DS, PROMETHEUS_DS.'."\n" - .'The regionId to which the data source belongs.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', + 'enum' => ['ENTERPRISE_DS', 'PROMETHEUS_DS', 'SLS_MULTI_DS', 'APM_DS', 'CMS_BASIC_DS', 'ENTITY_DS'], + 'example' => 'PROMETHEUS_DS', ], + 'regionId' => ['title' => '数据源所属的regionId。'."\n" + .'对APM_DS，指应用所属的地域'."\n" + .'对于PROMETHEUS_DS，指prometheus实例所属地域。'."\n" + .'如果未指定，则通过规则的regionId访问数据源。', 'description' => 'Applies to the APM\\_DS and PROMETHEUS\\_DS data source types.'."\n" + ."\n" + .'The ID of the region where the data source is located.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'appType' => [ - 'title' => '', - 'description' => 'Applicable data source type: APM_DS.'."\n" - .'Application type: '."\n" + 'title' => '仅对APM_DS有效，应用的类型：'."\n" + .'* apm'."\n" + .'* rum'."\n" + .'* ebpf'."\n" + .'* xtrace', + 'description' => 'Applies to the APM\\_DS data source type.'."\n" ."\n" - .'- apm.', - 'visibility' => 'Public', + .'The type of the application. Valid value:'."\n" + ."\n" + .'- apm', + 'enumValueTitles' => ['apm' => 'APM应用'], 'type' => 'string', - 'enumValueTitles' => [ - 'apm' => '', - ], 'example' => 'apm', - 'backendName' => 'appType', ], + 'tenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'AlertRuleLabelFilter' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The label filter configuration.', 'type' => 'object', 'properties' => [ 'opt' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The relationship operator between multiple labels.', 'type' => 'string', 'required' => false, + 'default' => 'AND', + 'enum' => ['AND', 'OR'], + 'title' => '', 'example' => 'AND', + 'visibility' => 'Public', 'backendName' => 'opt', - 'default' => 'AND', - 'enum' => [ - 'AND', - 'OR', - ], ], 'labels' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The label filter.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], + 'additionalProperties' => ['description' => 'The value of the label.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai', 'visibility' => 'Public'], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'labels', ], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'AlertRuleNotification' => [ - 'description' => 'Alert Notification Configuration Object.', - 'visibility' => 'Public', + 'description' => 'The alert notification configuration object.', 'type' => 'object', 'properties' => [ - 'slackWebhooks' => [ - 'description' => 'List of Slack webhook notification object IDs.', - 'visibility' => 'Public', + 'contacts' => [ + 'description' => 'A list of contact IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Slack webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mySlackWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'slackWebhooks', + 'items' => ['description' => 'A contact ID.', 'type' => 'string', 'title' => '', 'example' => 'myContactId'], + 'title' => '', + 'example' => '', ], - 'wxWebhooks' => [ - 'description' => 'List of WeChat webhook notification object IDs.', - 'visibility' => 'Public', + 'customWebhooks' => [ + 'description' => 'A list of custom webhook notification object IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'WeChat webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWxWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'wxWebhooks', - ], - 'notifyTime' => [ + 'items' => ['description' => 'A custom webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'myCustomWebhookId'], 'title' => '', - 'description' => 'Notification time window; notifications are sent only during this period.', - 'visibility' => 'Public', - 'backendName' => 'notifyTime', - '$ref' => '#/components/schemas/AlertRuleTimeSpan', + 'example' => '', ], 'dingWebhooks' => [ - 'description' => 'List of DingTalk webhook notification object IDs.', - 'visibility' => 'Public', + 'description' => 'A list of DingTalk webhook notification object IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'DingTalk webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myDingWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'dingWebhooks', + 'items' => ['description' => 'A DingTalk webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'myDingWebhookId'], + 'title' => '', + 'example' => '', ], - 'customWebhooks' => [ - 'description' => 'List of custom webhook notification object IDs.', - 'visibility' => 'Public', + 'fsWebhooks' => [ + 'description' => 'A list of Lark webhook notification object IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Custom webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myCustomWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'customWebhooks', + 'items' => ['description' => 'A Lark webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'myFsWebhookId'], + 'title' => '', + 'example' => '', ], 'groups' => [ - 'description' => 'List of contact group IDs.', - 'visibility' => 'Public', + 'description' => 'A list of contact group IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Contact group ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myContactGroupId', - 'extendType' => 'true', - ], - 'backendName' => 'groups', - ], - 'silenceTime' => [ - 'description' => 'Notification silence duration, in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400', - 'backendName' => 'silenceTime', + 'items' => ['description' => 'A contact group ID.', 'type' => 'string', 'title' => '', 'example' => 'myContactGroupId'], + 'title' => '', + 'example' => '', ], - 'fsWebhooks' => [ - 'description' => 'List of Feishu webhook notification object IDs.', - 'visibility' => 'Public', + 'silenceTime' => ['description' => 'The notification silence period. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '86400'], + 'slackWebhooks' => [ + 'description' => 'A list of Slack webhook notification object IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Feishu webhook notification object ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myFsWebhookId', - 'extendType' => 'true', - ], - 'backendName' => 'fsWebhooks', + 'items' => ['description' => 'A Slack webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'mySlackWebhookId'], + 'title' => '', + 'example' => '', ], - 'version' => [ + 'wxWebhooks' => [ + 'description' => 'A list of WeChat webhook notification object IDs.', + 'type' => 'array', + 'items' => ['description' => 'A WeChat webhook notification object ID.', 'type' => 'string', 'title' => '', 'example' => 'myWxWebhookId'], 'title' => '', - 'description' => 'Version of the notification object; the default (empty) value corresponds to the 2.0 notification object. When version=cmsV1, notifications are sent via Cloud Monitor 1.0 notification objects. This is a non-public attribute.', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'cmsV1', - 'backendName' => 'version', + 'example' => '', ], - 'contacts' => [ - 'description' => 'List of contact IDs.', - 'visibility' => 'Public', + 'notifyTime' => ['title' => '', 'description' => 'The notification period. Notifications are sent only within this period.', '$ref' => '#/components/schemas/AlertRuleTimeSpan', 'example' => ''], + 'dingCoolAppWebhooks' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myContactId', - 'extendType' => 'true', + 'items' => ['description' => 'A single DingTalk Cool App webhook ID.', 'type' => 'string', 'title' => '', 'example' => 'myDingCoolAppWebhookId'], + 'description' => 'A list of DingTalk Cool App webhook notification object IDs.', + 'title' => '', + 'example' => '', + ], + 'qwencloudContacts' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'contacts', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'AlertRuleNotificationFilter' => [ - 'description' => '', + 'description' => 'Filter configuration for notification recipients.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'slackWebhooks' => [ - 'description' => '', + 'description' => 'A list of Slack webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'slackWebhooks', + 'title' => '', + 'example' => '', ], 'wxWebhooks' => [ - 'description' => '', + 'description' => 'A list of WeChat webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'wxWebhooks', + 'title' => '', + 'example' => '', ], 'dingWebhooks' => [ - 'description' => '', + 'description' => 'A list of DingTalk webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'dingWebhooks', + 'title' => '', + 'example' => '', ], 'customWebhooks' => [ - 'description' => '', + 'description' => 'A list of custom webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'customWebhooks', + 'title' => '', + 'example' => '', ], 'groups' => [ - 'description' => '', + 'description' => 'A list of contact group IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myContactGroup', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The contact group ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myContactGroup'], 'backendName' => 'groups', + 'title' => '', + 'example' => '', ], 'fsWebhooks' => [ - 'description' => '', + 'description' => 'A list of Lark webhook IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'webhook ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myWebhookId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The webhook ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myWebhookId'], 'backendName' => 'fsWebhooks', + 'title' => '', + 'example' => '', ], 'contacts' => [ - 'description' => '', + 'description' => 'A list of contact IDs for filtering.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myContactId', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The contact ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'myContactId'], 'backendName' => 'contacts', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'AlertRuleQuery' => [ - 'description' => 'Query configuration for alert rules. The fields included in this configuration object depend on the query type (the "type" field), and different data query types support different fields.', - 'visibility' => 'Public', + 'description' => 'The query configuration of the alert rule. The fields included in this configuration object depend on the query type (the type field). Different data query types use different fields.', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" - .'Duration of alert data, in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - 'backendName' => 'duration', - ], - 'expr' => [ - 'title' => '', - 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" - .'Query expression (PromQL).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sum(sum(max_over_time(kube_pod_status_phase{phase=~\\"Pending\\",job=\\"_kube-state-metrics\\"}[5m])) by (pod)) > 1000', - 'backendName' => 'expr', - ], + 'duration' => ['title' => '', 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" + ."\n" + .'The duration for which alert data persists. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'expr' => ['title' => '', 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" + ."\n" + .'The query expression (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' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'List of grouping field names.', - 'visibility' => 'Public', + ."\n" + .'The list of group field names.', 'type' => 'array', - 'items' => [ - 'description' => 'Grouping field name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'host_name', - 'extendType' => 'true', - ], - 'backendName' => 'groupFieldList', + 'items' => ['description' => 'The grouping field name.', 'type' => 'string', 'title' => '', 'example' => 'host_name'], + 'example' => '', ], 'groupType' => [ 'title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Grouping type, with the following possible values:'."\n" ."\n" - .'- none: No grouping.'."\n" - .'- label: Automatic label grouping.'."\n" - .'- custom: Custom label grouping.', - 'visibility' => 'Public', + .'The group type. Valid values:'."\n" + .'- none: no grouping.'."\n" + .'- label: automatic label-based grouping.'."\n" + .'- custom: custom label-based grouping.', 'type' => 'string', + 'enum' => ['none', 'label', 'custom'], 'example' => 'label', - 'backendName' => 'groupType', - 'enum' => [ - 'none', - 'label', - 'custom', - ], ], 'queries' => [ 'title' => '', - 'description' => 'Applicable query types: SLS_MULTI_QUERY, APM_MULTI_QUERY.'."\n" - .'List of subqueries.'."\n" + 'description' => 'Applicable query types: SLS_MULTI_QUERY and APM_MULTI_QUERY.'."\n" ."\n" - .'For the SLS_MULTI_QUERY type, the list can contain up to three subqueries, and the number and order of subqueries must match the sub-datasource configurations in datasource.dsList.', - 'visibility' => 'Public', + .'The list of subqueries.'."\n" + ."\n" + .'For the SLS_MULTI_QUERY query type, a maximum of three subqueries are supported. The number and order of subqueries must match the sub-datasource config in datasource.dsList.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => 'Subquery.', - 'visibility' => 'Public', + 'description' => 'The subquery.', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'Applicable query type: ARMS_MULTI_QUERY.'."\n" - .'Alert (data) duration.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - 'backendName' => 'duration', - ], - 'end' => [ + 'duration' => ['title' => '', 'description' => 'Applicable query type: ARMS_MULTI_QUERY.'."\n" + ."\n" + .'The alert data duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + 'end' => ['title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The relative time offset end time.'."\n" + ."\n" + .'If start and end are specified, do not specify window.', 'type' => 'integer', 'format' => 'int64', 'pattern' => '', 'default' => '', 'example' => '0'], + 'expr' => ['title' => '', 'description' => 'Applicable query types: APM_MULTI_QUERY, SLS_MULTI_QUERY.'."\n" + ."\n" + .'The query expression.'."\n" + ."\n" + .'- For APM_MULTI_QUERY, this field is optional and contains the PromQL generated for predefined metrics (used for data preview).'."\n" + .'- For SLS_MULTI_QUERY, this field contains the SQL query statement.', 'type' => 'string', 'pattern' => '', 'default' => '', '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]))'], + 'start' => ['title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The relative time offset start time for the SLS query.'."\n" + ."\n" + .'If start and end are specified, do not specify window. Example: start=15, timeUnit=minute indicates 15 minutes ago.', 'type' => 'integer', 'format' => 'int64', 'pattern' => '', 'default' => '', 'example' => '15'], + 'timeUnit' => [ 'title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Time offset end time (relative).'."\n" - .'If start and end are specified, do not specify window.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'pattern' => '', - 'backendName' => 'end', - 'sensitive' => false, - 'default' => '', - ], - 'expr' => [ - 'title' => '', - 'description' => 'Applicable query types: APM_MULTI_QUERY, SLS_MULTI_QUERY.'."\n" - .'Query expression.'."\n" ."\n" - .'- For APM_MULTI_QUERY, this field is optional and contains the PromQL generated for predefined metrics (used for data preview).'."\n" - .'- For SLS_MULTI_QUERY, this field contains the SQL query statement.', - 'visibility' => 'Public', - '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' => '', - 'backendName' => 'expr', - 'sensitive' => false, - 'default' => '', - ], - 'start' => [ - 'title' => '', - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'SLS query time offset start time (relative).'."\n" - .'If start and end are specified, do not specify window. For example: start=15, timeUnit=minute, which means 15 minutes ago.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - 'pattern' => '', - 'backendName' => 'start', - 'sensitive' => false, - 'default' => '', - ], - 'timeUnit' => [ - 'title' => '', - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Time units for the start, end, and window parameters: day/hour/minute/second.', - 'visibility' => 'Public', + .'The time unit for the start, end, and window parameters: day/hour/minute/second.', 'type' => 'string', - 'example' => 'hour', 'pattern' => '', - 'backendName' => 'timeUnit', - 'sensitive' => false, 'default' => 'minute', - 'enum' => [ - 'second', - 'minute', - 'hour', - 'day', - ], - ], - 'window' => [ - 'title' => '', - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Exact-hour time query interval. If window is specified, start and end should not be specified.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'pattern' => '', - 'backendName' => 'window', - 'sensitive' => false, - 'default' => '', - ], - 'apmAlertMetricId' => [ - 'title' => '', - 'description' => 'Applicable query type: APM_MULTI_QUERY.'."\n" - .'ID of the APM predefined metric.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'appstat.jvm.ThreadNewCount', - 'backendName' => 'measureCode', + 'enum' => ['second', 'minute', 'hour', 'day'], + 'example' => 'hour', ], + 'window' => ['title' => '', 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The time frame query interval. If window is specified, do not specify start or end.', 'type' => 'integer', 'format' => 'int64', 'pattern' => '', 'default' => '', 'example' => '1'], + 'apmAlertMetricId' => ['title' => '', 'description' => 'Applicable query type: APM_MULTI_QUERY.'."\n" + ."\n" + .'The ID of the APM predefined metric.', 'type' => 'string', 'example' => 'appstat.jvm.ThreadNewCount'], 'apmFilters' => [ 'title' => '', 'description' => 'Applicable query type: ARMS_MULTI_QUERY.'."\n" - .'Dimension filter configuration for APM metrics. Must be used in conjunction with apmAlertMetricId.', - 'visibility' => 'Public', + ."\n" + .'The dimension filter configuration for the APM metric. Must be used together with apmAlertMetricId.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'dim' => [ - 'title' => '', - 'description' => 'Dimension in APM metrics.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rpcType', - 'backendName' => 'key', - ], - 'type' => [ - 'title' => '', - 'description' => 'Filter operation types:'."\n" - ."\n" - .'- eq: equals.'."\n" - .'- neq: not equals.'."\n" - .'- match: regular expression match.'."\n" - .'- nmatch: regular expression not match.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eq', - 'backendName' => 'type', - ], - 'value' => [ - 'title' => '', - 'description' => 'The corresponding value for the filter operation.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'h3ji7a0y9i@2ac80e27fdfd0a2', - 'backendName' => 'value', - ], + 'dim' => ['title' => '', 'description' => 'The dimension in the APM metric.', 'type' => 'string', 'example' => 'rpcType'], + 'type' => ['title' => '', 'description' => 'The filter operation type. Valid values:'."\n" + .'- eq: equal to'."\n" + .'- neq: not equal to'."\n" + .'- match: regex match'."\n" + .'- nmatch: regex not match', 'type' => 'string', 'example' => 'eq'], + 'value' => ['title' => '', 'description' => 'The value corresponding to the filter operation.', 'type' => 'string', 'example' => 'h3ji7a0y9i@2ac80e27fdfd0a2'], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'filters', + 'example' => '', ], 'apmGroupBy' => [ 'title' => '', 'description' => 'Applicable query type: ARMS_MULTI_QUERY.'."\n" - .'List of aggregation dimensions for the query, i.e., the dimensions by which the metric is aggregated.', - 'visibility' => 'Public', + ."\n" + .'The list of aggregation dimensions for the query, specifying which metric dimensions to aggregate by.', + 'type' => 'array', + 'items' => ['description' => 'The aggregation dimension of the metric.', 'type' => 'string', 'title' => '', 'example' => 'rpcType'], + 'example' => '', + ], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'promQl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'metricSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metric' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'labelFilters' => [ + 'title' => '', 'type' => 'array', 'items' => [ - 'description' => 'Aggregation dimensions of the metric.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rpcType', - 'extendType' => 'true', + 'type' => 'object', + 'properties' => [ + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'groupBy', + 'description' => '', + 'example' => '', ], ], - 'sensitive' => false, - 'extendType' => 'true', + 'example' => '', ], - 'backendName' => 'queries', - ], - 'firstJoin' => [ - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Configuration for the set join operation between the results of subquery 1 (queries[0]) and subquery 2 (queries[1]).', - 'visibility' => 'Public', - 'backendName' => 'firstJoin', - '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', + 'example' => '', ], + 'firstJoin' => ['description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The set join operation configuration for the results of subquery 1 (queries[0]) and subquery 2 (queries[1]).', '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', 'title' => '', 'example' => ''], 'type' => [ 'title' => '', - 'description' => 'Query type.'."\n" + 'description' => 'The query type. '."\n" ."\n" .'Valid values:'."\n" + .'- PROMQL_QUERY: PromQL query.'."\n" + .'- SLS_MULTI_QUERY: SLS query.'."\n" + .'- APM_MULTI_QUERY: APM query.'."\n" + .'- CMS_BASIC_QUERY: basic cloud service monitoring query.'."\n" ."\n" - .'- PROMQL_QUERY: PromQL query'."\n" - .'- SLS_MULTI_QUERY: SLS query'."\n" - .'- APM_MULTI_QUERY: APM query'."\n" - .'- CMS_BASIC_QUERY: Basic CloudMonitor query'."\n" - ."\n" - .'The valid fields within the query object vary depending on the query type. Refer to the "Applicable query type" description in each field\'s documentation for details.'."\n" - ."\n" - .'The query type must match the data source type, with the following correspondences:'."\n" + .'Different query types use different valid fields in the query object. For more information, see the "Applicable query type" description of each field.'."\n" ."\n" + .'The query type must match the data source type. The mappings are as follows:'."\n" .'- Prometheus data source (PROMETHEUS_DS): PROMQL_QUERY'."\n" .'- APM data source (APM_DS): APM_MULTI_QUERY'."\n" .'- SLS data source (SLS_MULTI_DS): SLS_MULTI_QUERY'."\n" - .'- Basic CloudMonitor data source (CMS_BASIC_DS): CMS_BASIC_QUERY.', - 'visibility' => 'Public', + .'- Basic cloud service monitoring data source (CMS_BASIC_DS): CMS_BASIC_QUERY', + 'enumValueTitles' => ['PROMQL_QUERY' => 'PROMQL_QUERY', 'CMS_BASIC_QUERY' => 'CMS_BASIC_QUERY', 'APM_MULTI_QUERY' => 'APM_MULTI_QUERY', 'SLS_MULTI_QUERY' => 'SLS_MULTI_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' => '', - 'backendName' => 'type', - 'sensitive' => false, 'default' => 'PROMQL_QUERY', - 'enum' => [ - 'PROMQL_QUERY', - 'SLS_MULTI_QUERY', - 'APM_MULTI_QUERY', - 'CMS_BASIC_QUERY', - 'METRIC_SET_QUERY', - ], - ], - 'secondJoin' => [ - 'description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" - .'Configuration for the set join operation between the results of subquery 2 (queries[2]) and subquery 3 (queries[3]).', - 'visibility' => 'Public', - 'backendName' => 'secondJoin', - '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', - ], - 'checkAfterDataComplete' => [ - 'title' => '', - 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" - .'Whether to perform alert evaluation only after data completeness is ensured.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'checkAfterDataComplete', + 'enum' => ['PROMQL_QUERY', 'SLS_MULTI_QUERY', 'APM_MULTI_QUERY', 'CMS_BASIC_QUERY', 'METRIC_SET_QUERY', 'LOG_SET_QUERY', 'PROMETHEUS_MULTI_QUERY', 'METRIC_SET_MULTI_QUERY'], + 'example' => 'PROMQL_QUERY', ], + 'secondJoin' => ['description' => 'Applicable query type: SLS_MULTI_QUERY.'."\n" + ."\n" + .'The set join operation configuration for the results of subquery 2 (queries[2]) and subquery 3 (queries[3]).', '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', 'title' => '', 'example' => ''], + 'checkAfterDataComplete' => ['title' => '', 'description' => 'Applicable query type: PROMQL_QUERY.'."\n" + ."\n" + .'Specifies whether to perform alert detection only after data is complete.', 'type' => 'boolean', 'example' => 'true'], 'relationType' => [ 'title' => '', 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - .'Resource scope for the rule query, with the following allowed values:'."\n" - .'- USER: All resources under the user\'s UID.'."\n" - .'- GROUP: Application group.'."\n" - .'- INSTANCE: Specified list of instances.', - 'visibility' => 'Public', + ."\n" + .'The resource scope of the rule query. Valid values:'."\n" + .'- USER: all resources under the user UID.'."\n" + .'- GROUP: application group.'."\n" + .'- INSTANCE: specified instance list.', + 'enumValueTitles' => ['GROUP' => 'GROUP', 'INSTANCE' => 'INSTANCE', 'USER' => 'USER'], 'type' => 'string', - 'enumValueTitles' => [ - 'GROUP' => 'GROUP', - 'INSTANCE' => 'INSTANCE', - 'USER' => 'USER', - ], 'example' => 'USER', - 'backendName' => 'relationType', ], - 'groupId' => [ + 'groupId' => ['title' => '', 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" + ."\n" + .'The ID of the associated application group. This parameter takes effect only when relationType is set to GROUP.', 'type' => 'string', 'example' => '23423'], + 'namespace' => ['title' => '', 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" + ."\n" + .'The namespace of the metric.', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], + 'entityFilter' => [ + 'description' => 'The resource filter used to filter target resources.', + 'type' => 'object', + 'properties' => [ + 'domain' => ['description' => 'The resource type domain.', 'type' => 'string', 'title' => '', 'example' => 'rum'], + 'type' => ['description' => 'The resource type.', 'type' => 'string', 'title' => '', 'example' => 'apm'], + 'filters' => [ + 'description' => 'The list of filter conditions used to further filter resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The filter condition object.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The field.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], + 'operator' => ['description' => 'The comparison operator.', 'type' => 'string', 'title' => '', 'example' => '='], + 'value' => ['description' => 'The matched value.', 'type' => 'string', 'title' => '', 'example' => 'wait_throw'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'title' => '', - 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - .'Associated application group ID, valid only when relationType = GROUP.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '23423', - 'backendName' => 'groupId', + 'example' => '', ], - 'namespace' => [ + 'domain' => ['description' => 'The domain to which the resource belongs.', 'type' => 'string', 'title' => '', 'example' => 'rum'], + 'metricSet' => ['description' => 'The collection of monitoring metrics.', 'type' => 'string', 'title' => '', 'example' => 'cpu_usage'], + 'metric' => ['description' => 'The metric name.', 'type' => 'string', 'title' => '', 'example' => 'memory'], + 'logSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'windowSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'offsetSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'aggregate' => [ 'title' => '', - 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - .'Namespace of the metric.', - 'visibility' => 'Public', 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - 'backendName' => 'namespace', + 'description' => '', + 'example' => '', + 'enum' => ['AVG', 'MAX', 'MIN', 'SUM', 'LAST'], ], 'dimensions' => [ 'title' => '', - 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - .'List of filtering dimensions for the resource.', - 'visibility' => 'Public', + 'description' => 'Applicable query type: CMS_BASIC_QUERY. '."\n" + ."\n" + .'The list of filter dimensions for the resource.', 'type' => 'array', 'items' => [ - 'description' => 'Basic cloud monitoring resource filtering dimensions.', - 'visibility' => 'Public', + 'description' => 'The resource filter dimension for CloudMonitor Basic.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'Dimension value.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-f8zbbutcvfpx7gn457pi', - ], - 'extendType' => 'true', + 'additionalProperties' => ['description' => 'The dimension value.', 'type' => 'string', 'title' => '', 'example' => 'i-f8zbbutcvfpx7gn457pi'], + 'title' => '', + 'example' => '', ], - 'backendName' => 'dimensions', + 'example' => '', ], 'serviceIds' => [ - 'description' => 'Service ID list.', - 'visibility' => 'Public', + 'description' => 'The list of service IDs.', + 'type' => 'array', + 'items' => ['description' => 'The service ID.', 'type' => 'string', 'title' => '', 'example' => 'i-bp1234567890abcdef'], + 'title' => '', + 'example' => '', + ], + 'labelFilters' => [ + 'description' => 'The array of label filters.', 'type' => 'array', 'items' => [ - 'description' => 'Service ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-bp1234567890abcdef'."\n", - 'extendType' => 'true', + 'description' => 'The label filter object.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The label name.', 'type' => 'string', 'title' => '', 'example' => 'app'], + 'value' => ['description' => 'The label value.', 'type' => 'string', 'title' => '', 'example' => 'web'], + 'operator' => ['description' => 'The comparison operator that determines how to match the label value.', 'type' => 'string', 'title' => '', 'example' => '='], + ], + 'title' => '', + 'example' => '', ], - 'backendName' => 'serviceIds', + 'title' => '', + 'example' => '', ], - 'entityFilter' => [ - 'description' => '资源过滤器，用于筛选目标资源。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'domain' => [ - 'description' => '资源类型域。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum', - 'backendName' => 'domain', - ], - 'type' => [ - 'description' => '资源类型。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'apm', - 'backendName' => 'type', - ], - 'filters' => [ - 'description' => '过滤条件列表，用于进一步筛选资源。', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '过滤条件对象。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'field' => [ - 'description' => '字段', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'field', - ], - 'operator' => [ - 'description' => '比较运算符。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '=', - 'backendName' => 'operator', - ], - 'value' => [ - 'description' => '匹配的值。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'wait_throw', - 'backendName' => 'value', - ], - ], - 'extendType' => 'true', - ], - 'backendName' => 'filters', + 'entityFields' => [ + 'description' => 'The array of entity field filters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The entity field filter object.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The entity field name.', 'type' => 'string', 'title' => '', 'example' => 'instanceId'], + 'value' => ['description' => 'The field value.', 'type' => 'string', 'title' => '', 'example' => 'i-abc123'], ], + 'title' => '', + 'example' => '', ], - 'backendName' => 'entityFilter', - ], - 'domain' => [ - 'description' => '资源所属的领域。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum', - 'backendName' => 'domain', - ], - 'metricSet' => [ - 'description' => '监控指标集合。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cpu_usage', - 'backendName' => 'metricSet', + 'title' => '', + 'example' => '', ], - 'metric' => [ - 'description' => '指标名。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'memory', - 'backendName' => 'metric', + 'markTags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'AlertRuleRcaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'enableRca' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'digitalEmployeeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'AlertRuleSend' => [ - 'description' => 'Alert Delivery Configuration Object.', - 'visibility' => 'Public', + 'description' => 'The alert delivery configuration object.', 'type' => 'object', 'properties' => [ - 'notification' => [ - 'description' => 'Alert Notification Configuration.', - 'visibility' => 'Public', - 'backendName' => 'notification', - '$ref' => '#/components/schemas/AlertRuleNotification', - ], - 'action' => [ - 'description' => 'Alert Action Integration Configuration.', - 'visibility' => 'Public', - 'backendName' => 'action', - '$ref' => '#/components/schemas/AlertRuleAction', - ], - 'sendToArms' => [ + 'notification' => ['description' => 'The alert notification configuration.', '$ref' => '#/components/schemas/AlertRuleNotification', 'title' => '', 'example' => ''], + 'action' => ['description' => 'The integrated alert action configuration.', '$ref' => '#/components/schemas/AlertRuleAction', 'title' => '', 'example' => ''], + 'sendToArms' => ['title' => '是否将告警事件投递至ARMS告警管理', 'description' => 'Specifies whether to deliver alert events to Alert Management of Application Real-Time Monitoring Service (ARMS).', 'type' => 'boolean', 'example' => 'true'], + 'notifyStrategies' => [ + 'type' => 'array', + 'items' => ['description' => 'The notification policy.', 'type' => 'string', 'title' => '', 'example' => '["trigger", "recovery"]'], + 'description' => 'The list of notification policies. Each policy defines the notification method or policy name to use for a specific alert state, such as trigger or recovery.', 'title' => '', - 'description' => 'Whether to deliver alert events to ARMS Alert Management.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'sendToArms', + 'example' => '', ], + 'rcaConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AlertRuleRcaConfig'], ], + 'title' => '', + 'example' => '', ], 'AlertRuleSlsQueryJoin' => [ - 'description' => 'SLS Query Connection Configuration.', + 'description' => 'The SLS query join configuration.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'conditions' => [ - 'description' => 'List of connection conditions.', + 'description' => 'The list of join conditions.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => 'Set operation condition.', + 'title' => '集合操作条件', + 'description' => 'The condition for the collection operation.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'oper' => [ - 'title' => '', - 'description' => 'Comparison operator; valid values: <, >, ==, !=, <=, >=.', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => false, - 'hasServerDefaultValue' => false, - 'example' => '==', - 'pattern' => '', - 'readOnly' => false, - 'backendName' => 'oper', - 'sensitive' => false, - 'extMonitorInfo' => false, - 'descriptionEn' => 'join operator', - 'default' => '', + 'title' => '集合联接条件操作符', 'description' => 'The comparison operator. Valid values are <, >, ==, !=, <=, and >=.', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'pattern' => '', 'readOnly' => false, 'backendName' => 'oper', 'sensitive' => false, + 'extMonitorInfo' => false, 'descriptionEn' => 'join operator', 'default' => '', 'example' => '==', ], 'secondField' => [ - 'title' => '', - 'description' => 'Right-hand operand of the condition, formatted as $..', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => false, - 'hasServerDefaultValue' => false, - 'example' => '$0.__topic__', - 'pattern' => '', - 'readOnly' => false, - 'backendName' => 'secondField', - 'sensitive' => false, - 'extMonitorInfo' => false, - 'descriptionEn' => 'right parameter of join condition', - 'default' => '', + 'title' => '条件的右操作参数', 'description' => 'The right operand of the condition. The format is $\\.\\.', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'pattern' => '', 'readOnly' => false, 'backendName' => 'secondField', 'sensitive' => false, + 'extMonitorInfo' => false, 'descriptionEn' => 'right parameter of join condition', 'default' => '', 'example' => '$0.__topic__', ], 'firstField' => [ - 'title' => '', - 'description' => 'Left-hand operand of the condition, formatted as $..', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => false, - 'hasServerDefaultValue' => false, - 'example' => '$0.__topic__', - 'pattern' => '', - 'readOnly' => false, - 'backendName' => 'firstField', - 'sensitive' => false, - 'extMonitorInfo' => false, - 'descriptionEn' => 'left parameter of join condition', - 'default' => '', + 'title' => '条件的左操作参数', 'description' => 'The left operand of the condition. The format is $\\.\\.', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => false, 'hasServerDefaultValue' => false, 'pattern' => '', 'readOnly' => false, 'backendName' => 'firstField', 'sensitive' => false, + 'extMonitorInfo' => false, 'descriptionEn' => 'left parameter of join condition', 'default' => '', 'example' => '$0.__topic__', ], ], 'deprecated' => false, @@ -2643,5444 +1553,6861 @@ 'descriptionEn' => 'join condition', 'extendType' => 'true', 'unordered' => false, + 'example' => '', ], 'backendName' => 'conditions', + 'title' => '', + 'example' => '', ], 'type' => [ - 'title' => '', - 'description' => 'Set operation type.'."\n" - .'CrossJoin: Cartesian product'."\n" - .'FullJoin: Full outer join'."\n" - .'InnerJoin: Inner join'."\n" - .'LeftExclude: Left anti join'."\n" - .'RightExclude: Right anti join'."\n" - .'LeftJoin: Left outer join'."\n" - .'RightJoin: Right outer join'."\n" - .'NoJoin: No merge'."\n" - .'Concat: Concatenation'."\n" + 'title' => '查询结果集合操作类型', + 'description' => 'The type of the collection operation.'."\n" + ."\n" + .'- CrossJoin: The Cartesian product.'."\n" + ."\n" + .'- FullJoin: The full join.'."\n" + ."\n" + .'- InnerJoin: The inner join.'."\n" + ."\n" + .'- LeftExclude: The left exclusion.'."\n" + ."\n" + .'- RightExclude: The right exclusion.'."\n" + ."\n" + .'- LeftJoin: The left join.'."\n" + ."\n" + .'- RightJoin: The right join.'."\n" + ."\n" + .'- NoJoin: No merge operation is performed.'."\n" ."\n" - .'See also: https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement', + .'- Concat: Concatenation.'."\n" + ."\n" + .'For more information, see https\\://www\\.alibabacloud.com/help/en/sls/user-guide/set-operations.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, - 'example' => 'CrossJoin', 'pattern' => '', 'backendName' => 'type', 'sensitive' => false, 'default' => '', - 'enum' => [ - 'CrossJoin', - 'FullJoin', - 'InnerJoin', - 'LeftExclude', - 'RightExclude', - 'LeftJoin', - 'RightJoin', - 'NoJoin', - 'Concat', - ], + 'enum' => ['CrossJoin', 'FullJoin', 'InnerJoin', 'LeftExclude', 'RightExclude', 'LeftJoin', 'RightJoin', 'NoJoin', 'Concat'], + 'example' => 'CrossJoin', ], ], + 'title' => '', + 'example' => '', + ], + 'AlertRuleTemplate' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'uuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'gmtCreate' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'gmtModified' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'userId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'templateName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'isSystem' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'alertType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'subType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'status' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'applyCount' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'ruleConfigs' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'labels' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'datasource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'scenes' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'sourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'bizType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'schemaVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'AlertRuleTimeSpan' => [ - 'description' => 'Time Window Configuration Object.', - 'visibility' => 'Public', + 'description' => 'The configuration object for a time segment.', 'type' => 'object', 'properties' => [ 'dayOfWeek' => [ - 'title' => '', - 'description' => 'Day of the week.', - 'visibility' => 'Public', + 'title' => '每周的星期几', + 'description' => 'The days of the week.', 'type' => 'array', 'items' => [ - 'description' => 'Day of the week.', - 'visibility' => 'Public', + 'description' => 'The day of the week.', 'type' => 'integer', 'format' => 'int32', + 'enum' => ['1', '2', '3', '4', '5', '6', '7'], + 'title' => '', 'example' => '1', + 'visibility' => 'Public', 'extendType' => 'true', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - ], ], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'dayOfWeek', ], - 'gmtOffset' => [ - 'title' => '', - 'description' => 'Default time zone is Beijing Time: +0800.', - 'visibility' => 'Public', + 'gmtOffset' => ['title' => '默认北京时间： +0800', 'description' => 'The default value is +0800 (UTC+8).', 'type' => 'string', 'example' => '+0800', 'visibility' => 'Public', 'backendName' => 'gmtOffset'], + 'startTime' => ['title' => '开始时间，格式HH:mm', 'description' => 'The start time. The format is HH:mm.', 'type' => 'string', 'example' => '09:00', 'visibility' => 'Public', 'backendName' => 'startTime'], + 'endTime' => ['title' => '结束时间，格式HH:mm', 'description' => 'The end time. The format is HH:mm.', 'type' => 'string', 'example' => '23:00', 'visibility' => 'Public', 'backendName' => 'endTime'], + ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', + ], + 'AlertRuleV2' => [ + 'description' => 'The `AlertRuleV2` object contains the complete configuration for an alert rule.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['description' => 'The unique identifier for the alert rule.', 'type' => 'string', 'title' => '', 'example' => '', 'readOnly' => true], + 'createdAt' => ['description' => 'The time the alert rule was created.', 'type' => 'string', 'title' => '', 'example' => '', 'readOnly' => true], + 'updatedAt' => ['description' => 'The time the alert rule was last updated.', 'type' => 'string', 'title' => '', 'example' => '', 'readOnly' => true], + 'status' => [ + 'description' => 'The current status of the alert rule. Examples: `RUNNING`, `STOPPED`.', 'type' => 'string', - 'example' => '+0800', - 'backendName' => 'gmtOffset', + 'title' => '', + 'example' => '', + 'readOnly' => true, + 'enum' => ['Alarm', 'Ok'], + ], + 'workspace' => ['description' => 'The ID of the workspace that contains the alert rule.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => false], + 'displayName' => ['description' => 'The user-defined display name for the alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'contentTemplate' => ['description' => 'The template for the alert notification content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'enabled' => ['description' => 'Indicates whether the alert rule is active. Set to `true` to enable the rule, or `false` to disable it.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'datasourceConfig' => ['description' => 'The configuration for the data source to be evaluated.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DatasourceConfigUnified'], + 'queryConfig' => ['description' => 'The configuration for querying and processing data from the data source.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QueryConfigUnified'], + 'conditionConfig' => ['description' => 'The configuration for the conditions that trigger an alert.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ConditionConfigUnified'], + 'scheduleConfig' => ['description' => 'The configuration for how often the alert rule is evaluated.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ScheduleConfigUnified'], + 'notifyConfig' => ['description' => 'The configuration for sending notifications when an alert is triggered.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyConfigUnified'], + 'actionIntegrationConfig' => ['description' => 'Configuration for action integrations, such as webhooks, that execute when an alert is triggered.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ActionIntegrationConfig'], + 'armsIntegrationConfig' => ['description' => 'The configuration for integrating the alert rule with Application Real-Time Monitoring Service (ARMS).', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ArmsIntegrationConfig'], + 'labels' => [ + 'description' => 'A set of key-value pairs that serve as labels to filter and group alert rules.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of the label.', 'type' => 'string', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'startTime' => [ + 'annotations' => [ + 'description' => 'A set of key-value pairs that serve as annotations, providing additional, non-identifying information, such as a description or a runbook link.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of the annotation.', 'type' => 'string', 'title' => '', 'example' => ''], 'title' => '', - 'description' => 'Start time, in HH:mm format.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '09:00', - 'backendName' => 'startTime', + 'example' => '', ], - 'endTime' => [ + 'datasourceType' => ['description' => 'The data source type. Examples: `sls`, `prometheus`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'observeResourceType' => ['description' => 'The type of resource that the alert rule monitors.', 'type' => 'string', 'title' => '', 'example' => ''], + 'observeResourceGlobalScope' => ['description' => 'Indicates whether the alert rule monitors all resources of the specified type. If `true`, the rule applies globally within the workspace.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'observeResourceList' => [ + 'description' => 'A list of specific resource IDs to monitor, used only when `observeResourceGlobalScope` is `false`.', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'type' => 'array', 'title' => '', - 'description' => 'End time, in HH:mm format.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '23:00', - 'backendName' => 'endTime', + 'example' => '', ], + 'severityLevels' => ['description' => 'The severity level of the alert. Examples: `critical`, `warning`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'notifyStrategyId' => ['description' => 'The ID of the notification strategy to use for this alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'partitionKey' => ['description' => 'The partition key used to group alerts. Alerts with the same partition key are treated as a single incident.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - 'BizTraceConfig' => [ - 'description' => '', - 'visibility' => 'Public', + 'ApmCompositeCompareConfig' => [ + 'description' => 'Defines a composite comparison condition for an alert rule.', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'aggregate' => [ + 'description' => 'The aggregation method for metric data. For example, `AVG`, `SUM`, or `MAX`.', 'type' => 'string', - 'example' => 'default-cms-xxxxxxx-cn-hangzhou', - 'backendName' => 'workspace', - ], - 'bizTraceId' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'e339260ed64c95d', - 'backendName' => 'bizTraceId', + 'example' => '', + 'required' => true, + 'enum' => ['AVG', 'SUM', 'COUNT', 'CONTINUES', 'MAX', 'MIN', 'P50', 'P75', 'P90', 'P99'], ], - 'bizTraceName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'operator' => [ + 'description' => 'The operator for comparing the aggregated metric data against the `threshold`. For example, `GREATER_THAN` or `LESS_THAN`.', 'type' => 'string', - 'example' => 'just test', - 'backendName' => 'bizTraceName', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['GT', 'GTE', 'LT', 'LTE', 'EQ', 'NE', 'YOY_UP', 'YOY_DOWN'], ], - 'bizTraceCode' => [ + 'threshold' => ['description' => 'The value to compare the aggregated metric data against. An alert is triggered when the metric data meets the condition defined by the `operator`.', 'type' => 'number', 'title' => '', 'example' => '', 'format' => 'float', 'required' => true], + 'yoyTimeUnit' => [ + 'description' => 'The time unit for the year-over-year (YoY) comparison. Use this parameter with `yoyTimeValue` to define the comparison period. Valid values are `day` and `week`.', + 'type' => 'string', 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'example' => '', + 'enum' => ['minute', 'hour', 'day', 'week', 'month'], + ], + 'yoyTimeValue' => ['description' => 'The time value for the YoY comparison. For example, if `yoyTimeUnit` is `day` and `yoyTimeValue` is `7`, the system compares current data with data from 7 days ago.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'title' => '', + 'example' => '', + ], + 'ApmFilterConfig' => [ + 'description' => 'Defines a single condition for filtering APM data traces.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key to filter by. For example, to filter traces by region, set this parameter to `RegionId`.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => true], + 'type' => [ + 'description' => 'The comparison operator used to match the tag\'s value. Valid values: `EQUAL` and `NOT_EQUAL`.', 'type' => 'string', - 'example' => 'label_env', - 'backendName' => 'bizTraceCode', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['ALL', 'EQ', 'NE', 'DISABLED'], ], - 'ruleConfig' => [ + 'value' => ['description' => 'The value to compare against the tag\'s value. Used with the `key` and `type` parameters to form a complete filter condition.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ApmMeasureConfig' => [ + 'description' => 'The configuration for querying an Application Performance Monitoring (APM) metric.', + 'type' => 'object', + 'properties' => [ + 'measureCode' => ['description' => 'The unique code that identifies the metric.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => true], + 'windowSecs' => ['description' => 'The aggregation period in seconds, which determines the time granularity of data points.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32', 'required' => true], + 'groupBy' => [ + 'description' => 'An array of dimension keys used to group the results.', + 'type' => 'array', + 'items' => ['description' => 'A dimension key used for grouping.', 'type' => 'string', 'title' => '', 'example' => ''], 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[{"entrancePid":"xxxxx@b57c44xx6e86","rpcMatcher":{"matchType":"EQUALS","pattern":"/createApp"},"characteristics":{"operation":"AND","rules":[{"target":"CUSTOM_EXTRACT","matcher":{"matchType":"CONTAINS","pattern":[]}}]}}]', - 'backendName' => 'ruleConfig', + 'example' => '', ], - 'advancedConfig' => [ + ], + 'title' => '', + 'example' => '', + ], + 'ApmThresholdConfig' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'severity' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'string', - 'example' => '{"sample":{"strategy":"BY_APP"}}', - 'backendName' => 'advancedConfig', + 'description' => '', + 'example' => '', + 'required' => true, + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], ], - 'createTime' => [ + 'threshold' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'float'], + 'min' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'max' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + ], + 'description' => '', + 'example' => '', + ], + 'ArmsIntegrationConfig' => [ + 'description' => 'The settings for Application Real-Time Monitoring Service (ARMS) integration.', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Whether ARMS integration is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'BizTraceConfig' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间。', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'default-cms-xxxxxxx-cn-hangzhou'], + 'bizTraceId' => ['title' => '业务链路id', 'description' => 'The business trace ID.', 'type' => 'string', 'example' => 'e339260ed64c95d'], + 'bizTraceName' => ['title' => '业务链路名称', 'description' => 'The business trace name.', 'type' => 'string', 'example' => 'just test'], + 'bizTraceCode' => ['title' => '业务链路标识', 'description' => 'The business trace identifier.', 'type' => 'string', 'example' => 'label_env'], + 'ruleConfig' => ['title' => '配置规则列表', 'description' => 'The list of configuration rules.', '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' => 'The advanced configuration.', 'type' => 'string', 'example' => '{"sample":{"strategy":"BY_APP"}}'], + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-12-12 00:00:00'], + 'regionId' => ['title' => '地域id', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing'], + ], + 'description' => 'The business trace configuration.', + 'title' => '', + 'example' => '', + ], + 'CloudMonitoringCompositeEscalation' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'relation' => ['title' => '', 'description' => 'Specifies the logical relationship for evaluating the conditions of the composite alert rule. Valid values: `and` and `or`.', 'type' => 'string', 'example' => ''], + 'severity' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Specifies the severity level of the alert. For example: `Critical`, `Warning`, and `Info`.', 'type' => 'string', - 'example' => '2025-12-12 00:00:00', - 'backendName' => 'createTime', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], + 'example' => '', ], - 'regionId' => [ + 'times' => ['title' => '', 'description' => 'Specifies the number of times the alert conditions must be met to trigger this escalation policy.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'escalations' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-beijing', - 'backendName' => 'regionId', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/CloudMonitoringCompositeEscalationEntry', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'A single entry in the escalation policy. See the `CloudMonitoringCompositeEscalationEntry` object for details.', + 'example' => '', ], ], + 'description' => 'The `CloudMonitoringCompositeEscalation` object defines the escalation policy for a composite alert rule. It specifies the conditions that trigger an escalation.', + 'example' => '', ], - 'CmsEventForView' => [ + 'CloudMonitoringCompositeEscalationEntry' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'comparisonOperator' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metricName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'period' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'statistics' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'threshold' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'preCondition' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], 'description' => '', - 'visibility' => 'Public', + 'example' => '', + ], + 'CloudMonitoringExpressEscalation' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'visibility' => 'Public', + 'times' => ['title' => '', 'description' => 'The number of alert occurrences required to trigger the escalation.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'severity' => [ + 'title' => '', + 'description' => 'The alert severity that triggers the escalation.', 'type' => 'string', - 'example' => '"event-1234567890"', - 'backendName' => 'id', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], + 'example' => '', ], - 'dedupId' => [ - 'description' => '', - 'visibility' => 'Public', + 'rawExpression' => ['title' => '', 'description' => 'The expression that defines the alert condition.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'Specifies the conditions for an express alert escalation.', + 'example' => '', + ], + 'CloudMonitoringPrometheusEscalation' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'title' => '', + 'description' => 'The severity of the alert that triggers the escalation. This parameter is required.', 'type' => 'string', - 'example' => '"dedup-abc123"', - 'backendName' => 'dedupId', + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], + 'example' => '', ], - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Alert"', - 'backendName' => 'type', + 'promQl' => ['title' => '', 'description' => 'The PromQL expression that defines the alert condition. This parameter is required.', 'type' => 'string', 'example' => ''], + 'times' => ['title' => '', 'description' => 'The number of consecutive times the condition must be met to trigger an escalation. This parameter is required.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + ], + 'description' => 'Specifies the escalation rule for a Prometheus alert.', + 'example' => '', + ], + 'CloudMonitoringSimpleEscalation' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'metricName' => ['title' => '', 'description' => 'The name of the metric.', 'type' => 'string', 'example' => ''], + 'period' => ['title' => '', 'description' => 'The evaluation period for the metric, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'escalations' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/CloudMonitoringSimpleEscalationEntry', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'An object that defines a single escalation rule.', + 'example' => '', ], - 'subtype' => [ - 'description' => '', - 'visibility' => 'Public', + ], + 'description' => 'Specifies the simple escalation policy for a Cloud Monitor alert.', + 'example' => '', + ], + 'CloudMonitoringSimpleEscalationEntry' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'comparisonOperator' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'statistics' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'threshold' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'severity' => [ + 'title' => '', 'type' => 'string', - 'example' => '"HighCPUUsage"', - 'backendName' => 'subtype', - ], - 'source' => [ + 'enum' => ['CRITICAL', 'ERROR', 'WARNING', 'INFO'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ECS"', - 'backendName' => 'source', + 'example' => '', ], - 'time' => [ - 'description' => '', - 'visibility' => 'Public', + 'times' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'preCondition' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'CmsEventForView' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique identifier for the event. The system generates this globally unique ID.', 'type' => 'string', 'title' => '', 'example' => '"event-1234567890"'], + 'dedupId' => ['description' => 'The deduplication ID. It identifies different instances of the same event, such as a repeatedly reported event.', 'type' => 'string', 'title' => '', 'example' => '"dedup-abc123"'], + 'type' => ['description' => 'The event type.', 'type' => 'string', 'title' => '', 'example' => '"Alert"'], + 'subtype' => ['description' => 'The event subtype.', 'type' => 'string', 'title' => '', 'example' => '"HighCPUUsage"'], + 'source' => ['description' => 'The name of the source system or service, such as ECS, RDS, or VPC.', 'type' => 'string', 'title' => '', 'example' => '"ECS"'], + 'time' => ['description' => 'The time when the event occurred.', 'type' => 'string', 'title' => '', 'example' => '"2025-04-05T10:30:00Z"'], + 'timestamp' => ['description' => 'The timestamp of the event occurrence.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743846600000'], + 'subject' => ['description' => 'The subject or title of the event. It briefly describes the event.', 'type' => 'string', 'title' => '', 'example' => '"Instance cpu usage exceeds threshold"'], + 'severity' => ['description' => 'The severity level of the event.', 'type' => 'string', 'title' => '', 'example' => '"CRITICAL"'], + 'status' => ['description' => 'The current status of the event.', 'type' => 'string', 'title' => '', 'example' => 'Running'], + 'resource' => ['description' => 'Information about the resource associated with the event, such as the instance ID, IP address, and region.', '$ref' => '#/components/schemas/EventResourceForEventView', 'title' => '', 'example' => ''], + 'labels' => ['description' => 'The key-value pairs of the event labels.', 'type' => 'object', 'title' => '', 'example' => '{\'source\': \'system\'}'], + 'annotations' => ['description' => 'Additional annotations for the event. This is an unstructured description field.', 'type' => 'object', 'title' => '', 'example' => '{ "description": "High load detected on server", "operator": "auto" }'], + 'dataschema' => ['description' => 'The data schema definition, which describes the structure of the data field.', 'type' => 'string', 'title' => '', 'example' => '"https://schema.alibabacloud.com/cms/alert/v1"'], + 'datacontenttype' => ['description' => 'The content type of the data field.', 'type' => 'string', 'title' => '', 'example' => '"application/json"'], + 'data' => ['description' => 'The raw data of the event. The format depends on the event type and dataschema.', 'type' => 'any', 'title' => '', 'example' => '{ "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }'], + 'receiveTime' => ['description' => 'The timestamp when the event was received and processed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743846610000'], + 'workspace' => ['description' => 'The ID or name of the workspace. It is used for multi-tenant or organization fencing.', 'type' => 'string', 'title' => '', 'example' => '"ws-abc123"'], + 'workspaceTags' => ['description' => 'The workspace tags. They help you manage events by tag.', 'type' => 'object', 'title' => '', 'example' => '{ "department": "finance", "project": "payment-gateway" }'], + 'sysId' => ['description' => 'The internal system event ID. It is used for internal tracking and log association.', 'type' => 'string', 'title' => '', 'example' => '"sys-event-987654321"'], + 'integrationUuid' => ['description' => 'The unique integration identifier. It is used for identity recognition in cross-system integrations.', 'type' => 'string', 'title' => '', 'example' => '"integration-xyz"'], + 'sourcetype' => ['description' => 'The type of event source. It distinguishes between sources such as monitoring systems, Simple Log Service, and application observability.', 'type' => 'string', 'title' => '', 'example' => '"CloudMonitor"'], + ], + 'description' => 'The event object. It contains the core information and context of an event.', + 'title' => '', + 'example' => '', + ], + 'ConditionConfigUnified' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '', 'type' => 'string', - 'example' => '"2025-04-05T10:30:00Z"', - 'backendName' => 'time', - ], - 'timestamp' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743846600000', - 'backendName' => 'timestamp', - ], - 'subject' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Instance cpu usage exceeds threshold"', - 'backendName' => 'subject', + 'example' => '', + 'required' => true, + 'enum' => ['PROMETHEUS_SIMPLE_CONDITION', 'UMODEL_METRICSET_CONDITION', 'UMODEL_LOGSET_CONDITION', 'UMODEL_METRICSET_MULTI_CONDITION', 'APM_SIMPLE_CONDITION', 'APM_COMPOSITE_CONDITION', 'CLOUD_MONITORING_CONDITION', 'UNKNOWN_CONDITION'], ], + 'durationSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], 'severity' => [ - 'description' => '', - 'visibility' => 'Public', + 'title' => '', 'type' => 'string', - 'example' => '"CRITICAL"', - 'backendName' => 'severity', - ], - 'status' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Running', - 'backendName' => 'status', + 'example' => '', + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], ], - 'resource' => [ + 'operator' => [ + 'title' => '', + 'type' => 'string', 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'resource', - '$ref' => '#/components/schemas/EventResourceForEventView', + 'example' => '', + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], ], - 'labels' => [ + 'threshold' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'min' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'max' => ['title' => '', 'type' => 'number', 'description' => '', 'example' => '', 'format' => 'double'], + 'aggregate' => [ + 'title' => '', + 'type' => 'string', 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{\'source\': \'system\'}', - 'backendName' => 'labels', + 'example' => '', + 'enum' => ['AVG', 'SUM', 'COUNT', 'CONTINUES', 'MAX', 'MIN', 'P50', 'P75', 'P90', 'P99'], ], - 'annotations' => [ + 'matchField' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'matchOperator' => [ + 'title' => '', + 'type' => 'string', 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "description": "High load detected on server", "operator": "auto" }', - 'backendName' => 'annotations', + 'example' => '', + 'enum' => ['PRESENT', 'NOT_PRESENT', 'CONTAINS', 'EQUALS', 'REGEX'], ], - 'dataschema' => [ - 'description' => '', - 'visibility' => 'Public', + 'matchValue' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'countOperator' => [ + 'title' => '', 'type' => 'string', - 'example' => '"https://schema.alibabacloud.com/cms/alert/v1"', - 'backendName' => 'dataschema', - ], - 'datacontenttype' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"application/json"', - 'backendName' => 'datacontenttype', + 'example' => '', + 'enum' => ['GTE', 'GT', 'EQ', 'LTE', 'LT'], ], - 'data' => [ + 'countThreshold' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'thresholdList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ApmThresholdConfig'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '{ "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }', - 'backendName' => 'data', + 'example' => '', ], - 'receiveTime' => [ + 'compareList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ApmCompositeCompareConfig'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743846610000', - 'backendName' => 'receiveTime', + 'example' => '', ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', + 'relation' => [ + 'title' => '', 'type' => 'string', - 'example' => '"ws-abc123"', - 'backendName' => 'workspace', - ], - 'workspaceTags' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "department": "finance", "project": "payment-gateway" }', - 'backendName' => 'workspaceTags', + 'example' => '', + 'enum' => ['OR', 'AND'], ], - 'sysId' => [ - 'description' => '', - 'visibility' => 'Public', + 'escalationType' => [ + 'title' => '', 'type' => 'string', - 'example' => '"sys-event-987654321"', - 'backendName' => 'sysId', - ], - 'integrationUuid' => [ 'description' => '', - 'visibility' => 'Public', + 'example' => '', + 'enum' => ['simple', 'composite', 'express', 'prometheus'], + ], + 'simpleEscalation' => ['title' => '', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/CloudMonitoringSimpleEscalation'], + 'compositeEscalation' => ['title' => '', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/CloudMonitoringCompositeEscalation'], + 'expressEscalation' => ['title' => '', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/CloudMonitoringExpressEscalation'], + 'prometheus' => ['title' => '', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/CloudMonitoringPrometheusEscalation'], + 'noDataPolicy' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'legacyType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'yoyTimeUnit' => [ + 'title' => '', 'type' => 'string', - 'example' => '"integration-xyz"', - 'backendName' => 'integrationUuid', + 'description' => '', + 'example' => '', + 'enum' => ['minute', 'hour', 'day', 'week', 'month'], ], - 'sourcetype' => [ + 'yoyTimeValue' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'triggers' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetMultiTrigger', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"CloudMonitor"', - 'backendName' => 'sourcetype', + 'example' => '', ], + 'enableSeveritySuppression' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'legacyRaw' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], 'ContactForIncidentView' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => '', - 'visibility' => 'Public', + 'contactId' => ['description' => 'The contact ID.', 'type' => 'string', 'title' => '', 'example' => '"contact-123456"'], + 'name' => ['description' => 'The contact name.', 'type' => 'string', 'title' => '', 'example' => '"张三"'], + ], + 'description' => 'The contact object.', + 'title' => '', + 'example' => '', + ], + 'CustomExtractionStrategy' => [ + 'type' => 'object', + 'properties' => [ + 'strategyName' => ['description' => 'Policy Name', 'type' => 'string', 'title' => '', 'example' => 'test1'], + 'strategyType' => ['description' => 'Policy type. Supports "Episodic", "Summary", and "Fact".', 'type' => 'string', 'title' => '', 'example' => 'Fact'], + 'extractionPrompt' => ['description' => 'Extraction prompt', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'updatePrompt' => ['description' => 'Update prompt', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'description' => ['description' => 'Description', 'type' => 'string', 'title' => '', 'example' => 'test'], + ], + 'description' => 'Custom extraction policy', + 'title' => '', + 'example' => '', + ], + 'DatasourceConfigUnified' => [ + 'description' => 'Specifies the configuration for a unified data source.', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The type of the data source.', 'type' => 'string', - 'example' => '"contact-123456"', - 'backendName' => 'contactId', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['PROMETHEUS', 'UMODEL', 'APM', 'CLOUD_MONITORING', 'UNKNOWN'], ], - 'name' => [ - 'description' => '', - 'visibility' => 'Public', + 'instanceId' => ['description' => 'The unique instance ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'productCategory' => ['description' => 'The product category of the data source.', 'type' => 'string', 'title' => '', 'example' => ''], + 'legacyType' => ['description' => 'The legacy type of the data source, used for backward compatibility.', 'type' => 'string', 'title' => '', 'example' => ''], + 'legacyRaw' => ['description' => 'The raw string value of the legacy configuration, used for backward compatibility.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DatasourceTypeFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '', 'description' => 'Specifies the data source type for an exact match.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'A filter for the data source type.', + 'example' => '', + ], + 'DirectNotifyChannel' => [ + 'description' => 'Defines the configuration for a direct notification channel.', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The notification channel type. For example, `sms` or `email`.', 'type' => 'string', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['CONTACT', 'GROUP', 'DINGTALK', 'FEISHU', 'SLACK', 'WEIXIN', 'WEBHOOK'], + ], + 'identifiers' => [ + 'description' => 'An array of recipient identifiers. The format of each identifier depends on the `type`. For example, if `type` is `email`, the identifiers are email addresses.', + 'type' => 'array', + 'items' => ['description' => 'A recipient identifier, such as a phone number or an email address.', 'type' => 'string', 'title' => '', 'example' => ''], + 'required' => true, + 'title' => '', 'example' => '', - 'backendName' => 'name', ], ], + 'title' => '', + 'example' => '', + ], + 'DisplayNameFilter' => [ + 'description' => 'Filters resources by their display name.', + 'type' => 'object', + 'properties' => [ + 'contains' => ['description' => 'Returns only resources whose display name contains the specified string. The match is case-sensitive.', 'type' => 'string', 'title' => '', 'example' => ''], + 'notContains' => ['description' => 'Returns only resources whose display name does not contain the specified string. The match is case-sensitive.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], 'EffectTimeRange' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'dayInWeek' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '[1, 2, 3]', - 'extendType' => 'true', - ], - 'backendName' => 'dayInWeek', - ], - 'startTimeInMinute' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '360', - 'backendName' => 'startTimeInMinute', - ], - 'endTimeInMinute' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1080', - 'backendName' => 'endTimeInMinute', - ], - 'timeZone' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Asia/Shanghai"', - 'backendName' => 'timeZone', + 'items' => ['description' => 'The values 0 to 6 indicate Sunday to Saturday.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '[1, 2, 3]'], + 'description' => 'The values 0 to 6 indicate Sunday to Saturday.', + 'title' => '', + 'example' => '', ], + 'startTimeInMinute' => ['description' => 'The start time in minutes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '360'], + 'endTimeInMinute' => ['description' => 'The end time in minutes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1080'], + 'timeZone' => ['description' => 'The time zone.', 'type' => 'string', 'title' => '', 'example' => '"Asia/Shanghai"'], + ], + 'description' => 'The configuration of the effective time range.', + 'title' => '', + 'example' => '', + ], + 'EnabledFilter' => [ + 'description' => 'A filter for querying resources by their enabled state.', + 'type' => 'object', + 'properties' => [ + 'eq' => ['description' => 'The value to filter by. Set to `true` to return only enabled resources. Set to `false` to return only disabled resources.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'EntityDiscoverRule' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The entity discovery rule model.', 'type' => 'object', 'properties' => [ + 'resourceGroupId' => ['title' => '资源组ID。', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm2m7atreujs1'], 'ipMatchRule' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', + 'title' => 'IP 匹配规则', + 'description' => 'A collection of IP address matching rules.', + 'type' => 'object', 'items' => [ - 'title' => '', - 'description' => '', + 'title' => 'IP匹配规则。', + 'description' => 'IP匹配规则。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ipFieldKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hostIp', - 'backendName' => 'ipFieldKey', - ], - 'ipCIDR' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '192.168.0.1/10', - 'backendName' => 'ipCIDR', - ], + 'ipFieldKey' => ['title' => 'IP字段的Key。', 'description' => 'IP字段的Key。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'hostIp', 'backendName' => 'ipFieldKey'], + 'ipCIDR' => ['title' => 'IP的CIDR。', 'description' => 'IP的CIDR。', 'visibility' => 'Public', 'type' => 'string', 'example' => '192.168.0.1/10', 'backendName' => 'ipCIDR'], ], 'extendType' => 'true', ], - 'backendName' => 'ipMatchRule', + 'example' => '', + 'properties' => [ + 'ipFieldKey' => ['title' => 'IP 的属性 Key', 'type' => 'string', 'description' => '', 'example' => ''], + 'ipCIDR' => ['title' => 'IP 的网段 CIDR', 'type' => 'string', 'description' => '', 'example' => ''], + ], ], - 'instanceIds' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'tags' => [ + 'title' => '通过Tag进行服务发现。', + 'description' => 'The tag-based service discovery rules.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2', - 'extendType' => 'true', + 'title' => '使用Tag的发现信息。', + 'description' => 'The details of a tag-based discovery rule.', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => 'Tag的Key。', 'description' => 'The key of the tag.', 'type' => 'string', 'example' => 'project'], + 'op' => ['title' => '操作。', 'description' => 'The operation.', 'type' => 'string', 'example' => 'in'], + 'tagValues' => [ + 'title' => 'Tag的值集合。', + 'description' => 'A collection of tag values.', + 'type' => 'array', + 'items' => ['title' => 'Tag的值。', 'description' => 'A tag value.', 'type' => 'string', 'example' => 'demo'], + 'example' => '', + ], + ], + 'example' => '', ], - 'backendName' => 'instanceIds', + 'example' => '', ], - 'fieldRules' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'instanceIds' => [ + 'title' => '实例ID集合。', + 'description' => 'A collection of instance IDs.', + 'type' => 'array', + 'items' => ['title' => '实例ID。', 'description' => 'An instance ID.', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'], + 'example' => '', + ], + 'entityTypes' => [ + 'title' => '实体类型集合。', + 'description' => 'A collection of entity types.', + 'type' => 'array', + 'items' => ['title' => '实体类型。', 'description' => 'An entity type.', 'type' => 'string', 'example' => 'acs.ecs.instance'], + 'example' => '', + ], + 'regionIds' => [ + 'title' => '地域ID集合。', + 'description' => 'A collection of region IDs.', + 'type' => 'array', + 'items' => ['title' => '地域ID。', 'description' => 'A region ID.', 'type' => 'string', 'example' => 'cn-shanghai'], + 'example' => '', + ], + 'labels' => [ + 'title' => '标签匹配集合。', + 'description' => 'A collection of label matching rules.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '标签详情。', + 'description' => 'The label details.', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'in', - 'backendName' => 'op', - ], - 'fieldKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'fieldKey', - ], - 'fieldValues' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'tagKey' => ['title' => '标签的Key。', 'description' => 'The key of the label.', 'type' => 'string', 'example' => 'project'], + 'op' => ['title' => '操作。', 'description' => 'The operation.', 'type' => 'string', 'example' => 'in'], + 'tagValues' => [ + 'title' => '标签的值集合。', + 'description' => 'A collection of label values.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2', - 'extendType' => 'true', - ], - 'backendName' => 'fieldValues', + 'items' => ['title' => '标签的值。', 'description' => 'A label value.', 'type' => 'string', 'example' => 'demo'], + 'example' => '', ], ], - 'extendType' => 'true', + 'example' => '', ], - 'backendName' => 'fieldRules', + 'example' => '', ], 'annotations' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '注解匹配集合。', + 'description' => 'A collection of annotation matching rules.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '注解详情。', + 'description' => 'The annotation details.', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'in', - 'backendName' => 'op', - ], - 'tagKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'tagKey', - ], + 'tagKey' => ['title' => '注解的Key。', 'description' => 'The key of the annotation.', 'type' => 'string', 'example' => 'instanceId'], + 'op' => ['title' => '操作。', 'description' => 'The operation.', 'type' => 'string', 'example' => 'in'], 'tagValues' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '注解的值集合。', + 'description' => 'A collection of annotation values.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'i-bp1gj8wyq4fxk28k6iy2'."\n", - 'extendType' => 'true', - ], - 'backendName' => 'tagValues', + 'items' => ['title' => '注解的值。', 'description' => 'An annotation value.', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'."\n"], + 'example' => '', ], ], - 'extendType' => 'true', + 'example' => '', ], - 'backendName' => 'annotations', - ], - 'resourceGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rg-acfm2m7atreujs1', - 'backendName' => 'resourceGroupId', + 'example' => '', ], - 'entityTypes' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'fieldRules' => [ + 'title' => '属性匹配规则。', + 'description' => 'The property matching rules.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs.ecs.instance', - 'extendType' => 'true', + 'title' => '属性详情。', + 'description' => 'The property details.', + 'type' => 'object', + 'properties' => [ + 'fieldKey' => ['title' => '属性的Key。', 'description' => 'The key of the property.', 'type' => 'string', 'example' => 'instanceId'], + 'op' => ['title' => '操作。', 'description' => 'The operation.', 'type' => 'string', 'example' => 'in'], + 'fieldValues' => [ + 'title' => '属性的值集合。', + 'description' => 'A collection of property values.', + 'type' => 'array', + 'items' => ['title' => '属性的值。', 'description' => 'A property value.', 'type' => 'string', 'example' => 'i-bp1gj8wyq4fxk28k6iy2'], + 'example' => '', + ], + ], + 'example' => '', ], - 'backendName' => 'entityTypes', + 'example' => '', ], - 'regionIds' => [ - 'title' => '', - 'description' => '', + ], + 'title' => '', + 'example' => '', + ], + 'EntityGroupBase' => [ + 'title' => '实体的基础结构。', + 'description' => 'The base structure for an entity.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间。', 'description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'default-cms-1654218***343050-cn-hangzhou'], + 'regionId' => ['title' => '地域ID。', 'description' => 'The region ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'regionId', 'example' => 'cn-heyuan'], + 'entityQueries' => [ + 'title' => '实体查询规则集合。', + 'description' => 'A collection of entity query rules.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', + 'title' => '实体查询规则。', + 'description' => 'An entity query rule.', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-shanghai', + 'type' => 'object', + 'properties' => [ + 'entityType' => ['title' => '实体类型。', 'description' => 'The entity type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'entityType', 'example' => 'acs.ecs.instance'], + 'spl' => ['title' => 'SPL查询语句。', 'description' => 'The Structured Process Language (SPL) search statement.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'spl', 'example' => '.entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')'], + ], 'extendType' => 'true', + 'example' => '', ], - 'backendName' => 'regionIds', + 'backendName' => 'entityQueries', + 'example' => '', ], - 'tags' => [ + 'description' => ['title' => '实体描述。', 'description' => 'The entity description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'ECS 实例'], + 'entityGroupId' => ['title' => '实体ID。', 'description' => 'The entity ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'entityGroupId', 'example' => 'eg-1234567890'], + 'entityRules' => ['title' => '用于实体发现的规则。', 'description' => 'The rule for entity discovery.', 'visibility' => 'Public', 'backendName' => 'entityRules', '$ref' => '#/components/schemas/EntityDiscoverRule', 'example' => ''], + 'entityGroupName' => ['title' => '实体名称。', 'description' => 'The entity name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'entityGroupName', 'example' => 'ECS 全部实体'], + 'userId' => ['title' => '用户ID。', 'description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'example' => '1654218***343050'], + ], + 'example' => '', + ], + 'Evaluator' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'resultName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'resultType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'config' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'filters' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', 'title' => '', + 'example' => '', + ], + 'variableMapping' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'in', - 'backendName' => 'op', - ], - 'tagKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'project', - 'backendName' => 'tagKey', - ], - 'tagValues' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'demo', - 'extendType' => 'true', - ], - 'backendName' => 'tagValues', - ], - ], - 'extendType' => 'true', - ], - 'backendName' => 'tags', - ], - 'labels' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'in', - 'backendName' => 'op', - ], - 'tagKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'project', - 'backendName' => 'tagKey', - ], - 'tagValues' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'demo', - 'extendType' => 'true', - ], - 'backendName' => 'tagValues', - ], - ], - 'extendType' => 'true', - ], - 'backendName' => 'labels', + 'example' => '', ], ], - ], - 'EntityGroupBase' => [ - 'title' => '', 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'example' => '', + ], + 'EventResourceForEventView' => [ 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'default-cms-1654218***343050-cn-hangzhou', - 'backendName' => 'workspace', - ], - 'regionId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'backendName' => 'regionId', - ], - 'entityQueries' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'entityType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs.ecs.instance', - 'backendName' => 'entityType', - ], - 'spl' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '.entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')', - 'backendName' => 'spl', - ], - ], - 'extendType' => 'true', + 'entity' => [ + 'type' => 'object', + 'properties' => [ + 'domain' => ['description' => 'The product domain to which the resource belongs.', 'type' => 'string', 'title' => '', 'example' => '"ECS"'], + 'entityType' => ['description' => 'The specific type of the resource.', 'type' => 'string', 'title' => '', 'example' => '"Instance"'], + 'entityId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => '"i-bp123456"'], + 'prop' => ['description' => 'Extra properties of the resource.', 'type' => 'object', 'title' => '', 'example' => '{ "name": "web-server-01", "ip": "10.0.0.1" }'], ], - 'backendName' => 'entityQueries', - ], - 'description' => [ + 'description' => 'The resource entity.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', 'example' => '', - 'backendName' => 'description', - ], - 'entityGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eg-1234567890', - 'backendName' => 'entityGroupId', ], - 'entityRules' => [ - 'title' => '', + 'tags' => ['description' => 'The tags.', 'type' => 'object', 'title' => '', 'example' => '{ "env": "prod", "project": "payment-gateway" }'], + ], + 'description' => 'The resource display object.', + 'title' => '', + 'example' => '', + ], + 'EventResourceForIncidentView' => [ + 'type' => 'object', + 'properties' => [ + 'tags' => ['description' => 'The tags.', 'type' => 'string', 'title' => '', 'example' => '[{\\"value\\":\\"测试\\",\\"key\\":\\"环境\\"}]'], + 'probs' => ['description' => 'The string that describes the properties of the resource.', 'type' => 'string', 'title' => '', 'example' => '"{"name":"web-server-01","ip":"10.0.0.1"}"'], + 'entityType' => ['description' => 'The entity type.', 'type' => 'string', 'title' => '', 'example' => '"Instance"'], + 'entityId' => ['description' => 'The entity ID.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'domain' => ['description' => 'The domain of the resource type.', 'type' => 'string', 'title' => '', 'example' => 'rum'], + ], + 'description' => 'The resource associated with the event.', + 'title' => '', + 'example' => '', + ], + 'ExperimentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'label' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'modelName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'modelProvider' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'modelParameters' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ModelParameters'], + 'endpointConnectorId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'promptTemplate' => [ + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/PromptTemplateItem'], 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'entityRules', - '$ref' => '#/components/schemas/EntityDiscoverRule', - ], - 'entityGroupName' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', 'example' => '', - 'backendName' => 'entityGroupName', - ], - 'userId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1654218***343050', - 'backendName' => 'userId', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'EventResourceForEventView' => [ + 'ExperimentPlanData' => [ + 'type' => 'object', + 'properties' => [ + 'planId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'planName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'datasetId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'experimentCount' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'createdAt' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'updatedAt' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + ], 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'example' => '', + ], + 'ExperimentRecord' => [ 'type' => 'object', 'properties' => [ - 'entity' => [ + 'planId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'experimentName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'totalTasks' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'failedTasks' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'completedTasks' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'progress' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'executedAt' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'completedAt' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'datasetId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'planName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'recordId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'experimentConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ExperimentConfig'], + 'dataSourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'modelName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'errorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'datasetProject' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'evaluators' => [ + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Evaluator'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'domain' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ECS"', - 'backendName' => 'domain', - ], - 'entityType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Instance"', - 'backendName' => 'entity_type', - ], - 'entityId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"i-bp123456"', - 'backendName' => 'entity_id', - ], - 'prop' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "name": "web-server-01", "ip": "10.0.0.1" }', - 'backendName' => 'prop', - ], - ], - 'backendName' => 'entity', + 'title' => '', + 'example' => '', ], - 'tags' => [ + 'input' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'selectedItemIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "env": "prod", "project": "payment-gateway" }', - 'backendName' => 'tags', + 'title' => '', + 'example' => '', ], ], - ], - 'EventResourceForIncidentView' => [ 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'example' => '', + ], + 'Filter' => [ + 'description' => 'The fields in this filter are combined with a logical AND.', 'type' => 'object', 'properties' => [ - 'tags' => [ - 'description' => '', - 'visibility' => 'Public', + 'uuid' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UuidFilter'], + 'displayName' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DisplayNameFilter'], + 'labels' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LabelsFilter'], + 'status' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/StatusFilter'], + 'enabled' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/EnabledFilter'], + ], + 'title' => '', + 'example' => '', + ], + 'FilterCondition' => [ + 'title' => '过滤条件', + 'description' => 'A field/op/value triplet for event filtering.', + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '字段名', 'description' => 'The name of the field to filter on.', 'type' => 'string', 'example' => ''], + 'op' => [ + 'title' => '操作符', + 'description' => 'The comparison operator, such as `equals` or `startsWith`.', 'type' => 'string', 'example' => '', - 'backendName' => 'tags', - ], - 'probs' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"{"name":"web-server-01","ip":"10.0.0.1"}"', - 'backendName' => 'prons', - ], - 'entityType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Instance"', - 'backendName' => 'entityType', - ], - 'entityId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'default', - 'backendName' => 'entityId', - ], - 'domain' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum', - 'backendName' => 'domain', + 'enum' => ['EQ', 'EQI', 'START_WITH', 'END_WITH', 'CONTAIN', 'NOT_CONTAIN', 'IN', 'NOT_IN', 'KEYWORD', 'KEYWORD_ALL_MATCH', 'KEYWORD_NOT_MATCH', 'INTERSECT', 'NOT_INTERSECT', 'PATTERN', 'PATTERN_ALL_MATCH', 'PATTERN_NOT_IN', 'EXIST'], ], + 'value' => ['title' => '比较值', 'description' => 'The value to match for the specified field and operator.', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], 'FilterSetting' => [ - 'description' => '', + 'description' => 'The filter configuration.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'expression' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1 and 2 or 3', - 'backendName' => 'expression', - ], + 'expression' => ['title' => '表达式', 'description' => 'The expression.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'expression', 'example' => '1 and 2 or 3'], 'conditions' => [ - 'title' => '', - 'description' => '', + 'title' => '订阅条件', + 'description' => 'The subscription conditions.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A single condition.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'op' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'EQ', - 'backendName' => 'op', - ], - 'field' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'severity', - 'backendName' => 'field', - ], - 'value' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'CRITICAL', - 'backendName' => 'value', - ], + 'op' => ['title' => '比较符', 'description' => 'The comparison operator.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'op', 'example' => 'EQ'], + 'field' => ['title' => '字段', 'description' => 'The field.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'field', 'example' => 'severity'], + 'value' => ['title' => '值', 'description' => 'The value.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'example' => 'CRITICAL'], ], 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'maxItems' => 10, 'backendName' => 'conditions', + 'example' => '', ], - 'relation' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'AND', - 'backendName' => 'relation', - ], + 'relation' => ['title' => '条件间关系', 'description' => 'The relationship between conditions.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'relation', 'example' => 'AND'], ], + 'title' => '', + 'example' => '', ], 'IncidentContactStruct' => [ - 'description' => 'Event Contact Structure.', - 'visibility' => 'Public', + 'description' => 'The event contact structure.', 'type' => 'object', 'properties' => [ - 'contactId' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '627415', - 'backendName' => 'contactId', - ], + 'contactId' => ['description' => 'The contact ID.', 'type' => 'string', 'title' => '', 'example' => '627415', 'visibility' => 'Public', 'backendName' => 'contactId'], 'channel' => [ - 'description' => 'Channel list.', - 'visibility' => 'Public', + 'description' => 'The channel list.', 'type' => 'array', - 'items' => [ - 'description' => 'Channel name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs', - 'extendType' => 'true', - ], - 'backendName' => 'channel', - ], - 'contactType' => [ - 'description' => 'Contact type.', + 'items' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'ecs', 'visibility' => 'Public', 'extendType' => 'true'], + 'title' => '', + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GROUP', - 'backendName' => 'contactType', + 'backendName' => 'channel', ], + 'contactType' => ['description' => 'The contact type.', 'type' => 'string', 'title' => '', 'example' => 'GROUP', 'visibility' => 'Public', 'backendName' => 'contactType'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'IncidentEscalationPolicyForModify' => [ 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The entity to view.', 'type' => 'object', 'properties' => [ - 'description' => [ + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace api monitor create test'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'name' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '"Critical-Alert-Escalation"'], + 'escalationStageList' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of escalation stages. This list defines multiple progressive escalation steps. Each stage contains trigger conditions and notification targets.', '$ref' => '#/components/schemas/IncidentEscalationStageForView', 'title' => '', 'example' => ''], + 'description' => 'The list of escalation stages. This list defines multiple progressive escalation steps. Each stage contains trigger conditions and notification targets.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace api monitor create test', - 'backendName' => 'description', + 'example' => '', ], - 'enable' => [ + ], + 'example' => '', + ], + 'IncidentEscalationPolicyForView' => [ + 'title' => 'A short description of struct', + 'description' => 'The entity for viewing.', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace api monitor update test'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'name' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '"Critical-Alert-Escalation"'], + 'updateTime' => ['title' => '更新时间', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-04-15T02:02:50Z'], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'type' => 'string', 'example' => '"user-abc123"'], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'type' => 'string', 'example' => '"ws-xyz789"'], + 'ownerType' => ['description' => 'The owner type.'."\n" + ."\n" + .'- **USER**: User. This is the default value.'."\n" + ."\n" + .'- **APP**: Application.', 'type' => 'string', 'title' => '', 'example' => '"USER"'], + 'source' => ['description' => 'The source.', 'type' => 'string', 'title' => '', 'example' => '"MANUAL"'], + 'syncFromType' => ['description' => 'The source type of the synchronization policy.', 'type' => 'string', 'title' => '', 'example' => '"ARMS"'], + 'uuid' => ['description' => 'The globally unique identifier.', 'type' => 'string', 'title' => '', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => '"cn-hangzhou"'], + 'escalationStageList' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of escalation stages.', '$ref' => '#/components/schemas/IncidentEscalationStageForView', 'title' => '', 'example' => ''], + 'description' => 'The list of escalation stages.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', + 'example' => '', ], - 'name' => [ + ], + 'example' => '', + ], + 'IncidentEscalationStageForView' => [ + 'type' => 'object', + 'properties' => [ + 'cycleNotifyInterval' => ['description' => 'The loop notification interval.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], + 'cycleNotifyCount' => ['description' => 'The number of loop notifications.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'triggerDelay' => ['description' => 'The trigger delay time.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], + 'effectTimeRange' => ['description' => 'The effective time range.', '$ref' => '#/components/schemas/EffectTimeRange', 'title' => '', 'example' => ''], + 'targetIncidentState' => ['description' => 'The target event state.', 'type' => 'string', 'title' => '', 'example' => '"Open"'], + 'index' => ['description' => 'The stage index.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], + 'notifyChannels' => [ + 'type' => 'array', + 'items' => ['description' => 'The notification channel.', '$ref' => '#/components/schemas/NotifyChannel', 'title' => '', 'example' => ''], + 'description' => 'The list of notification channels.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '"Critical-Alert-Escalation"', - 'backendName' => 'name', + 'example' => '', ], - 'escalationStageList' => [ - 'description' => '', + ], + 'description' => 'The escalation stage object.', + 'title' => '', + 'example' => '', + ], + 'IncidentEscalationStageStruct' => [ + 'description' => 'The event escalation stage structure.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'stageIndex' => ['description' => 'The stage index.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'index', 'title' => '', 'example' => '1'], + 'cycleNotifyTime' => ['description' => 'The notification interval.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'cycleNotifyTime', 'title' => '', 'example' => '300'], + 'contact' => [ + 'description' => 'The list of contacts.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationStageForView', - ], - 'backendName' => 'escalationStageList', + 'items' => ['description' => 'The event contact struct.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentContactStruct', 'title' => '', 'example' => ''], + 'backendName' => 'contactList', + 'title' => '', + 'example' => '', ], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '运维团队'], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '负责处理生产环境告警的主负责人'], + 'timeZone' => ['description' => 'The time zone.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'timeZone', 'title' => '', 'example' => 'Asia/Shanghai'], + 'effectTime' => ['description' => 'The effective time.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'effectTime', 'title' => '', 'example' => '2025-04-05T00:00:00Z'], + 'waitToNextStageTime' => ['description' => 'The waiting time before the next stage begins.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'waitToNextStageTime', 'title' => '', 'example' => '600'], + 'cycleNotifyCount' => ['description' => 'The number of notifications sent per cycle.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'cycleNotifyCount', 'title' => '', 'example' => '3'], ], + 'title' => '', + 'example' => '', ], - 'IncidentEscalationPolicyForView' => [ - 'title' => 'A short description of struct', - 'description' => '', + 'IncidentEscalationStruct' => [ + 'description' => 'The event escalation structure.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', - ], - 'description' => [ - 'title' => '', - 'description' => '', + 'incidentEscalationId' => ['description' => 'The ID of the event escalation.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'uuid', 'title' => '', 'example' => '52631388567'], + 'workspace' => ['description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'title' => '', 'example' => 'workspace-test'], + 'modifyTime' => ['description' => 'The time when the event escalation was last modified.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'gmtModified', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'stage' => [ + 'description' => 'The stages.', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace api monitor update test', - 'backendName' => 'description', - ], - 'enable' => [ + 'type' => 'array', + 'items' => ['description' => 'The event escalation stage struct.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStageStruct', 'title' => '', 'example' => ''], + 'backendName' => 'stageList', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', + 'example' => '', ], - 'name' => [ + 'createTime' => ['description' => 'The time when the event escalation was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'regionId' => ['description' => 'The region ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'regionId', 'title' => '', 'example' => 'cn-hangzhou'], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '生产环境告警升级策略'], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '当告警未响应时，依次通知运维团队、值班经理、CTO'], + ], + 'title' => '', + 'example' => '', + ], + 'IncidentEventForView' => [ + 'type' => 'object', + 'properties' => [ + 'incidentUuid' => ['description' => 'The unique ID of the incident to which the event belongs.', 'type' => 'string', 'title' => '', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'userId' => ['description' => 'The ID of the user who created or triggered the event.', 'type' => 'string', 'title' => '', 'example' => '"user-abc123"'], + 'time' => ['description' => 'The UNIX timestamp when the event occurred.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876000000'], + 'incidentEventUuid' => ['description' => 'The unique ID of the event.', 'type' => 'string', 'title' => '', 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"'], + 'title' => ['description' => 'The title of the event.', 'type' => 'string', 'title' => '', 'example' => '"ECS 实例 i-bp123456 CPU 使用率超过 90%"'], + 'workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => '"ws-xyz789"'], + 'dimension' => ['description' => 'The dimension information of the event.', 'type' => 'object', 'title' => '', 'example' => '{ "env": "prod", "module": "payment" }'], + 'labels' => ['description' => 'The key-value pairs of custom tags.', 'type' => 'object', 'title' => '', 'example' => '{ "project": "payment-gateway", "owner": "ops-team" }'], + 'groupBy' => ['description' => 'The criteria for grouping.', 'type' => 'object', 'title' => '', 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }'], + 'eventResource' => ['description' => 'The information about the associated resource.', '$ref' => '#/components/schemas/EventResourceForIncidentView', 'title' => '', 'example' => ''], + 'content' => ['description' => 'The details of the event.', '$ref' => '#/components/schemas/CmsEventForView', 'title' => '', 'example' => ''], + 'severity' => ['description' => 'The severity level of the event.', 'type' => 'string', 'title' => '', 'example' => '"Critical"'], + 'count' => ['description' => 'The number of times the event was triggered.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'severityCountMap' => ['description' => 'The statistics on the number of events for each severity level.', 'type' => 'object', 'title' => '', 'example' => '{ "Critical": 2, "High": 1 }'], + 'lastTime' => ['description' => 'The UNIX timestamp of the last occurrence.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876000000'], + 'recoverTime' => ['description' => 'The UNIX timestamp of the recovery.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876600000'], + 'autoRecoverTime' => ['description' => 'The UNIX timestamp of the automatic recovery.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876600000'], + 'state' => ['description' => 'The current status code of the event.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'searchIndex' => [ + 'type' => 'array', + 'items' => ['description' => 'The search index field.', 'type' => 'string', 'title' => '', 'example' => '["ECS", "CPU", "high"]'], + 'description' => 'The list of search index fields.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '"Critical-Alert-Escalation"', - 'backendName' => 'name', + 'example' => '', ], - 'updateTime' => [ - 'title' => '', - 'description' => '', + 'textIndex' => ['description' => 'The text index field.', 'type' => 'string', 'title' => '', 'example' => '"ECS 实例 CPU 使用率过高"'], + ], + 'description' => 'The event object.', + 'title' => '', + 'example' => '', + ], + 'IncidentEventStruct' => [ + 'description' => 'The structure of an incident event.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'lastTime' => ['description' => 'The time of the last occurrence.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'lastTime', 'title' => '', 'example' => '1741234567890'], + 'recoverTime' => ['description' => 'The time of manual recovery.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'recoverTime', 'title' => '', 'example' => '1741234567890'], + 'autoRecoverTime' => ['description' => 'The time of automatic recovery.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'autoRecoverTime', 'title' => '', 'example' => '1741234567890'], + 'resource' => [ + 'description' => 'The resource associated with the event.', 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-15T02:02:50Z', - 'backendName' => 'updateTime', - ], - 'userId' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A map.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => 'map'], + 'backendName' => 'resource', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"user-abc123"', - 'backendName' => 'userId', + 'example' => '', ], - 'workspace' => [ - 'title' => 'workspace', - 'description' => '', + 'count' => ['description' => 'The total count.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'count', 'title' => '', 'example' => '6'], + 'groupBy' => [ + 'description' => 'The dimension for grouping.', 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A map.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => 'map'], + 'backendName' => 'groupBy', + 'title' => '', + 'example' => '', ], - 'ownerType' => [ - 'description' => '', + 'title' => ['description' => 'The title.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'title', 'title' => '', 'example' => '用户服务 CPU 使用率过高'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'title' => '', 'example' => 'user-12345'], + 'content' => ['description' => 'The content.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'content', 'title' => '', 'example' => '检测到 user-service 实例 i-abc123 的 CPU 使用率达到 95%，已触发告警。'], + 'time' => ['description' => 'The time.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'time', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'incidentId' => ['description' => 'The incident ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentId', 'title' => '', 'example' => 'incident-001'], + 'incidentEventId' => ['description' => 'The incident event ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentEventUuid', 'title' => '', 'example' => 'event-001'], + 'dimension' => [ + 'description' => 'The dimension.', 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"USER"', - 'backendName' => 'ownerType', + 'type' => 'object', + 'additionalProperties' => ['description' => 'A map.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => 'map'], + 'backendName' => 'dimension', + 'title' => '', + 'example' => '', ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"MANUAL"', - 'backendName' => 'source', + 'status' => ['description' => 'The status.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'status', 'title' => '', 'example' => 'Running'], + ], + 'title' => '', + 'example' => '', + ], + 'IncidentForView' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The details of the incident.', 'type' => 'string', 'title' => '', 'example' => '"{"description":"ECS实例CPU过高","impact":"支付服务延迟"}"'], + 'incidentId' => ['description' => 'The unique identifier of the incident.', 'type' => 'string', 'title' => '', 'example' => '"incident-abc123"'], + 'plan' => ['description' => 'The response plan.', '$ref' => '#/components/schemas/IncidentResponsePlanForView', 'title' => '', 'example' => ''], + 'severity' => ['description' => 'The severity level of the incident.', 'type' => 'string', 'title' => '', 'example' => '"Critical"'], + 'time' => ['description' => 'The timestamp when the incident was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876000000'], + 'title' => ['description' => 'The title of the incident.', 'type' => 'string', 'title' => '', 'example' => '"支付服务不可用"'], + 'userId' => ['description' => 'The ID of the user who created the incident.', 'type' => 'string', 'title' => '', 'example' => '"user-abc123"'], + 'workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => '"ws-xyz789"'], + 'groupUuid' => ['description' => 'The group identifier.', 'type' => 'string', 'title' => '', 'example' => '"group-123456"'], + 'state' => ['description' => 'The current state of the incident.', 'type' => 'string', 'title' => '', 'example' => '"Open"'], + 'notifyStrategyUuid' => ['description' => 'The UUID of the associated notification policy, which is used to trigger notifications.', 'type' => 'string', 'title' => '', 'example' => '"notify-strategy-789"'], + 'subscriptionUuid' => ['description' => 'The UUID of the subscription policy.', 'type' => 'string', 'title' => '', 'example' => '"subscription-abc"'], + 'operator' => ['description' => 'The information about the operator.', '$ref' => '#/components/schemas/ContactForIncidentView', 'title' => '', 'example' => ''], + 'notifyStrategyName' => ['description' => 'The name of the notification policy.', 'type' => 'string', 'title' => '', 'example' => '{ "contactId": "contact-123", "name": "张三" }'], + 'subscriptionName' => ['description' => 'The name of the subscription policy.', 'type' => 'string', 'title' => '', 'example' => '"P1-Alert-Notification"'], + 'escalations' => [ + 'type' => 'array', + 'items' => ['description' => 'The escalation policy.', '$ref' => '#/components/schemas/IncidentEscalationPolicyForView', 'title' => '', 'example' => ''], + 'description' => 'The list of escalation policies.', + 'title' => '', + 'example' => '', ], - 'syncFromType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ARMS"', - 'backendName' => 'syncFromType', + 'owners' => [ + 'type' => 'array', + 'items' => ['description' => 'The owner.', '$ref' => '#/components/schemas/ContactForIncidentView', 'title' => '', 'example' => ''], + 'description' => 'The list of owners.', + 'title' => '', + 'example' => '', ], - 'uuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - 'backendName' => 'uuid', + 'participants' => [ + 'type' => 'array', + 'items' => ['description' => 'The participant.', '$ref' => '#/components/schemas/ContactForIncidentView', 'title' => '', 'example' => ''], + 'description' => 'The list of participants.', + 'title' => '', + 'example' => '', ], - 'regionId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"cn-hangzhou"', - 'backendName' => 'regionId', + 'groupingKeys' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The key-value pairs for grouping.', 'type' => 'string', 'title' => '', 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }'], + 'description' => 'The key-value pairs for grouping.', + 'title' => '', + 'example' => '', ], - 'escalationStageList' => [ - 'description' => '', - 'visibility' => 'Public', + 'relatedResources' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationStageForView', - ], - 'backendName' => 'escalationStageList', + 'items' => ['description' => 'The associated resource.', '$ref' => '#/components/schemas/EventResourceForIncidentView', 'title' => '', 'example' => ''], + 'description' => 'The list of associated resources.', + 'title' => '', + 'example' => '', ], + 'solution' => ['description' => 'The description of the solution.', 'type' => 'string', 'title' => '', 'example' => '"重启ECS实例后恢复正常"'], + 'rootCauseCategory' => ['description' => 'The root cause category.', 'type' => 'string', 'title' => '', 'example' => '"Network"'], ], + 'description' => 'The incident object.', + 'title' => '', + 'example' => '', ], - 'IncidentEscalationStageForView' => [ - 'description' => '', + 'IncidentMemberStruct' => [ + 'description' => 'The structure of an event member.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'cycleNotifyInterval' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'cycleNotifyInterval', - ], - 'cycleNotifyCount' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'cycleNotifyCount', - ], - 'triggerDelay' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'triggerDelay', - ], - 'effectTimeRange' => [ - 'description' => '', + 'acknowledge' => [ + 'description' => 'The structure of the confirmation information.', 'visibility' => 'Public', - 'backendName' => 'effectTimeRange', - '$ref' => '#/components/schemas/EffectTimeRange', + 'type' => 'object', + 'properties' => [ + 'breakLevel' => ['description' => 'The confirmation level.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'breakLevel', 'title' => '', 'example' => '2'], + 'verifyTime' => ['description' => 'The verification time.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'verifyTime', 'title' => '', 'example' => '1741234567890'], + ], + 'backendName' => 'acknowledge', + 'title' => '', + 'example' => '', ], - 'targetIncidentState' => [ - 'description' => '', + 'incidentMemberId' => ['description' => 'The ID of the event member.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentItemToken', 'title' => '', 'example' => 'member-001'], + 'contactId' => ['description' => 'The ID of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contactId', 'title' => '', 'example' => 'user-12345'], + 'escalation' => [ + 'description' => 'Information about the escalation stage.', 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Open"', - 'backendName' => 'targetIncidentState', + 'type' => 'object', + 'properties' => [ + 'stageIndex' => ['description' => 'The index of the escalation stage.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'stageIndex', 'title' => '', 'example' => '1'], + 'incidentEscalationId' => ['description' => 'The ID of the event escalation.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'escalationId', 'title' => '', 'example' => 'escalation-001'], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '第一阶段'], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '通知运维团队'], + 'title' => ['description' => 'The title.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'title', 'title' => '', 'example' => '告警升级至运维团队'], + ], + 'backendName' => 'escalation', + 'title' => '', + 'example' => '', ], - 'index' => [ - 'description' => '', + 'scheduleGroup' => [ + 'description' => 'The scheduling group.', 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'backendName' => 'index', + 'type' => 'object', + 'properties' => [ + 'contactId' => ['description' => 'The ID of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contactId', 'title' => '', 'example' => 'group-001'], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '夜间值班组'], + ], + 'backendName' => 'schedule', + 'title' => '', + 'example' => '', ], - 'notifyChannels' => [ - 'description' => '', + 'time' => ['description' => 'The time.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '2025-10-08 10:18:58'], + 'incidentId' => ['description' => 'The ID of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'userId', 'title' => '', 'example' => '4123456'], + 'contacts' => [ + 'description' => 'A list of contacts.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of a contact.', 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'contactMask' => ['description' => 'The masked ID of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contactMask', 'title' => '', 'example' => 'user-12345'], + 'channel' => ['description' => 'The channel.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'channel', 'title' => '', 'example' => 'dingtalk'], + ], 'extendType' => 'true', - '$ref' => '#/components/schemas/NotifyChannel', + 'title' => '', + 'example' => '', ], - 'backendName' => 'notifyChannels', + 'backendName' => 'contacts', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'IncidentEscalationStageStruct' => [ - 'description' => 'Event Escalation Phase Structure.', + 'IncidentNoteStruct' => [ + 'description' => 'The structure of the event record.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'stageIndex' => [ - 'description' => 'Phase index.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'index', - ], - 'cycleNotifyTime' => [ - 'description' => 'Recurring notification interval.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'backendName' => 'cycleNotifyTime', - ], - 'contact' => [ - 'description' => 'Contact list.', + 'format' => ['description' => 'The content format.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'format', 'title' => '', 'example' => 'markdown'], + 'noteId' => ['description' => 'The record ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'noteId', 'title' => '', 'example' => 'note-001'], + 'time' => ['description' => 'The time.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '1741234567890'], + 'incidentId' => ['description' => 'The event ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'type' => ['description' => 'The type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'apm'], + 'content' => ['description' => 'The content.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'content', 'title' => '', 'example' => '已联系运维团队，正在排查问题。'], + 'operator' => [ + 'description' => 'The operator.', 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Event Contact Structure.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentContactStruct', + 'type' => 'object', + 'properties' => [ + 'contactId' => ['description' => 'The contact ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contactId', 'title' => '', 'example' => 'user-12345'], + 'contact' => ['description' => 'The contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contact', 'title' => '', 'example' => '{\\"mobile_phone_num\\":\\"153xxxx8040\\",\\"mobile_country_code\\":\\"86\\",\\"email\\":\\"flightxxg@dida.com\\"}'], + 'name' => ['description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '张三'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'userId', 'title' => '', 'example' => '4123456'], ], - 'backendName' => 'contactList', - ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Operations team.'."\n", - 'backendName' => 'name', - ], - 'description' => [ - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Primary owner responsible for handling production environment alerts.'."\n", - 'backendName' => 'description', - ], - 'timeZone' => [ - 'description' => 'Time zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - 'backendName' => 'timeZone', - ], - 'effectTime' => [ - 'description' => 'Effective time period.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-05T00:00:00Z', - 'backendName' => 'effectTime', - ], - 'waitToNextStageTime' => [ - 'description' => 'Time to wait before proceeding to the next phase.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - 'backendName' => 'waitToNextStageTime', - ], - 'cycleNotifyCount' => [ - 'description' => 'Number of recurring notification attempts.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'cycleNotifyCount', + 'backendName' => 'opera', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'IncidentEscalationStruct' => [ - 'description' => 'Event Escalation Structure.', + 'IncidentPlanCorporationStruct' => [ + 'description' => 'The incident plan collaboration structure.', + 'type' => 'object', + 'properties' => [ + 'channel' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'ecs', 'visibility' => 'Public', 'backendName' => 'channel'], + 'robotId' => ['description' => 'The unique ID of the robot.', 'type' => 'string', 'title' => '', 'example' => 'robotId-cs-api-test', 'visibility' => 'Public', 'backendName' => 'robotId'], + ], + 'title' => '', + 'example' => '', 'visibility' => 'Public', + ], + 'IncidentPlanFieldPath' => [ + 'description' => 'A struct that defines the field mapping path for an incident plan.', 'type' => 'object', 'properties' => [ - 'incidentEscalationId' => [ - 'description' => 'Event Escalation ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '52631388567', - 'backendName' => 'uuid', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'modifyTime' => [ - 'description' => 'Modification time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'gmtModified', - ], - 'stage' => [ - 'description' => 'Phase.', - 'visibility' => 'Public', + 'fieldAlias' => ['description' => 'The field alias.', 'type' => 'string', 'title' => '', 'example' => '服务名称', 'visibility' => 'Public', 'backendName' => 'alias'], + 'fieldPath' => [ + 'description' => 'A list of field paths.', 'type' => 'array', - 'items' => [ - 'description' => 'Event Escalation Phase Structure.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationStageStruct', - ], - 'backendName' => 'stageList', - ], - 'createTime' => [ - 'description' => 'Creation time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'gmtCreate', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', - ], - 'name' => [ - 'description' => 'Name.', + 'items' => ['description' => 'The field path.', 'type' => 'string', 'title' => '', 'example' => 'service.name', 'visibility' => 'Public', 'extendType' => 'true'], + 'title' => '', + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Production Environment Alert Escalation Policy.'."\n", 'backendName' => 'name', ], - 'description' => [ - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'When an alert is not acknowledged, notify the operations team, on-duty manager, and CTO sequentially.'."\n", - 'backendName' => 'description', - ], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], - 'IncidentEventForView' => [ - 'description' => '', + 'IncidentPlanStruct' => [ + 'description' => 'The incident plan struct.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'incidentUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - 'backendName' => 'incidentUuid', - ], - 'userId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"user-abc123"', - 'backendName' => 'userId', - ], - 'time' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - 'backendName' => 'time', - ], - 'incidentEventUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"', - 'backendName' => 'incidentEventUuid', - ], - 'title' => [ - 'description' => '', + 'escalationId' => [ + 'description' => 'A list of escalation policy IDs.', 'visibility' => 'Public', - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The escalation policy ID.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'escalation-001'], + 'backendName' => 'escalationId', + 'title' => '', 'example' => '', - 'backendName' => 'title', - ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', ], - 'dimension' => [ - 'description' => '', + 'gmtModified' => ['description' => 'The time when the plan was last modified.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'gmtModified', 'title' => '', 'example' => '1741234567890'], + 'workspace' => ['description' => 'The name of the workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'title' => '', 'example' => 'workspace-test'], + 'resourceFiled' => [ + 'description' => 'A list of resource field mapping paths.', 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "env": "prod", "module": "payment" }', - 'backendName' => 'dimension', + 'type' => 'array', + 'items' => ['description' => 'The resource field mapping path.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanFieldPath', 'title' => '', 'example' => ''], + 'backendName' => 'resourceField', + 'title' => '', + 'example' => '', ], - 'labels' => [ - 'description' => '', + 'corporation' => [ + 'description' => 'A list of collaborating teams or roles.', 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "project": "payment-gateway", "owner": "ops-team" }', - 'backendName' => 'labels', + 'type' => 'array', + 'items' => ['description' => 'The incident plan struct.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanCorporationStruct', 'title' => '', 'example' => ''], + 'backendName' => 'corporation', + 'title' => '', + 'example' => '', ], + 'description' => ['description' => 'The description of the plan.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '针对数据库连接数过高的应急处理方案'], + 'autoRecoverSeconds' => ['description' => 'The wait time for automatic recovery.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'autoRecoverSeconds', 'title' => '', 'example' => '3600'], 'groupBy' => [ - 'description' => '', + 'description' => 'The grouping field path.', 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', + 'type' => 'array', + 'items' => ['description' => 'The struct for the field mapping path in the incident plan.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentPlanFieldPath', 'title' => '', 'example' => ''], 'backendName' => 'groupBy', + 'title' => '', + 'example' => '', ], - 'eventResource' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'eventResource', - '$ref' => '#/components/schemas/EventResourceForIncidentView', - ], - 'content' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'content', - '$ref' => '#/components/schemas/CmsEventForView', - ], - 'severity' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Critical"', - 'backendName' => 'severity', - ], - 'count' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'count', - ], - 'severityCountMap' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "Critical": 2, "High": 1 }', - 'backendName' => 'severityCountMap', - ], - 'lastTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - 'backendName' => 'lastTime', - ], - 'recoverTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876600000', - 'backendName' => 'recoverTime', - ], - 'autoRecoverTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876600000', - 'backendName' => 'autoRecoverTime', - ], - 'state' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'state', - ], - 'searchIndex' => [ - 'description' => '', - 'visibility' => 'Public', + 'gmtCreate' => ['description' => 'The time when the plan was created.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '1741234567890'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'userId', 'title' => '', 'example' => 'uesr-12345'], + 'closeExpire' => ['description' => 'The timeout period for closing an event.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'closeExpire', 'title' => '', 'example' => '86400000'], + 'name' => ['description' => 'The name of the plan.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '数据库连接数告警预案'], + 'incidentPlanId' => ['description' => 'The incident plan ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'uuid', 'title' => '', 'example' => 'plan-001'], + 'status' => ['description' => 'The status.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'status', 'title' => '', 'example' => 'Running'], + ], + 'title' => '', + 'example' => '', + ], + 'IncidentResourceDetail' => [ + 'description' => 'A struct that describes the details of a resource linked to an event.', + 'type' => 'object', + 'properties' => [ + 'resourceId' => ['description' => 'The resource ID object.', 'type' => 'object', 'title' => '', 'example' => '{ "type": "ecs", "id": "i-bp1234567890abcdef" }', 'visibility' => 'Public', 'backendName' => 'resourceId'], + 'extraId' => ['description' => 'An additional resource identifier.', 'type' => 'string', 'title' => '', 'example' => 'app-prod-web-01', 'visibility' => 'Public', 'backendName' => 'extraId'], + 'type' => ['description' => 'The resource type. This indicates the cloud product to which the resource belongs.', 'type' => 'string', 'title' => '', 'example' => 'ecs', 'visibility' => 'Public', 'backendName' => 'type'], + ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', + ], + 'IncidentResourceStruct' => [ + 'description' => 'A struct that describes the linked instance of an event.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'resource' => ['description' => 'The details object for the event resource.', 'visibility' => 'Public', 'backendName' => 'resource', '$ref' => '#/components/schemas/IncidentResourceDetail', 'title' => '', 'example' => ''], + 'description' => ['description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'title' => '', 'example' => '生产环境 Web 服务器'], + 'incidentResourceId' => ['description' => 'The unique ID of the resource in the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentItemToken', 'title' => '', 'example' => 'res-001'], + 'source' => ['description' => 'The source.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'cloudmonitor'], + 'time' => ['description' => 'The timestamp.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '1741234567890'], + 'incidentId' => ['description' => 'The event ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'userId', 'title' => '', 'example' => 'user-12345'], + ], + 'title' => '', + 'example' => '', + ], + 'IncidentResponsePlanForModify' => [ + 'title' => 'Incident 响应计划修改入参', + 'description' => 'The payload to create or update an incident management response plan. The fields are the same as in `IncidentResponsePlanForView`, excluding read-only fields such as `createTime`, `updateTime`, and `workspace`.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '响应计划 uuid', 'description' => 'Required for update operations. Optional for create operations; if omitted, the backend generates one. `NotifyStrategy` also uses this UUID.', 'type' => 'string', 'example' => ''], + 'name' => ['title' => '名称', 'type' => 'string', 'description' => '', 'example' => ''], + 'description' => ['title' => '描述', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'type' => ['title' => '类型', 'type' => 'string', 'description' => '', 'example' => ''], + 'source' => ['title' => '来源', 'type' => 'string', 'description' => '', 'example' => ''], + 'mode' => ['title' => '生命周期模式', 'type' => 'string', 'description' => '', 'example' => ''], + 'syncFromType' => ['title' => '同步来源类型', 'type' => 'string', 'description' => '', 'example' => ''], + 'autoRecoverSeconds' => ['title' => '无事件自动恢复时间（秒）', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'escalationId' => [ + 'title' => '升级规划 ID 列表', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '["ECS", "CPU", "high"]', - 'extendType' => 'true', - ], - 'backendName' => 'searchIndex', - ], - 'textIndex' => [ + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', 'example' => '', - 'backendName' => 'textIndex', ], + 'repeatNotifySetting' => ['title' => '重复通知配置', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/RepeatNotifySetting'], + 'pushingSetting' => ['title' => '推送设置', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/PushingSetting'], ], + 'example' => '', ], - 'IncidentEventStruct' => [ - 'description' => 'Event structure.', - 'visibility' => 'Public', + 'IncidentResponsePlanForSNSModify' => [ + 'title' => 'SNS 内嵌的响应计划入参', + 'description' => 'The input parameters for the `responsePlan` sub-entity of the `SubscriptionAndNotifyStrategy` aggregation API. The following read-only backend fields are not exposed: `uuid`, `name`, `type`, `source`, `mode`, `syncFromType`, and `enabled`.'."\n" + ."\n" + .'- The `uuid` is the same as the `snsUuid` of `notifyStrategy`.'."\n" + ."\n" + .'- The `type` is set to `NOTIFY_STRATEGY_DEFINED`, and the `source` is set to `CUSTOM`.'."\n" + ."\n" + .'- The `mode` is set to `BundleStrategy`, and the `syncFromType` is set to `OBS`.', 'type' => 'object', 'properties' => [ - 'lastTime' => [ - 'description' => 'Last time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'lastTime', - ], - 'recoverTime' => [ - 'description' => 'Manual recovery time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'recoverTime', - ], - 'autoRecoverTime' => [ - 'description' => 'Automatic recovery time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'autoRecoverTime', + 'escalationId' => [ + 'title' => '升级规划 id 列表', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The IDs of the escalation policies.', + 'example' => '', ], - 'resource' => [ - 'description' => 'Describes the resource information associated with the event.', - 'visibility' => 'Public', + 'repeatNotifySetting' => [ + 'title' => '重复通知配置', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'map', + 'properties' => [ + 'endIncidentState' => ['description' => 'The incident state that stops repeat notifications.', 'type' => 'string', 'title' => '', 'example' => ''], + 'repeatInterval' => ['description' => 'The repeat interval for notifications, in seconds.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], ], - 'backendName' => 'resource', - ], - 'count' => [ - 'description' => 'Count.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - 'backendName' => 'count', + 'description' => 'The repeat notification setting.', + 'example' => '', ], - 'groupBy' => [ - 'description' => 'Used for grouping dimensions.', - 'visibility' => 'Public', + 'autoRecoverSeconds' => ['title' => '自动恢复秒数（无事件持续时长）', 'description' => 'The auto recovery time, in seconds. After this period, the incident is automatically resolved.', 'type' => 'integer', 'example' => '', 'format' => 'int64'], + 'pushingSetting' => [ + 'title' => '推送设置', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'map', + 'properties' => [ + 'templateUuid' => ['description' => 'The UUID of the notification template.', 'type' => 'string', 'title' => '', 'example' => ''], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The IDs of the alert actions.', + 'title' => '', + 'example' => '', + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The IDs of the restore actions.', + 'title' => '', + 'example' => '', + ], ], - 'backendName' => 'groupBy', - ], - 'title' => [ - 'description' => 'Title.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'User service CPU usage is too high.'."\n", - 'backendName' => 'title', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'userId', - ], - 'content' => [ - 'description' => 'Content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Detected that the CPU usage of the user-service instance i-abc123 has reached 95%, triggering an alert.'."\n", - 'backendName' => 'content', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident Id.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentId', + 'description' => 'The push setting for notifications.', + 'example' => '', ], - 'incidentEventId' => [ - 'description' => 'Incident Event Id.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'event-001', - 'backendName' => 'incidentEventUuid', + ], + 'example' => '', + ], + 'IncidentResponsePlanForSNSView' => [ + 'title' => 'SNS 内嵌的响应计划查看视图', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => 'uuid（D8：= notifyStrategyUuid = SNS uuid）', 'description' => 'The unique ID of the incident response plan.', 'type' => 'string', 'example' => ''], + 'name' => ['description' => 'The name of the incident response plan.', 'type' => 'string', 'title' => '', 'example' => ''], + 'enable' => ['description' => 'Indicates if the incident response plan is enabled. Valid values: `true` and `false`.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'syncFromType' => ['description' => 'The synchronization source type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'mode' => ['description' => 'The mode of the incident response plan. Valid values: `AUTO` and `MANUAL`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'type' => ['title' => '响应计划类型（SNS 内必为 NOTIFY_STRATEGY_DEFINED）', 'description' => 'The type of the incident response plan.', 'type' => 'string', 'example' => ''], + 'source' => ['title' => '来源（SNS 内必为 CUSTOM）', 'description' => 'The source of the incident.', 'type' => 'string', 'example' => ''], + 'escalationId' => [ + 'title' => '升级规划 id 列表', + 'type' => 'array', + 'items' => ['description' => 'The ID of the escalation policy.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The IDs of the escalation policies.', + 'example' => '', ], - 'dimension' => [ - 'description' => 'Dimension.', - 'visibility' => 'Public', + 'repeatNotifySetting' => [ 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'map', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'map', + 'properties' => [ + 'endIncidentState' => ['description' => 'The incident state at which repeated notifications stop. For example, `resolved`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'repeatInterval' => ['description' => 'The interval, in seconds, for repeated notifications.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], ], - 'backendName' => 'dimension', + 'description' => 'The settings for repeated notifications.', + 'title' => '', + 'example' => '', ], - 'status' => [ - 'description' => 'Status.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'Running', - 'backendName' => 'status', + 'autoRecoverSeconds' => ['description' => 'The duration, in seconds, after which an incident without new alerts is automatically resolved.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'pushingSetting' => [ + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['description' => 'The ID of the notification template.', 'type' => 'string', 'title' => '', 'example' => ''], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of the action to run when an alert is triggered.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The IDs of actions to run when an alert is triggered.', + 'title' => '', + 'example' => '', + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of the action to run when the incident is resolved.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The IDs of actions to run when the incident is resolved.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The settings for sending notifications.', + 'title' => '', + 'example' => '', ], + 'createTime' => ['description' => 'The time when the incident response plan was created, in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'title' => '', 'example' => ''], + 'updateTime' => ['description' => 'The time when the incident response plan was last updated, in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'The details of the incident response plan.', + 'example' => '', ], - 'IncidentForView' => [ - 'description' => '', - 'visibility' => 'Public', + 'IncidentResponsePlanForView' => [ 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'type' => ['description' => 'The type of the response plan.', 'type' => 'string', 'title' => '', 'example' => '"Standard"'], + 'source' => ['description' => 'The source.', 'type' => 'string', 'title' => '', 'example' => '"MANUAL"'], + 'escalationId' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of the escalation policy.', 'type' => 'string', 'title' => '', 'example' => '"escalation-123"'], + 'description' => 'A list of the IDs of associated escalation policies.', + 'title' => '', 'example' => '', - 'backendName' => 'content', ], - 'incidentId' => [ - 'description' => '', + 'repeatNotifySetting' => ['description' => 'The settings for repeated notifications.', '$ref' => '#/components/schemas/RepeatNotifySetting', 'title' => '', 'example' => ''], + 'mode' => ['description' => 'The response pattern.', 'type' => 'string', 'title' => '', 'example' => '"Manual"'], + 'autoRecoverSeconds' => ['description' => 'The automatic recovery time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '300'], + 'syncFromType' => ['description' => 'The source type of the synchronization policy.', 'type' => 'string', 'title' => '', 'example' => '"ARMS"'], + 'pushingSetting' => ['description' => 'The push notification settings.', '$ref' => '#/components/schemas/PushingSetting', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The name of the response plan.', 'type' => 'string', 'title' => '', 'example' => '"P1-Critical-Response-Plan"'], + 'uuid' => ['description' => 'The globally unique identifier.', 'type' => 'string', 'title' => '', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'title' => '', 'example' => '"ws-xyz789"'], + 'description' => ['description' => 'The description of the response plan.', 'type' => 'string', 'title' => '', 'example' => '"针对支付服务不可用的紧急响应流程"'], + 'enabled' => ['description' => 'Indicates whether the response plan is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'createTime' => ['description' => 'The time when the plan was created.', 'type' => 'string', 'title' => '', 'example' => '"2025-04-05T10:30:00Z"'], + 'updateTime' => ['description' => 'The time when the plan was last updated.', 'type' => 'string', 'title' => '', 'example' => '"2025-04-06T09:15:00Z"'], + ], + 'description' => 'The response plan object.', + 'title' => '', + 'example' => '', + ], + 'IncidentStruct' => [ + 'description' => 'The core struct that represents a complete event.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'severity' => ['description' => 'The severity level of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'severity', 'title' => '', 'example' => 'P1'], + 'escalations' => [ + 'description' => 'The list of escalation policies.', 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"incident-abc123"', - 'backendName' => 'incidentUuid', + 'type' => 'array', + 'items' => ['description' => 'The event escalation struct.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/IncidentEscalationStruct', 'title' => '', 'example' => ''], + 'backendName' => 'escalations', + 'title' => '', + 'example' => '', ], - 'plan' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'plan', - '$ref' => '#/components/schemas/IncidentResponsePlanForView', - ], - 'severity' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Critical"', - 'backendName' => 'severity', - ], - 'time' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - 'backendName' => 'time', - ], - 'title' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'resource' => ['description' => 'The details of the associated resource.', 'visibility' => 'Public', 'backendName' => 'resource', '$ref' => '#/components/schemas/IncidentResourceDetail', 'title' => '', 'example' => ''], + 'incidentPlan' => ['description' => 'The associated incident plan.', 'visibility' => 'Public', 'backendName' => 'plan', '$ref' => '#/components/schemas/IncidentPlanStruct', 'title' => '', 'example' => ''], + 'time' => ['description' => 'The timestamp.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '1741234567890'], + 'incidentId' => ['description' => 'The unique ID of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'title' => ['description' => 'The title of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'title', 'title' => '', 'example' => '数据库连接数过高'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'title' => '', 'example' => 'user-12345'], + 'content' => ['description' => 'The content of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'content', 'title' => '', 'example' => '检测到 RDS 实例 rds-bp1234567890abcdef 的连接数达到 1000，已触发告警。'], + 'status' => ['description' => 'The current status.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'status', 'title' => '', 'example' => 'OPEN'], + ], + 'title' => '', + 'example' => '', + ], + 'IncidentTimeline' => [ + 'description' => 'A struct that represents a timeline node in the event handling process.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'childType' => ['description' => 'The child type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'childType', 'title' => '', 'example' => 'comment'], + 'incidentTimelineId' => ['description' => 'The unique ID of the timeline node.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentItemToken', 'title' => '', 'example' => 'timeline-001'], + 'timelineId' => ['description' => 'The ID of the timeline.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'timelineUuid', 'title' => '', 'example' => 'timeline-main-001'], + 'time' => ['description' => 'The timestamp.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'time', 'title' => '', 'example' => '1741234567890'], + 'incidentId' => ['description' => 'The ID of the event.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'incidentUuid', 'title' => '', 'example' => 'incident-001'], + 'title' => ['description' => 'The timeline title.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'title', 'title' => '', 'example' => '已联系运维团队'], + 'type' => ['description' => 'The type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'ACTION'], + 'userId' => ['description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'title' => '', 'example' => 'user-12345'], + 'content' => ['description' => 'The content.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'content', 'title' => '', 'example' => '已通知运维团队进行排查'], + ], + 'title' => '', + 'example' => '', + ], + 'IncidentTimelineForView' => [ + 'type' => 'object', + 'properties' => [ + 'incidentUuid' => ['description' => 'The unique identifier of the incident.', 'type' => 'string', 'title' => '', 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"'], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '"user-abc123"'], + 'time' => ['description' => 'The UNIX timestamp when the timeline event occurred.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1743876000000'], + 'timelineUuid' => ['description' => 'The unique identifier of the timeline record.', 'type' => 'string', 'title' => '', 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"'], + 'type' => ['description' => 'The type of the timeline event.', 'type' => 'string', 'title' => '', 'example' => '"Comment"'], + 'changeType' => ['description' => 'The type of status change.', 'type' => 'string', 'title' => '', 'example' => '"Open -> In Progress"'], + 'title' => ['description' => 'The title of the timeline event.', 'type' => 'string', 'title' => '', 'example' => '"故障已升级至值班主管"'], + 'content' => ['description' => 'The content of the timeline event.', 'type' => 'any', 'title' => '', 'example' => '"{"action":"restart","resourceId":"i-bp123456"}"'], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'title' => '', 'example' => '"ws-xyz789"'], + 'operator' => ['description' => 'Information about the operator.', '$ref' => '#/components/schemas/ContactForIncidentView', 'title' => '', 'example' => ''], + ], + 'description' => 'The incident timeline object.', + 'title' => '', + 'example' => '', + ], + 'IndexJsonKey' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The field type.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'chn' => ['description' => 'Specifies whether the field contains Chinese characters.'."\n" + ."\n" + .'- `true`: The field contains Chinese characters.'."\n" + ."\n" + .'- `false`: The field does not contain Chinese characters.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => 'The configuration for a json key.', + 'title' => '', + 'example' => '', + ], + 'IndexKey' => [ + 'type' => 'object', + 'properties' => [ + 'chn' => ['description' => 'Indicates whether the value contains Chinese characters.'."\n" + ."\n" + .'- `true`: Contains Chinese characters.'."\n" + ."\n" + .'- `false`: Does not contain Chinese characters.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'type' => ['description' => 'Specifies the field type.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'embedding' => ['description' => 'Specifies the model name.', 'type' => 'string', 'title' => '', 'example' => 'text-embedding-v4'], + 'jsonKeys' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The name of the json key.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IndexJsonKey'], + 'description' => 'Describes the json keys.', + 'title' => '', 'example' => '', - 'backendName' => 'title', - ], - 'userId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"user-abc123"', - 'backendName' => 'userId', - ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', ], - 'groupUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"group-123456"', - 'backendName' => 'groupUuid', + ], + 'description' => 'Describes the table structure.', + 'title' => '', + 'example' => '', + ], + 'LabelMatcher' => [ + 'description' => 'A `LabelMatcher` defines a query that selects resources by exactly matching a label\'s `key` and `value`.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The label key to match.', 'type' => 'string', 'title' => '', 'example' => ''], + 'value' => ['description' => 'The label value to match.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'LabelsFilter' => [ + 'description' => 'A `LabelsFilter` defines a query for selecting objects based on their labels. It allows you to construct complex selection logic by combining multiple label matchers. The filter has two optional fields, `anyOf` and `allOf`. If both are specified, an object is selected only if it satisfies the conditions in both fields.', + 'type' => 'object', + 'properties' => [ + 'anyOf' => [ + 'description' => 'An array of `LabelMatcher` requirements. An object is selected if it satisfies at least one of the requirements in this list (a logical OR). If provided, the list cannot be empty.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LabelMatcher'], + 'title' => '', + 'example' => '', ], - 'state' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Open"', - 'backendName' => 'state', + 'allOf' => [ + 'description' => 'An array of `LabelMatcher` requirements. An object is selected only if it satisfies all of the requirements in this list (a logical AND). If provided, the list cannot be empty.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LabelMatcher'], + 'title' => '', + 'example' => '', ], - 'notifyStrategyUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"notify-strategy-789"', - 'backendName' => 'notifyStrategyUuid', + ], + 'title' => '', + 'example' => '', + ], + 'ListEventMetaCacheAllKeys_DataResult' => [ + 'type' => 'object', + 'properties' => [ + 'label' => [ + 'description' => 'label类型的Key列表', + 'type' => 'array', + 'items' => ['description' => 'Key名称', 'type' => 'string', 'example' => '_cms_rule_id'], + 'example' => '["_cms_rule_id","_cms_rule_name"]', ], - 'subscriptionUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"subscription-abc"', - 'backendName' => 'subscriptionUuid', + 'annotation' => [ + 'description' => 'annotation类型的Key列表', + 'type' => 'array', + 'items' => ['description' => 'Key名称', 'type' => 'string', 'example' => 'message'], + 'example' => '["message","current_value"]', ], - 'operator' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'operator', - '$ref' => '#/components/schemas/ContactForIncidentView', + 'resourceTag' => [ + 'description' => 'resource.tag类型的Key列表', + 'type' => 'array', + 'items' => ['description' => 'Key名称', 'type' => 'string', 'example' => 'arn'], + 'example' => '["arn","callType"]', ], - 'notifyStrategyName' => [ - 'description' => '', + ], + ], + 'MaintainWindowForModify' => [ + 'title' => 'A short description of struct', + 'description' => 'The silence policy object.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'effective' => ['title' => 'Crontab 表达式', 'description' => 'The Crontab expression.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'effective', 'example' => '* * 14-18 ? * *'], + 'description' => ['title' => '创建时间', 'description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'workspace test'], + 'filterSetting' => ['description' => 'The filter conditions.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'maintainWindowName' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'maintainWindowName', 'example' => 'test strategy'], + 'startTime' => ['title' => '生效开始时间', 'description' => 'The time when the policy starts to take effect.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'startTime', 'example' => '2025-04-11 07:55:00'], + 'effectTimeRange' => [ + 'description' => 'The effective time range.', 'visibility' => 'Public', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time in minutes.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'backendName' => 'startTimeInMinute', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'timeZone', 'example' => '+08:00'], + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'description' => 'The days of the week when the policy is effective (Monday to Sunday).', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => ['description' => 'The values 0 to 6 represent Sunday to Saturday.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'extendType' => 'true', 'title' => '', 'example' => '0'], + 'backendName' => 'dayInWeek', + 'example' => '', + ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time in minutes.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'backendName' => 'endTimeInMinute', 'example' => '60'], + ], + 'backendName' => 'effectTimeRange', + 'title' => '', 'example' => '', - 'backendName' => 'notifyStrategyName', - ], - 'subscriptionName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"P1-Alert-Notification"', - 'backendName' => 'subscriptionName', ], - 'escalations' => [ - 'description' => '', + 'endTime' => ['title' => '生效结束时间', 'description' => 'The time when the policy stops taking effect.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'endTime', 'example' => '2024-09-05 09:30:40'], + ], + 'example' => '', + ], + 'MaintainWindowForView' => [ + 'title' => 'A short description of struct', + 'description' => 'The alert silencing policy object.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'workspace-test'], + 'maintainWindowId' => ['title' => 'UUID', 'description' => 'The UUID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'maintainWindowId', 'example' => '123-12-312-31-23123'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'test'], + 'filterSetting' => ['description' => 'The filter conditions.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'maintainWindowName' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'maintainWindowName', 'example' => '测试策略'], + 'updateTime' => ['title' => '更新时间', 'description' => 'The last time the resource was updated.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'updateTime', 'example' => '2025-05-07T02:19:05Z'], + 'effectTimeRange' => [ + 'description' => 'The effective time range.', 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationPolicyForView', + 'type' => 'object', + 'properties' => [ + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time in minutes.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'backendName' => 'startTimeInMinute', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'timeZone', 'example' => '+08:00'], + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'description' => 'The days of the week when the policy is effective.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => ['description' => 'The values 0 to 6 represent Sunday to Saturday.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'extendType' => 'true', 'title' => '', 'example' => '3'], + 'backendName' => 'dayInWeek', + 'example' => '', + ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time in minutes.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'backendName' => 'endTimeInMinute', 'example' => '360'], ], - 'backendName' => 'escalations', + 'backendName' => 'effectTimeRange', + 'title' => '', + 'example' => '', ], - 'owners' => [ - 'description' => '', - 'visibility' => 'Public', + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'example' => '12312312***'], + 'effective' => ['title' => 'Crontab 表达式', 'description' => 'The crontab expression.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'effective', 'example' => '* * 14-18 ? * *'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the policy was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'createTime', 'example' => '2025-03-11T08:21:58Z'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enabled', 'example' => 'true'], + 'startTime' => ['title' => '生效开始时间', 'description' => 'The start time of the effective period.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'startTime', 'example' => '2024-11-26 10:02:01'], + 'endTime' => ['title' => '生效结束时间', 'description' => 'The end time of the effective period.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'endTime', 'example' => '2024-11-26 12:02:01'], + ], + 'example' => '', + ], + 'ManageAlertRulesResult' => [ + 'description' => 'The result of managing alert rules.', + 'type' => 'object', + 'properties' => [ + 'alertRule' => ['description' => 'The details of the created or updated alert rule.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AlertRuleV2'], + 'deletedCount' => ['description' => 'The number of deleted alert rules.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'deletedUuidList' => [ + 'description' => 'A list of UUIDs of deleted alert rules.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ContactForIncidentView', - ], - 'backendName' => 'owners', + 'items' => ['description' => 'The UUID of a deleted alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'participants' => [ - 'description' => '', - 'visibility' => 'Public', + 'updatedCount' => ['description' => 'The number of updated alert rules.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'updatedUuidList' => [ + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ContactForIncidentView', - ], - 'backendName' => 'participants', + 'items' => ['description' => 'The UUID of an updated alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of UUIDs of updated alert rules.', + 'example' => '', ], - 'groupingKeys' => [ + ], + 'title' => '', + 'example' => '', + ], + 'ManageAlertRulesUnifiedActionInput' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'title' => '', + 'type' => 'string', 'description' => '', - 'visibility' => 'Public', + 'example' => '', + 'required' => true, + 'enum' => ['CREATE', 'UPDATE', 'PATCH', 'BATCH_DELETE', 'BATCH_ENABLE', 'BATCH_DISABLE', 'DELETE', 'ENABLE', 'DISABLE'], + ], + 'uuid' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'workspace' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'displayName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'contentTemplate' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'datasourceConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DatasourceConfigUnified'], + 'queryConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QueryConfigUnified'], + 'conditionConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ConditionConfigUnified'], + 'scheduleConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ScheduleConfigUnified'], + 'notifyConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyConfigUnified'], + 'actionIntegrationConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ActionIntegrationConfig'], + 'armsIntegrationConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ArmsIntegrationConfig'], + 'observeResourceInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'observeResourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'labels' => [ + 'title' => '', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', - ], - 'backendName' => 'groupingKeys', - ], - 'relatedResources' => [ + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/EventResourceForIncidentView', - ], - 'backendName' => 'relatedResources', + 'example' => '', ], - 'solution' => [ + 'annotations' => [ + 'title' => '', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', 'example' => '', - 'backendName' => 'solution', ], - 'rootCauseCategory' => [ + 'uuidList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', + 'example' => '', + ], + ], + 'description' => '', + 'example' => '', + ], + 'MergeContact' => [ + 'description' => 'The struct for a merged contact object.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'gmtModified' => ['description' => 'The time when the contact was last modified.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtModified', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'name' => ['description' => 'The name of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '张三'], + 'gmtCreate' => ['description' => 'The time when the contact was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'identifier' => ['description' => 'The unique identifier of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'identifier', 'title' => '', 'example' => 'user-12345'], + 'phoneCode' => ['description' => 'The country code for the mobile phone number.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'phoneCode', 'title' => '', 'example' => '86'], + 'phone' => ['description' => 'The mobile phone number.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'phone', 'sensitive' => true, 'title' => '', 'example' => '13800138000'], + 'phoneVerify' => ['description' => 'Specifies whether the mobile phone number is authenticated.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'phoneVerify', 'title' => '', 'example' => 'true'], + 'email' => ['description' => 'The email address.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'email', 'sensitive' => true, 'title' => '', 'example' => 'zhangsan@company.com'], + 'emailVerify' => ['description' => 'Specifies whether the email address is authenticated.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'emailVerify', 'title' => '', 'example' => 'true'], + 'lang' => ['description' => 'The language preference.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'lang', 'title' => '', 'example' => 'zh-CN'], + 'source' => ['description' => 'The source system of the contact.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'dingtalk'], + 'extend' => ['description' => 'An extension field used to store additional information.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'extend', 'title' => '', 'example' => '{ "department": "运维部", "role": "工程师" }'], + ], + 'title' => '', + 'example' => '', + ], + 'MergeContactGroup' => [ + 'description' => 'A struct for a merged contact group object.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the contact group.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '运维团队'], + 'gmtModified' => ['description' => 'The time when the contact group was last modified.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'identifier' => ['description' => 'The unique identifier of the contact group.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'identifier', 'title' => '', 'example' => 'group-12345'], + 'gmtCreate' => ['description' => 'The time when the contact group was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'plan', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'contacts' => [ + 'description' => 'A list of unique identifiers for the members in the group.', 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Network"', - 'backendName' => 'rootCauseCategory', + 'type' => 'array', + 'items' => ['description' => 'The unique identifier of a member in the group.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => 'user-12345'], + 'backendName' => 'contacts', + 'title' => '', + 'example' => '', ], + 'extend' => ['description' => 'An extension field that stores additional information.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'extend', 'title' => '', 'example' => '{ "department": "运维部", "role": "工程师" }'], + 'source' => ['description' => 'The source system of the contact group.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'dingtalk'], ], + 'title' => '', + 'example' => '', ], - 'IncidentMemberStruct' => [ - 'description' => 'Event Member Structure.', + 'MergeOncallSchedule' => [ + 'type' => 'object', + 'properties' => [ + 'gmtModified' => ['description' => 'The UTC time when the on-call schedule was last modified.', 'type' => 'string', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The name of the on-call schedule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'gmtCreate' => ['description' => 'The UTC time when the on-call schedule was created.', 'type' => 'string', 'title' => '', 'example' => ''], + 'identifier' => ['description' => 'The unique identifier of the on-call schedule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'source' => ['description' => 'The creation source of the on-call schedule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'detail' => ['description' => 'Details of the on-call schedule.', 'type' => 'object', 'title' => '', 'example' => ''], + 'workspace' => ['description' => 'The workspace that the on-call schedule belongs to.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'Details of the merged on-call schedule.', + 'title' => '', + 'example' => '', + ], + 'MergeRobot' => [ + 'description' => 'The struct for the merge object of a bot.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'acknowledge' => [ - 'description' => 'Acknowledgement Information Structure.', + 'name' => ['description' => 'The name of the bot.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '运维告警机器人'], + 'webhook' => ['description' => 'The webhook address.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'webhook', 'title' => '', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123'], + 'type' => ['description' => 'The type of the bot.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'dingtalk'], + 'createTime' => ['description' => 'The time when the bot was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'gmtModified' => ['description' => 'The time when the bot was last modified.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtModified', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'identifier' => ['description' => 'The unique identifier of the bot.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'identifier', 'title' => '', 'example' => 'robot-12345'], + 'lang' => ['description' => 'The language preference.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'lang', 'title' => '', 'example' => 'zh-CN'], + 'extend' => [ + 'description' => 'The extension fields.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'breakLevel' => [ - 'description' => 'Acknowledgement level.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2', - 'backendName' => 'breakLevel', - ], - 'verifyTime' => [ - 'description' => 'Verification time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'verifyTime', - ], + 'dailyNoc' => ['description' => 'Specifies whether to enable the daily on-duty report.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'dailyNoc', 'title' => '', 'example' => 'true'], + 'dingSignKey' => ['description' => 'The signature key for DingTalk.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dingSignKey', 'title' => '', 'example' => 'abc123'], + 'enableOutgoing' => ['description' => 'Specifies whether to enable outbound requests.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enableOutgoing', 'title' => '', 'example' => 'false'], + 'cardTemplate' => ['description' => 'The card template.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'cardTemplate', 'title' => '', 'example' => 'incident-card-template'], + 'dailyNocTime' => ['description' => 'The time for the daily on-duty report.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'dailyNocTime', 'title' => '', 'example' => '09:00'], + 'token' => ['description' => 'The authentication token.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'token', 'sensitive' => true, 'title' => '', 'example' => 'token-abc123'], ], - 'backendName' => 'acknowledge', + 'backendName' => 'extend', + 'title' => '', + 'example' => '', ], - 'incidentMemberId' => [ - 'description' => 'Event Member ID.', - 'visibility' => 'Public', + 'source' => ['description' => 'The source system of the bot.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'dingtalk'], + ], + 'title' => '', + 'example' => '', + ], + 'MergeWebhook' => [ + 'description' => 'The struct of the merged webhook object.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'gmtCreate' => ['description' => 'The creation time.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'gmtCreate', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'name' => ['description' => 'The name of the webhook.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'title' => '', 'example' => '运维告警通知'], + 'gmtModified' => ['description' => 'The last modification time.', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'gmtModified', 'title' => '', 'example' => '2025-03-11T08:21:58.789Z'], + 'identifier' => ['description' => 'The unique identifier of the webhook.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'identifier', 'title' => '', 'example' => 'webhook-12345'], + 'webhook' => ['description' => 'The webhook URL used to send requests.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'webhook', 'title' => '', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123'], + 'type' => ['description' => 'The type of the webhook. It indicates the destination platform.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'dingtalk'], + 'headers' => ['description' => 'The request header.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'headers', 'title' => '', 'example' => '{"Authorization": "Bearer abc123"}'], + 'method' => ['description' => 'The HTTP request method.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'method', 'title' => '', 'example' => 'POST'], + 'contentType' => ['description' => 'The content type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'contentType', 'title' => '', 'example' => 'application/json'], + 'lang' => ['description' => 'The language preference.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'lang', 'title' => '', 'example' => 'zh-CN'], + 'extend' => ['description' => 'An extension field used to store additional configurations.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'extend', 'title' => '', 'example' => '{"timeout": 3000}'], + 'source' => ['description' => 'The source system of the webhook.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'dingtalk'], + ], + 'title' => '', + 'example' => '', + ], + 'MetricSetMultiTrigger' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'title' => '', 'type' => 'string', - 'example' => 'member-001', - 'backendName' => 'incidentItemToken', + 'enum' => ['INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL'], + 'description' => '', + 'example' => '', ], - 'contactId' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', + 'durationSecs' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'expressionType' => [ + 'title' => '', 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'contactId', + 'enum' => ['SIMPLE', 'COMPOSITE'], + 'description' => '', + 'example' => '', ], - 'escalation' => [ - 'description' => 'Escalation phase information.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'stageIndex' => [ - 'description' => 'Escalation phase index.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - 'backendName' => 'stageIndex', - ], - 'incidentEscalationId' => [ - 'description' => 'Event Escalation ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'escalation-001', - 'backendName' => 'escalationId', - ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Phase one.'."\n", - 'backendName' => 'name', - ], - 'description' => [ - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Notify the operations team.'."\n", - 'backendName' => 'description', - ], - 'title' => [ - 'description' => 'Title.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Alert escalated to the operations team.'."\n", - 'backendName' => 'title', - ], - ], - 'backendName' => 'escalation', - ], - 'scheduleGroup' => [ - 'description' => 'Schedule group.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'contactId' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'group-001', - 'backendName' => 'contactId', - ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Night shift duty team.'."\n", - 'backendName' => 'name', - ], - ], - 'backendName' => 'schedule', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-10-08 10:18:58', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', + 'queryName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'operator' => [ + 'title' => '', 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], + 'description' => '', + 'example' => '', ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4123456', - 'backendName' => 'userId', + 'threshold' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'min' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'max' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'logicOperator' => [ + 'title' => '', + 'type' => 'string', + 'enum' => ['AND', 'OR', 'UNLESS'], + 'description' => '', + 'example' => '', ], - 'contacts' => [ - 'description' => 'Contact list.', - 'visibility' => 'Public', + 'conditions' => [ + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => 'Contact details.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'contactMask' => [ - 'description' => 'Contact ID (masked).', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'contactMask', - ], - 'channel' => [ - 'description' => 'Channel.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'channel', - ], - ], - 'extendType' => 'true', - ], - 'backendName' => 'contacts', + 'items' => ['$ref' => '#/components/schemas/MetricSetTriggerSimpleExpression', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', ], ], + 'description' => '', + 'example' => '', ], - 'IncidentNoteStruct' => [ - 'description' => 'Event record structure.', - 'visibility' => 'Public', + 'MetricSetNamedQueryEntry' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'format' => [ - 'description' => 'Content format.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'markdown', - 'backendName' => 'format', - ], - 'noteId' => [ - 'description' => 'Note ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'note-001', - 'backendName' => 'noteId', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', - ], - 'type' => [ - 'description' => 'Type.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'apm', - 'backendName' => 'type', - ], - 'content' => [ - 'description' => 'Content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The operations team has been contacted and is currently investigating the issue.'."\n", - 'backendName' => 'content', - ], - 'operator' => [ - 'description' => 'Operator.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'contactId' => [ - 'description' => 'Contact ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'contactId', - ], - 'contact' => [ - 'description' => 'Contact.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{\\"mobile_phone_num\\":\\"153xxxx8040\\",\\"mobile_country_code\\":\\"86\\",\\"email\\":\\"flightxxg@dida.com\\"}', - 'backendName' => 'contact', - ], - 'name' => [ - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Zhang San.'."\n", - 'backendName' => 'name', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4123456', - 'backendName' => 'userId', - ], - ], - 'backendName' => 'opera', + 'name' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metricSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metric' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'labelFilters' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/UmodelLabelFilter', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', ], ], + 'description' => '', + 'example' => '', ], - 'IncidentPlanCorporationStruct' => [ - 'description' => 'Event contingency collaboration structure.', - 'visibility' => 'Public', + 'MetricSetTriggerCompositeExpression' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'channel' => [ - 'description' => 'Channel name.', - 'visibility' => 'Public', + 'expressionType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'logicOperator' => [ + 'title' => '', 'type' => 'string', - 'example' => 'ecs', - 'backendName' => 'channel', + 'enum' => ['AND', 'OR', 'UNLESS'], + 'description' => '', + 'example' => '', ], - 'robotId' => [ - 'description' => 'Robot ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'robotId-cs-api-test', - 'backendName' => 'robotId', + 'conditions' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetTriggerSimpleExpression', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', ], ], + 'description' => '', + 'example' => '', ], - 'IncidentPlanFieldPath' => [ - 'description' => 'A structure used to define field mapping paths in an event contingency plan.', - 'visibility' => 'Public', + 'MetricSetTriggerSimpleExpression' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'fieldAlias' => [ - 'description' => 'Field alias.', - 'visibility' => 'Public', + 'expressionType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'queryName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'operator' => [ + 'title' => '', 'type' => 'string', - 'example' => 'Service name.'."\n", - 'backendName' => 'alias', + 'enum' => ['GT', 'GE', 'GTE', 'LT', 'LE', 'LTE', 'EQ', 'NE', 'IN_RANGE', 'OUT_OF_RANGE', 'PRESENT', 'NOT_PRESENT', 'YOY_UP', 'YOY_DOWN'], + 'description' => '', + 'example' => '', ], - 'fieldPath' => [ - 'description' => 'List of field paths.', - 'visibility' => 'Public', + 'threshold' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'min' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + 'max' => ['title' => '', 'type' => 'number', 'format' => 'double', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'ModelParameters' => [ + 'type' => 'object', + 'properties' => [ + 'temperature' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'maxTokens' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'topP' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'topK' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'frequencyPenalty' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'presencePenalty' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'float'], + 'stopSequences' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Field path.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'service.name', - 'extendType' => 'true', - ], - 'backendName' => 'name', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'IncidentPlanStruct' => [ - 'description' => 'Event contingency plan structure.', - 'visibility' => 'Public', + 'NotifyChannel' => [ 'type' => 'object', 'properties' => [ - 'escalationId' => [ - 'description' => 'List of escalation policy IDs.', - 'visibility' => 'Public', + 'channelType' => ['description' => 'The type of the notification channel.', 'type' => 'string', 'title' => '', 'example' => '"DingTalk"'], + 'receivers' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Escalation policy ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'escalation-001', - 'extendType' => 'true', - ], - 'backendName' => 'escalationId', + 'items' => ['description' => 'A receiver.', 'type' => 'string', 'title' => '', 'example' => '[]'], + 'description' => 'The list of receivers.', + 'title' => '', + 'example' => '', ], - 'gmtModified' => [ - 'description' => 'Last modification time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'gmtModified', + 'enabledSubChannels' => [ + 'type' => 'array', + 'items' => ['description' => 'A channel.', 'type' => 'string', 'title' => '', 'example' => '[]'], + 'description' => 'The list of enabled sub-channels.', + 'title' => '', + 'example' => '', ], - 'workspace' => [ - 'description' => 'Workspace name.', - 'visibility' => 'Public', + ], + 'description' => 'The notification channel configuration object.', + 'title' => '', + 'example' => '', + ], + 'NotifyConfigUnified' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '', 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', + 'description' => '', + 'example' => '', + 'required' => true, + 'enum' => ['DIRECT_NOTIFY', 'NOTIFY_POLICY'], ], - 'resourceFiled' => [ - 'description' => 'List of resource field mapping paths.', - 'visibility' => 'Public', + 'channels' => [ + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => 'Resource field mapping path.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentPlanFieldPath', - ], - 'backendName' => 'resourceField', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DirectNotifyChannel'], + 'description' => '', + 'required' => true, + 'example' => '', ], - 'corporation' => [ - 'description' => 'List of teams or roles involved in collaboration.', - 'visibility' => 'Public', + 'silenceTimeSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'activeDays' => [ + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => 'Event contingency plan structure.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentPlanCorporationStruct', - ], - 'backendName' => 'corporation', - ], - 'description' => [ - 'description' => 'Contingency plan description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Emergency response plan for excessively high database connection count.'."\n", - 'backendName' => 'description', - ], - 'autoRecoverSeconds' => [ - 'description' => 'Automatic recovery wait time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - 'backendName' => 'autoRecoverSeconds', + 'items' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'description' => '', + 'example' => '', ], - 'groupBy' => [ - 'description' => 'Grouping field path.', - 'visibility' => 'Public', + 'activeStartTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'activeEndTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'utcOffset' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'notifyStrategies' => [ + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => 'Structure for field mapping paths in the event contingency plan.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentPlanFieldPath', - ], - 'backendName' => 'groupBy', - ], - 'gmtCreate' => [ - 'description' => 'Creation time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'gmtCreate', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'uesr-12345', - 'backendName' => 'userId', - ], - 'closeExpire' => [ - 'description' => 'Event closure timeout.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400000', - 'backendName' => 'closeExpire', - ], - 'name' => [ - 'description' => 'Contingency plan name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Database connection count alert contingency plan.'."\n", - 'backendName' => 'name', - ], - 'incidentPlanId' => [ - 'description' => 'Event contingency plan ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'plan-001', - 'backendName' => 'uuid', - ], - 'status' => [ - 'description' => 'Status.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Running', - 'backendName' => 'status', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', ], ], + 'description' => '', + 'example' => '', ], - 'IncidentResourceDetail' => [ - 'description' => 'A structure used to describe the details of resources associated with an event.', - 'visibility' => 'Public', + 'NotifyRouteForSubscription' => [ 'type' => 'object', 'properties' => [ - 'resourceId' => [ - 'description' => 'Resource ID object.', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "type": "ecs", "id": "i-bp1234567890abcdef" }', - 'backendName' => 'resourceId', - ], - 'extraId' => [ - 'description' => 'Additional resource identifier.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'app-prod-web-01', - 'backendName' => 'extraId', - ], - 'type' => [ - 'description' => 'Resource type, indicating which cloud product the resource belongs to.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs', - 'backendName' => 'type', - ], - ], - ], - 'IncidentResourceStruct' => [ - 'description' => 'A structure used to describe resources associated with an event.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'resource' => [ - 'description' => 'Event resource details object.', - 'visibility' => 'Public', - 'backendName' => 'resource', - '$ref' => '#/components/schemas/IncidentResourceDetail', - ], - 'description' => [ - 'description' => 'Description information.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Production environment web server.'."\n", - 'backendName' => 'description', - ], - 'incidentResourceId' => [ - 'description' => 'The unique ID of this resource in the event.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'res-001', - 'backendName' => 'incidentItemToken', - ], - 'source' => [ - 'description' => 'Source.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cloudmonitor', - 'backendName' => 'source', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', + 'channels' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channelType' => ['description' => 'The channel type. For example, `Email`, `SMS`, or `Webhook`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'receivers' => [ + 'type' => 'array', + 'items' => ['description' => 'A single receiver. For example, an email address or a phone number.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of notification receivers. The receiver format depends on the `channelType`.', + 'title' => '', + 'example' => '', + ], + 'enabledSubChannels' => [ + 'type' => 'array', + 'items' => ['description' => 'A single enabled sub-channel.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of enabled sub-channels. Applicable to channels that support finer-grained topics or categories.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The configuration for a notification channel.', + 'title' => '', + 'example' => '', + ], + 'description' => 'An array of objects, each defining a notification channel.', + 'title' => '', + 'example' => '', ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'user-12345', - 'backendName' => 'userId', + 'effectTimeRange' => [ + 'type' => 'object', + 'properties' => [ + 'timeZone' => ['description' => 'The time zone for the effect time range, specified in the IANA Time Zone Database format. For example, `UTC` or `Asia/Shanghai`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'dayInWeek' => [ + 'type' => 'array', + 'items' => ['description' => 'A day of the week. Valid values are from 1 (Monday) to 7 (Sunday).', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'description' => 'The active days of the week, specified as an array of integers.', + 'title' => '', + 'example' => '', + ], + 'startTimeInMinute' => ['description' => 'The start of the active period, in minutes from 00:00. The value ranges from 0 to 1439.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'endTimeInMinute' => ['description' => 'The end of the active period, in minutes from 00:00. The value ranges from 0 to 1439.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'description' => 'The active period for the notification rule.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'Defines the notification routing rules for a subscription.', + 'title' => '', + 'example' => '', ], - 'IncidentResponsePlanForView' => [ - 'description' => '', - 'visibility' => 'Public', + 'NotifyStrategyForModify' => [ + 'title' => 'A short description of struct', + 'description' => 'The entity.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Standard"', - 'backendName' => 'type', - ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"MANUAL"', - 'backendName' => 'source', + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'groupingSetting' => [ + 'title' => '合并设置', + 'description' => 'The grouping settings.', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'description' => 'The keys used for merging.', + 'type' => 'array', + 'items' => ['description' => 'The grouping field.', 'type' => 'string', 'title' => '', 'example' => 'severity'], + 'example' => '', + ], + 'periodMin' => ['title' => '检查周期分钟数', 'description' => 'The check period in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'silenceSec' => ['title' => '沉默秒数', 'description' => 'The silence period in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'times' => ['title' => '触发次数', 'description' => 'The number of triggers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'required' => true, + 'example' => '', ], - 'escalationId' => [ - 'description' => '', - 'visibility' => 'Public', + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'description' => 'Specifies whether to send a notification upon recovery.', 'type' => 'boolean', 'example' => 'false'], + 'notifyStrategyName' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '策略名称'], + 'routes' => [ + 'title' => '通知渠道路由设置', + 'description' => 'The routing settings for the notification channel.', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"escalation-123"', - 'extendType' => 'true', + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '通知渠道', + 'description' => 'The notification channel.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'description' => 'The channel type.', + 'type' => 'string', + 'required' => true, + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + 'example' => 'CONTACT', + ], + 'enabledSubChannels' => [ + 'title' => '启用通知类型', + 'description' => 'The enabled notification types.', + 'type' => 'array', + 'items' => ['description' => 'The notification channel.', 'type' => 'string', 'title' => '', 'example' => 'SMS'], + 'example' => '', + ], + 'receivers' => [ + 'title' => '渠道接收方', + 'description' => 'The channel receivers.', + 'type' => 'array', + 'items' => ['description' => 'The specified recipient.', 'type' => 'string', 'title' => '', 'example' => 'contactId'], + 'required' => true, + 'example' => '', + ], + ], + 'description' => 'The notification channel.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'effectTimeRange' => [ + 'title' => '字段', + 'description' => 'The effective time range.', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'description' => 'The days of the week when the policy is active. Monday to Sunday.', + 'type' => 'array', + 'items' => ['description' => 'A value from 1 to 7. 1 indicates Monday and 7 indicates Sunday.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'example' => '', + ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time in minutes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '30'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time in minutes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.', 'type' => 'string', 'example' => '+08:00'], + ], + 'example' => '', + ], + 'filterSetting' => ['description' => 'The routing conditions.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'severities' => [ + 'description' => 'The list of severity levels.', + 'type' => 'array', + 'items' => ['description' => 'The severity level. Valid values: CRITICAL, WARNING, and INFO.', 'type' => 'string', 'title' => '', 'example' => 'INFO'], + 'title' => '', + 'example' => '', + ], + 'digitalEmployeeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'enableRca' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => 'The routing settings for the notification channel.', + 'title' => '', + 'example' => '', ], - 'backendName' => 'escalationId', - ], - 'repeatNotifySetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'repeatNotifySetting', - '$ref' => '#/components/schemas/RepeatNotifySetting', - ], - 'mode' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Manual"', - 'backendName' => 'mode', - ], - 'autoRecoverSeconds' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - 'backendName' => 'autoRecoverSeconds', + 'required' => true, + 'example' => '', ], - 'syncFromType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ARMS"', - 'backendName' => 'syncFromType', + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'description' => 'The notification channel template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The template details.', + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '通知类型', 'description' => 'The notification type.', 'type' => 'string', 'required' => true, 'example' => 'SMS'], + 'templateUuid' => ['title' => '模板UUID', 'description' => 'The template UUID.', 'type' => 'string', 'required' => true, 'example' => '123123-12-31-231-23-12-3123'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'enableIncidentManagement' => ['description' => 'Specifies whether to enable incident management.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'workspaceFilterSetting' => ['description' => 'The workspace filter settings.', '$ref' => '#/components/schemas/WorkspaceFilterSetting', 'title' => '', 'example' => ''], 'pushingSetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'pushingSetting', - '$ref' => '#/components/schemas/PushingSetting', - ], - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"P1-Critical-Response-Plan"', - 'backendName' => 'name', - ], - 'uuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - 'backendName' => 'uuid', - ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', - ], - 'description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['description' => 'The message template UUID.', 'type' => 'string', 'title' => '', 'example' => '模板 UUID'], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The alert action ID.', 'type' => 'string', 'title' => '', 'example' => '["action-123", "action-456"]'], + 'description' => 'The list of alert action IDs.', + 'title' => '', + 'example' => '', + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The restore action ID.', 'type' => 'string', 'title' => '', 'example' => '["restore-789"]'], + 'description' => 'The list of restore action IDs.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The push settings.', + 'title' => '', 'example' => '', - 'backendName' => 'description', - ], - 'enabled' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', ], - 'createTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"2025-04-05T10:30:00Z"', - 'backendName' => 'createTime', + 'repeatNotifySetting' => [ + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['description' => 'The incident state that stops the repeated notifications.', 'type' => 'string', 'title' => '', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => 'The interval for repeated notifications.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], + ], + 'description' => 'The settings for repeated notifications.', + 'title' => '', + 'example' => '', ], - 'updateTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"2025-04-06T09:15:00Z"', - 'backendName' => 'updateTime', + 'autoRecoverSeconds' => ['description' => 'The auto-recovery time in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '300'], + 'escalationId' => [ + 'type' => 'array', + 'items' => ['description' => 'The escalation policy ID.', 'type' => 'string', 'title' => '', 'example' => '["escalation-123", "escalation-456"]'], + 'description' => 'The list of escalation policy IDs.', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], - 'IncidentStruct' => [ - 'description' => 'A core structure representing a complete incident.', - 'visibility' => 'Public', + 'NotifyStrategyForSNSModify' => [ + 'title' => '', + 'description' => 'The notifyStrategy sub-entity input parameters used for the SubscriptionAndNotifyStrategy aggregate operation.'."\n" + .'Differences from the legacy NotifyStrategyForModify:'."\n" + .'- Removed filterSetting / workspaceFilterSetting (now carried by sns.subscription).'."\n" + .'- Removed pushingSetting / repeatNotifySetting / autoRecoverSeconds / escalationId (now carried by sns.responsePlan).'."\n" + .'- Does not expose uuid / mode / syncFromType / incidentResponsePlanId / enabled (forcibly overwritten by the backend).', 'type' => 'object', 'properties' => [ - 'severity' => [ - 'description' => 'Incident severity level.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'P1', - 'backendName' => 'severity', + 'description' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'groupingSetting' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', + ], + 'periodMin' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'silenceSec' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'times' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + ], + 'required' => true, + 'description' => '', + 'example' => '', ], - 'escalations' => [ - 'description' => 'List of escalation policies.', - 'visibility' => 'Public', + 'ignoreRestoredNotification' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'enableIncidentManagement' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'routes' => [ + 'title' => '', 'type' => 'array', 'items' => [ - 'description' => 'Incident escalation structure.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/IncidentEscalationStruct', - ], - 'backendName' => 'escalations', - ], - 'resource' => [ - 'description' => 'Associated resource details.', - 'visibility' => 'Public', - 'backendName' => 'resource', - '$ref' => '#/components/schemas/IncidentResourceDetail', - ], - 'incidentPlan' => [ - 'description' => 'Associated incident contingency plan.', - 'visibility' => 'Public', - 'backendName' => 'plan', - '$ref' => '#/components/schemas/IncidentPlanStruct', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', - ], - 'title' => [ - 'description' => 'Title.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Excessively high database connection count.'."\n", - 'backendName' => 'title', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'userId', - ], - 'content' => [ - 'description' => 'Content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Detected that the connection count of RDS instance rds-bp1234567890abcdef has reached 1000, triggering an alert.'."\n", - 'backendName' => 'content', - ], - 'status' => [ - 'description' => 'Status.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OPEN', - 'backendName' => 'status', - ], - ], - ], - 'IncidentTimeline' => [ - 'description' => 'A structure used to record timeline nodes during incident handling.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'childType' => [ - 'description' => 'Subtype.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'comment', - 'backendName' => 'childType', - ], - 'incidentTimelineId' => [ - 'description' => 'Timeline node unique ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'timeline-001', - 'backendName' => 'incidentItemToken', - ], - 'timelineId' => [ - 'description' => 'Parent timeline ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'timeline-main-001', - 'backendName' => 'timelineUuid', - ], - 'time' => [ - 'description' => 'Time.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1741234567890', - 'backendName' => 'time', - ], - 'incidentId' => [ - 'description' => 'Incident ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-001', - 'backendName' => 'incidentUuid', - ], - 'title' => [ - 'description' => 'Title.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The operations team has been contacted.'."\n", - 'backendName' => 'title', - ], - 'type' => [ - 'description' => 'Type.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ACTION', - 'backendName' => 'type', - ], - 'userId' => [ - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'userId', + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '', + 'type' => 'string', + 'description' => '', + 'example' => '', + 'required' => true, + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + ], + 'enabledSubChannels' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', + ], + 'receivers' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'description' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', + ], + 'effectTimeRange' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'description' => '', + 'example' => '', + ], + 'endTimeInMinute' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'startTimeInMinute' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'timeZone' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'filterSetting' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'conditions' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'op' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'value' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'maxItems' => 10, + 'description' => '', + 'example' => '', + ], + 'expression' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'relation' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'severities' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', + ], + 'digitalEmployeeName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'enableRca' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'description' => '', + 'example' => '', ], - 'content' => [ - 'description' => 'Content.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The operations team has been notified to investigate.'."\n", - 'backendName' => 'content', + 'customTemplateEntries' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => '', 'required' => false], + 'templateUuid' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => '', 'required' => false], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', ], ], + 'example' => '', ], - 'IncidentTimelineForView' => [ - 'description' => '', - 'visibility' => 'Public', + 'NotifyStrategyForSNSView' => [ + 'title' => 'SNS 内嵌的通知策略查看视图', + 'description' => 'The value of the `SubscriptionAndNotifyStrategyForView.notifyStrategy` sub-field.', 'type' => 'object', 'properties' => [ - 'incidentUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', - 'backendName' => 'incidentUuid', - ], - 'userId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"user-abc123"', - 'backendName' => 'userId', - ], - 'time' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743876000000', - 'backendName' => 'time', - ], - 'timelineUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"', - 'backendName' => 'timelineUuid', - ], - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Comment"', - 'backendName' => 'type', - ], - 'changeType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Open -> In Progress"', - 'backendName' => 'changeType', - ], - 'title' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'notifyStrategyId' => ['title' => 'uuid（= SNS uuid，D8）', 'description' => 'The ID of the notification strategy.', 'type' => 'string', 'example' => ''], + 'notifyStrategyName' => ['title' => '名称', 'description' => 'The name of the notification strategy.', 'type' => 'string', 'example' => ''], + 'description' => ['title' => '描述', 'description' => 'The description of the notification strategy.', 'type' => 'string', 'example' => ''], + 'enable' => ['title' => '是否启用', 'description' => 'Specifies whether to enable the notification strategy. Valid values: true, false.', 'type' => 'boolean', 'example' => ''], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'type' => 'string', 'example' => ''], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace to which the notification strategy belongs.', 'type' => 'string', 'example' => ''], + 'syncFromType' => ['title' => '同步来源（SNS 新建必为 OBS）', 'description' => 'The source from which the strategy is synchronized.', 'type' => 'string', 'example' => ''], + 'mode' => ['title' => '生命周期模式（SNS 内必为 BundleStrategy）', 'description' => 'The mode of the notification strategy.', 'type' => 'string', 'example' => ''], + 'enableIncidentManagement' => ['title' => '是否启用事件管理', 'description' => 'Specifies whether to enable incident management. Valid values: true, false.', 'type' => 'boolean', 'example' => ''], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'description' => 'Specifies whether to ignore notifications for restored alerts. Valid values: true, false.', 'type' => 'boolean', 'example' => ''], + 'incidentResponsePlanId' => ['title' => '关联响应计划 uuid（= notifyStrategyId）', 'description' => 'The ID of the incident response plan.', 'type' => 'string', 'example' => ''], + 'groupingSetting' => [ + 'title' => '合并设置', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'type' => 'array', + 'items' => ['description' => 'A grouping key. For example, \'alertname\'.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The keys for grouping alerts.', + 'example' => '', + ], + 'periodMin' => ['title' => '检查周期分钟数', 'description' => 'The time window in minutes for grouping alerts.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'silenceSec' => ['title' => '沉默秒数', 'description' => 'The silence period in seconds after a notification is sent for a group.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'times' => ['title' => '触发次数', 'description' => 'The number of times to send notifications for a group.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + ], + 'description' => 'The settings for alert grouping.', 'example' => '', - 'backendName' => 'title', - ], - 'content' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '"{"action":"restart","resourceId":"i-bp123456"}"', - 'backendName' => 'content', ], - 'workspace' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-xyz789"', - 'backendName' => 'workspace', + 'routes' => [ + 'title' => '通知渠道路由设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '通知渠道', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'description' => 'The type of the notification channel, such as \'sms\' or \'email\'.', + 'type' => 'string', + 'example' => '', + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + ], + 'enabledSubChannels' => [ + 'title' => '启用通知类型', + 'type' => 'array', + 'items' => ['description' => 'An enabled sub-channel.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The enabled sub-channels.', + 'example' => '', + ], + 'receivers' => [ + 'title' => '渠道接收方', + 'type' => 'array', + 'items' => ['description' => 'A receiver, which can be a user ID or a contact group ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The list of receivers for the channel.', + 'example' => '', + ], + ], + 'description' => 'The configuration for a single notification channel.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The notification channels for the route.', + 'example' => '', + ], + 'effectTimeRange' => [ + 'title' => '生效时段', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'type' => 'array', + 'items' => ['description' => 'A day of the week, where 1 represents Monday and 7 represents Sunday.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'description' => 'The days of the week when the route is active.', + 'example' => '', + ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time of the active period, specified in minutes from 00:00.', 'type' => 'integer', 'example' => '', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time of the active period, specified in minutes from 00:00.', 'type' => 'integer', 'example' => '', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone for the active period. For example, \'Asia/Shanghai\'.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'The time range during which the notification route is active.', + 'example' => '', + ], + 'filterSetting' => ['title' => '路由级 filter', 'description' => 'The filter settings for the route.', 'example' => '', '$ref' => '#/components/schemas/FilterSetting'], + 'severities' => [ + 'title' => '等级过滤', + 'type' => 'array', + 'items' => ['description' => 'An alert severity level, such as \'P1\' or \'Critical\'.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The alert severities that trigger this route.', + 'example' => '', + ], + 'digitalEmployeeName' => ['title' => '数字员工名', 'description' => 'The name of the digital employee assigned to this route.', 'type' => 'string', 'example' => ''], + 'enableRca' => ['title' => '是否启用 RCA', 'description' => 'Specifies whether to enable root cause analysis (RCA) for alerts that match this route. Valid values: true, false.', 'type' => 'boolean', 'example' => ''], + ], + 'description' => 'The configuration for a single notification route.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of notification routes.', + 'example' => '', ], - 'operator' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'operator', - '$ref' => '#/components/schemas/ContactForIncidentView', + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '通知类型', 'description' => 'The target type for the custom template.', 'type' => 'string', 'example' => ''], + 'templateUuid' => ['title' => '模板UUID', 'description' => 'The unique identifier (UUID) of the template.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'The settings for a custom template entry.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of custom templates.', + 'example' => '', ], + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time of the notification strategy.', 'type' => 'string', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'description' => 'The last update time of the notification strategy.', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], - 'MaintainWindowForModify' => [ + 'NotifyStrategyForView' => [ 'title' => 'A short description of struct', - 'description' => 'Silencing policy object.', - 'visibility' => 'Public', + 'description' => 'An entity used for viewing.', 'type' => 'object', 'properties' => [ - 'effective' => [ - 'title' => '', - 'description' => 'Crontab expression.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '* * 14-18 ? * *', - 'backendName' => 'effective', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filtering conditions.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'maintainWindowName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test strategy', - 'backendName' => 'maintainWindowName', - ], - 'startTime' => [ - 'title' => '', - 'description' => 'Effective start time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-11 07:55:00', - 'backendName' => 'startTime', - ], - 'effectTimeRange' => [ - 'description' => 'Effective time range.', - 'visibility' => 'Public', + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the policy is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'groupingSetting' => [ + 'title' => '合并设置', + 'description' => 'The merge settings.', 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '', - 'description' => 'Start time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'startTimeInMinute', - ], - 'timeZone' => [ - 'title' => '', - 'description' => 'Time zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+08:00', - 'backendName' => 'timeZone', + 'groupingKeys' => [ + 'title' => '合并keys', + 'description' => 'The merge keys.', + 'type' => 'array', + 'items' => ['description' => 'The merge key.', 'type' => 'string', 'title' => '', 'example' => 'severity'], + 'example' => '', ], - 'dayInWeek' => [ - 'title' => '', - 'description' => 'Effective days (Monday to Sunday).', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '0–6 represents Sunday to Saturday.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'extendType' => 'true', + 'periodMin' => ['title' => '检查周期分钟数', 'description' => 'The check period in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'silenceSec' => ['title' => '沉默秒数', 'description' => 'The silence period in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'times' => ['title' => '触发次数', 'description' => 'The number of triggers.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], + 'required' => true, + 'example' => '', + ], + 'ignoreRestoredNotification' => ['title' => '恢复是否通知', 'description' => 'Indicates whether to send a notification upon recovery.', 'type' => 'boolean', 'example' => 'true'], + 'notifyStrategyName' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '测试策略'], + 'routes' => [ + 'title' => '通知渠道路由设置', + 'description' => 'The routing settings for notification channels.', + 'type' => 'array', + 'items' => [ + 'description' => 'The routing object.', + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '通知渠道', + 'description' => 'The notification channels.', + 'type' => 'array', + 'items' => [ + 'description' => 'The notification channel.', + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'description' => 'The channel type.', + 'type' => 'string', + 'required' => true, + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK', 'TEAMS', 'CONTACT', 'GROUP', 'DUTY', 'DING_COOL_APP'], + 'example' => 'CONTACT', + ], + 'enabledSubChannels' => [ + 'title' => '启用通知类型', + 'description' => 'The enabled notification types.', + 'type' => 'array', + 'items' => ['description' => 'The channel.', 'type' => 'string', 'title' => '', 'example' => 'SMS'], + 'example' => '', + ], + 'receivers' => [ + 'title' => '渠道接收方', + 'description' => 'The channel receivers.', + 'type' => 'array', + 'items' => ['description' => 'The receiver.', 'type' => 'string', 'title' => '', 'example' => 'user1'], + 'required' => true, + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'backendName' => 'dayInWeek', - ], - 'endTimeInMinute' => [ - 'title' => '', - 'description' => 'End time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'endTimeInMinute', + 'effectTimeRange' => [ + 'title' => '字段', + 'description' => 'The field.', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'description' => 'The days of the week when the policy is effective (Monday to Sunday).', + 'type' => 'array', + 'items' => ['description' => 'The day of the week. 1 indicates Monday, and 7 indicates Sunday.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'example' => '', + ], + 'endTimeInMinute' => ['title' => '结束时间(分钟数)', 'description' => 'The end time in minutes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1439', 'minimum' => '0', 'example' => '60'], + 'startTimeInMinute' => ['title' => '开始时间(分钟数)', 'description' => 'The start time in minutes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1438', 'minimum' => '0', 'example' => '60'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.', 'type' => 'string', 'example' => '+08:00'], + ], + 'example' => '', + ], + 'filterSetting' => ['description' => 'The routing settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'severities' => [ + 'description' => 'The list of severity levels.', + 'type' => 'array', + 'items' => ['description' => 'The severity level. Valid values: CRITICAL, WARNING, and INFO.', 'type' => 'string', 'title' => '', 'example' => 'INFO'], + 'title' => '', + 'example' => '', + ], + 'digitalEmployeeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'enableRca' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - 'backendName' => 'effectTimeRange', - ], - 'endTime' => [ - 'title' => '', - 'description' => 'Effective end time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-09-05 09:30:40', - 'backendName' => 'endTime', - ], - ], - ], - 'MaintainWindowForView' => [ - 'title' => 'A short description of struct', - 'description' => 'Silencing policy object.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'maintainWindowId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123-12-312-31-23123', - 'backendName' => 'maintainWindowId', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filtering conditions.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'maintainWindowName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', 'required' => true, - 'example' => 'Test policy.'."\n", - 'backendName' => 'maintainWindowName', + 'example' => '', ], - 'updateTime' => [ - 'title' => '', - 'description' => 'Update time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-05-07T02:19:05Z', - 'backendName' => 'updateTime', + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'description' => 'The notification channel templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The notification template configuration.', + 'type' => 'object', + 'properties' => [ + 'targetType' => ['title' => '通知类型', 'description' => 'The notification type.', 'type' => 'string', 'required' => true, 'example' => 'SMS'], + 'templateUuid' => ['title' => '模板UUID', 'description' => 'The template UUID.', 'type' => 'string', 'required' => true, 'example' => '123-12-312-312-31-23'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'effectTimeRange' => [ - 'description' => 'Effective time range.', - 'visibility' => 'Public', + 'updateTime' => ['title' => '更新时间', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-05-30T02:29:09Z'], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'type' => 'string', 'example' => '123123****'], + 'notifyStrategyId' => ['title' => 'UUID', 'description' => 'The UUID.', 'type' => 'string', 'example' => '12312-31-23-123-1-23123'], + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'workspace-test'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'workspaceFilterSetting' => ['description' => 'The workspace filter settings.', '$ref' => '#/components/schemas/WorkspaceFilterSetting', 'title' => '', 'example' => ''], + 'pushingSetting' => [ 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '', - 'description' => 'Start time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'startTimeInMinute', - ], - 'timeZone' => [ + 'templateUuid' => ['description' => 'The template UUID.', 'type' => 'string', 'title' => '', 'example' => '"template-abc123"'], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The alert action ID.', 'type' => 'string', 'title' => '', 'example' => '"action-123"'], + 'description' => 'The list of alert action IDs.', 'title' => '', - 'description' => 'Time Zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+08:00', - 'backendName' => 'timeZone', + 'example' => '', ], - 'dayInWeek' => [ - 'title' => '', - 'description' => 'Effective days (Monday to Sunday).', - 'visibility' => 'Public', + 'restoreActionIds' => [ 'type' => 'array', - 'items' => [ - 'description' => '0–6 denotes Sunday to Saturday.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'extendType' => 'true', - ], - 'backendName' => 'dayInWeek', - ], - 'endTimeInMinute' => [ + 'items' => ['description' => 'The recovery action ID.', 'type' => 'string', 'title' => '', 'example' => '"restore-789"'], + 'description' => 'The list of recovery action IDs.', 'title' => '', - 'description' => 'End time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '360', - 'backendName' => 'endTimeInMinute', + 'example' => '', ], ], - 'backendName' => 'effectTimeRange', - ], - 'userId' => [ - 'title' => '', - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '12312312***', - 'backendName' => 'userId', - ], - 'effective' => [ - 'title' => '', - 'description' => 'Crontab expression.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '* * 14-18 ? * *', - 'backendName' => 'effective', - ], - 'createTime' => [ + 'description' => 'The push settings.', 'title' => '', - 'description' => 'Creation time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', + 'example' => '', ], - 'enable' => [ + 'repeatNotifySetting' => [ + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['description' => 'The event state at which to stop.', 'type' => 'string', 'title' => '', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => 'The interval for repeated notifications.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], + ], + 'description' => 'The settings for repeated notifications.', 'title' => '', - 'description' => 'Whether enabled.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', + 'example' => '', ], - 'startTime' => [ + 'autoRecoverSeconds' => ['description' => 'The automatic recovery time.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '300'], + 'syncFromType' => ['description' => 'The source type of the synchronization policy.', 'type' => 'string', 'title' => '', 'example' => '"ARMS"'], + 'receiverNames' => [ + 'type' => 'array', + 'items' => ['description' => 'The receiver name.', 'type' => 'string', 'title' => '', 'example' => '"张三"'], + 'description' => 'The list of receiver names.', 'title' => '', - 'description' => 'Effective start time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-11-26 10:02:01', - 'backendName' => 'startTime', + 'example' => '', ], - 'endTime' => [ + 'incidentEscalationPolicies' => [ + 'type' => 'array', + 'items' => ['description' => 'The escalation policy.', 'type' => 'any', 'title' => '', 'example' => '{ "name": "Critical-Escalation"}'], + 'description' => 'The list of associated escalation policies.', 'title' => '', - 'description' => 'Effective end time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-11-26 12:02:01', - 'backendName' => 'endTime', + 'example' => '', ], ], + 'example' => '', ], - 'MergeContact' => [ - 'description' => '', - 'visibility' => 'Public', + 'NotifyStrategyIdFilter' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'gmtModified' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtModified', - ], - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'eq' => ['title' => '', 'description' => 'The exact ID of the notification strategy to retrieve.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'Filters notification strategies by ID.', + 'example' => '', + ], + 'ObserveGroup' => [ + 'type' => 'object', + 'properties' => [ + 'groupId' => ['title' => '', 'description' => 'The globally unique ID of the observability group. Format: og-<16-character hash>. Used uniformly across metrics, alerts, and consoles.', 'type' => 'string', 'example' => ''], + 'groupName' => ['title' => '', 'description' => 'The name of the observability group. Must be unique within the same workspace.', 'type' => 'string', 'example' => ''], + 'description' => ['title' => '', 'description' => 'The description of the observability group, which explains its business purpose.', 'type' => 'string', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The Alibaba Cloud resource group ID.', 'type' => 'string', 'example' => ''], + 'aliUid' => ['title' => '', 'description' => 'The UID of the Alibaba Cloud account to which the group belongs.', 'type' => 'string', 'example' => ''], + 'regionId' => ['title' => '', 'description' => 'The region ID to which the group belongs.', 'type' => 'string', 'example' => ''], + 'createTime' => ['title' => '', 'description' => 'The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => ''], + 'modifyTime' => ['title' => '', 'description' => 'The last modification time in UTC format: yyyy-MM-ddTHH:mm:ssZ. Automatically updated when any resource attribute changes.', 'type' => 'string', 'example' => ''], + 'groupType' => ['title' => '', 'description' => 'The type of the observability group.', 'type' => 'string', 'example' => ''], + 'discoverRules' => [ + 'title' => '', + 'description' => 'The list of entity discovery rules that define which entities the group automatically matches.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ObserveGroupDiscoverRule'], 'example' => '', - 'backendName' => 'name', - ], - 'gmtCreate' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtCreate', - ], - 'identifier' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'backendName' => 'identifier', - ], - 'phoneCode' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '86', - 'backendName' => 'phoneCode', - ], - 'phone' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '13800138000', - 'backendName' => 'phone', - 'sensitive' => true, - ], - 'phoneVerify' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'phoneVerify', - ], - 'email' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zhangsan@company.com', - 'backendName' => 'email', - 'sensitive' => true, - ], - 'emailVerify' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'emailVerify', ], - 'lang' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh-CN', - 'backendName' => 'lang', + 'extraInfo' => ['title' => '', 'description' => 'The extended information as a JSON string, which carries alert templates, alert contact groups, and suspension policies.', 'type' => 'string', 'example' => ''], + 'workspaceId' => ['title' => '', 'description' => 'The workspace ID to which the group belongs. This value is set at the workspace level and cannot be changed after creation.', 'type' => 'string', 'example' => ''], + 'sourceOrigin' => ['title' => '', 'description' => 'The data source. Valid values:'."\n" + .'- native_2_0: created natively in version 2.0.'."\n" + .'- synced_from_1_0: synchronized from a version 1.0 application group.', 'type' => 'string', 'example' => ''], + 'originGroupId' => ['title' => '', 'description' => 'The product_group.id of the version 1.0 application group. This parameter is valid only when sourceOrigin is set to synced_from_1_0.', 'type' => 'string', 'example' => ''], + 'entityCounts' => [ + 'title' => '', + 'description' => 'The number of entities in each category. The key is the category domain (acs for cloud services, apm, or rum, which is extensible). The value is the number of entities in that category that belong to this group. Returned only when withEntityCount is set to true.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'example' => '', ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'source', + 'health' => ['title' => '', 'description' => 'The health status of the group. Valid values:'."\n" + .'- -1: unknown (placeholder).'."\n" + .'- 1: healthy.'."\n" + .'- 0: unhealthy.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'favorited' => ['title' => '', 'description' => 'Indicates whether the current user has followed this group. This value is used as the filter criterion for the My Favorites feature.', 'type' => 'boolean', 'example' => ''], + 'ogEntityInfoEnabled' => ['title' => '', 'description' => 'Specifies whether og_entity_info metric output is enabled. When enabled, the data plane writes the group membership information to the target Prometheus instance.', 'type' => 'boolean', 'example' => ''], + 'ogEntityInfoPromInstances' => [ + 'title' => '', + 'description' => 'The set of Prometheus instances to which og_entity_info is written. Includes two source types: system (automatically identified by the system) and custom (user-defined).', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ObserveGroupPromInstance', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], - 'extend' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', + 'tags' => [ + 'title' => '', + 'description' => 'The resource tags (Alibaba Cloud standard tags) as an array of key-value pairs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => ''], + 'tagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'example' => '', - 'backendName' => 'extend', ], ], - ], - 'MergeContactGroup' => [ 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'example' => '', + ], + 'ObserveGroupDetail' => [ 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'groupId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'groupName' => ['title' => '', 'description' => 'The name of the observability group. The name must be unique within the same workspace.', 'type' => 'string', 'example' => ''], + 'description' => ['title' => '', 'description' => 'The description of the observability group, which explains its business purpose.', 'type' => 'string', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The Alibaba Cloud resource group ID.', 'type' => 'string', 'example' => ''], + 'aliUid' => ['title' => '', 'description' => 'The UID of the Alibaba Cloud account to which the group belongs.', 'type' => 'string', 'example' => ''], + 'regionId' => ['title' => '', 'description' => 'The region ID of the group.', 'type' => 'string', 'example' => ''], + 'groupType' => ['title' => '', 'description' => 'The type of the observability group.', 'type' => 'string', 'example' => ''], + 'createTime' => ['title' => '', 'description' => 'The time when the group was created, in UTC format (yyyy-MM-ddTHH:mm:ssZ).', 'type' => 'string', 'example' => ''], + 'modifyTime' => ['title' => '', 'description' => 'The time when the group was last modified, in UTC format (yyyy-MM-ddTHH:mm:ssZ). This value is automatically updated when any property of the resource changes.', 'type' => 'string', 'example' => ''], + 'discoverRules' => [ + 'title' => '', + 'description' => 'The list of entity discovery rules that define which entities the group automatically matches.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ObserveGroupDiscoverRule'], 'example' => '', - 'backendName' => 'name', - ], - 'gmtModified' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtCreate', ], - 'identifier' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'group-12345', - 'backendName' => 'identifier', - ], - 'gmtCreate' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'plan', - ], - 'contacts' => [ - 'description' => '', - 'visibility' => 'Public', + 'extraInfo' => ['title' => '', 'description' => 'The extended information in JSON string format, which carries alert templates, alert contact groups, suspension policies, and other configurations.', 'type' => 'string', 'example' => ''], + 'workspaceId' => ['title' => '', 'description' => 'The workspace ID to which the group belongs. This value is set at the workspace level and cannot be changed after the group is created.', 'type' => 'string', 'example' => ''], + 'sourceOrigin' => ['title' => '', 'description' => 'The data source. Valid values:'."\n" + .'- native_2_0: created natively in version 2.0.'."\n" + .'- synced_from_1_0: synchronized from a version 1.0 application group.', 'type' => 'string', 'example' => ''], + 'originGroupId' => ['title' => '', 'description' => 'The product_group.id of the version 1.0 application group. This parameter is valid only when sourceOrigin is set to synced_from_1_0.', 'type' => 'string', 'example' => ''], + 'entitySummaries' => [ + 'title' => '', + 'description' => 'The statistics of entities in the group, categorized by entity type.', 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'entityDomain' => ['title' => '', 'description' => 'The entity domain.', 'type' => 'string', 'example' => ''], + 'entityType' => ['title' => '', 'description' => 'The entity type.', 'type' => 'string', 'example' => ''], + 'entityCount' => ['title' => '', 'description' => 'The number of entities.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'entityCategory' => ['title' => '', 'description' => 'The entity category.', 'type' => 'string', 'example' => ''], + ], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user-12345', - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'contacts', + 'example' => '', ], - 'extend' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', + 'favorited' => ['title' => '', 'description' => 'Indicates whether the current user has followed the group.', 'type' => 'boolean', 'example' => ''], + 'ogEntityInfoEnabled' => ['title' => '', 'description' => 'Specifies whether to enable the og_entity_info metric output. When enabled, the data plane writes the group ownership information to the target Prometheus instance.', 'type' => 'boolean', 'example' => ''], + 'ogEntityInfoPromInstances' => [ + 'title' => '', + 'description' => 'The set of Prometheus instances to which og_entity_info is written. This includes two source types: system (automatically identified by the system) and custom (user-defined).', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ObserveGroupPromInstance', 'description' => '', 'title' => '', 'example' => ''], 'example' => '', - 'backendName' => 'extend', ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'source', + 'tags' => [ + 'title' => '', + 'description' => 'The resource tags (Alibaba Cloud standard tags), represented as an array of key-value pairs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => ''], + 'tagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - ], - 'MergeRobot' => [ 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'example' => '', + ], + 'ObserveGroupDiscoverRule' => [ 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'ruleId' => ['title' => '', 'description' => 'The stable rule ID used as an anchor for editing, deleting, and enabling or disabling operations. Format: dr-<16-character hash>.', 'type' => 'string', 'example' => ''], + 'ruleType' => ['title' => '', 'description' => 'The matching method. Valid values: byTag, byResourceGroup, byInstanceName, byManual, and bySpl.', 'type' => 'string', 'example' => ''], + 'scope' => ['title' => '', 'description' => 'The applicable scope. Valid values: all (all entity types, exclusive) and entity (specified entity types).', 'type' => 'string', 'example' => ''], + 'enabled' => ['title' => '', 'description' => 'Indicates whether the rule is enabled. If set to false, the data plane skips this rule and does not perform matching, tagging, or delivery.', 'type' => 'boolean', 'example' => ''], + 'gmtCreate' => ['title' => '', 'description' => 'The time when the rule was created, in UNIX millisecond timestamp format. This value is used for display in the console.', 'type' => 'integer', 'example' => '', 'format' => 'int64'], + 'entityType' => ['title' => '', 'description' => 'The entity type (legacy). Retained for backward compatibility. Use entityTypes instead.', 'type' => 'string', 'example' => ''], + 'entityTypes' => [ + 'title' => '', + 'description' => 'The list of entity types. A single rule can match multiple types, such as acs.ecs.instance, acs.rds.instance, and acs.arms.service.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'example' => '', - 'backendName' => 'name', - ], - 'webhook' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', - 'backendName' => 'webhook', - ], - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'type', - ], - 'createTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtCreate', - ], - 'gmtModified' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtModified', - ], - 'identifier' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'robot-12345', - 'backendName' => 'identifier', - ], - 'lang' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh-CN', - 'backendName' => 'lang', ], - 'extend' => [ - 'description' => '', - 'visibility' => 'Public', + 'spl' => ['title' => '', 'description' => 'The full SPL expression for advanced configuration. If this parameter is not empty, it takes precedence over other filter fields.', 'type' => 'string', 'example' => ''], + 'userId' => ['title' => '', 'description' => 'The UID of the user to whom the rule belongs.', 'type' => 'string', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The resource group ID used for filtering.', 'type' => 'string', 'example' => ''], + 'tagRules' => [ + 'title' => '', + 'description' => 'The tag matching rules.', 'type' => 'object', 'properties' => [ - 'dailyNoc' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'dailyNoc', - ], - 'dingSignKey' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'abc123', - 'backendName' => 'dingSignKey', - ], - 'enableOutgoing' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enableOutgoing', - ], - 'cardTemplate' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'incident-card-template', - 'backendName' => 'cardTemplate', - ], - 'dailyNocTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '09:00', - 'backendName' => 'dailyNocTime', + 'op' => ['title' => '', 'description' => 'The tag matching logic.', 'type' => 'string', 'example' => ''], + 'tags' => [ + 'title' => '', + 'description' => 'The tag condition list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => ''], + 'op' => ['title' => '', 'description' => 'The matching operation.', 'type' => 'string', 'example' => ''], + 'tagValues' => [ + 'title' => '', + 'description' => 'The tag value list.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'token' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'token-abc123', - 'backendName' => 'token', - 'sensitive' => true, + ], + 'example' => '', + ], + 'nameRules' => [ + 'title' => '', + 'description' => 'The name matching rules.', + 'type' => 'object', + 'properties' => [ + 'op' => ['title' => '', 'description' => 'The name matching logic.', 'type' => 'string', 'example' => ''], + 'tags' => [ + 'title' => '', + 'description' => 'The name condition list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'op' => ['title' => '', 'description' => 'The matching operation.', 'type' => 'string', 'example' => ''], + 'tagValues' => [ + 'title' => '', + 'description' => 'The matching value list.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - 'backendName' => 'extend', + 'example' => '', ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'source', + 'instanceIds' => [ + 'title' => '', + 'description' => 'The list of manually specified instance IDs in enumeration mode, including instances synchronized manually in version 1.0.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'regionIds' => [ + 'title' => '', + 'description' => 'The list of region IDs used for filtering by region.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], ], - ], - 'MergeWebhook' => [ 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'example' => '', + ], + 'ObserveGroupInstance' => [ 'type' => 'object', 'properties' => [ - 'gmtCreate' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtCreate', - ], - 'name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'entityDomain' => ['title' => '', 'description' => 'The entity domain (such as acs).', 'type' => 'string', 'example' => ''], + 'entityType' => ['title' => '', 'description' => 'The entity type (such as acs.ecs.instance).', 'type' => 'string', 'example' => ''], + 'instanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => ''], + 'instanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => ''], + 'regionId' => ['title' => '', 'description' => 'The region ID of the instance.', 'type' => 'string', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The resource group ID of the instance.', 'type' => 'string', 'example' => ''], + 'userId' => ['title' => '', 'description' => 'The UID of the user to which the instance belongs.', 'type' => 'string', 'example' => ''], + 'category' => ['title' => '', 'description' => 'The entity category (adapted by entityType).', 'type' => 'string', 'example' => ''], + 'groupId' => ['title' => '', 'description' => 'The ID of the observation group to which the entity belongs.', 'type' => 'string', 'example' => ''], + 'tags' => [ + 'title' => '', + 'description' => 'The key-value pairs of instance tags.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'example' => '', - 'backendName' => 'name', ], - 'gmtModified' => [ - 'description' => '', - 'visibility' => 'Public', + 'dimension' => [ + 'title' => '', + 'description' => 'The key-value pairs of monitoring dimensions.', 'type' => 'object', - 'example' => '2025-03-11T08:21:58.789Z', - 'backendName' => 'gmtModified', - ], - 'identifier' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'webhook-12345', - 'backendName' => 'identifier', - ], - 'webhook' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', - 'backendName' => 'webhook', - ], - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'type', - ], - 'headers' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"Authorization": "Bearer abc123"}', - 'backendName' => 'headers', - ], - 'method' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'POST', - 'backendName' => 'method', - ], - 'contentType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'application/json', - 'backendName' => 'contentType', - ], - 'lang' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh-CN', - 'backendName' => 'lang', - ], - 'extend' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"timeout": 3000}', - 'backendName' => 'extend', - ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dingtalk', - 'backendName' => 'source', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'NotifyChannel' => [ + 'ObserveGroupPromInstance' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'The ID of the Managed Service for Prometheus instance, such as rw-xxxxxxxxxx.', 'type' => 'string', 'example' => ''], + 'region' => ['title' => '', 'description' => 'The region where the Managed Service for Prometheus instance resides. If this parameter is left empty, the backend automatically populates the region based on the workspace to which the application group belongs.', 'type' => 'string', 'example' => ''], + 'kind' => ['title' => '', 'description' => 'The source of the instance. Valid values:'."\n" + .'- system: The system automatically identifies the instance based on the workspace or UModel.'."\n" + .'- custom: The user manually selects the instance in the console.', 'type' => 'string', 'example' => ''], + 'time' => ['title' => '', 'description' => 'The time when the record was written or selected. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => ''], + ], 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'example' => '', + ], + 'ObserveResourceGlobalScopeFilter' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'channelType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"DingTalk"', - 'backendName' => 'channelType', - ], - 'receivers' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[]', - 'extendType' => 'true', - ], - 'backendName' => 'receivers', - ], - 'enabledSubChannels' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[]', - 'extendType' => 'true', - ], - 'backendName' => 'enabledSubChannels', - ], + 'eq' => ['title' => '', 'description' => 'Specifies whether to retrieve only resources that are exclusive to the global scope.', 'type' => 'boolean', 'example' => ''], ], + 'description' => 'Defines the filter criteria for resources within the global scope.', + 'example' => '', ], - 'NotifyStrategyForModify' => [ - 'title' => 'A short description of struct', - 'description' => 'Entity for viewing.', - 'visibility' => 'Public', + 'ObserveResourceListFilter' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'routes' => [ + 'contains' => [ 'title' => '', - 'description' => 'Notification channel routing configuration.', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'channels' => [ - 'title' => '', - 'description' => 'Notification channel.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'enabledSubChannels' => [ - 'title' => '', - 'description' => 'Enabled notification types.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Notification channel.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SMS', - 'extendType' => 'true', - ], - 'backendName' => 'enabledSubChannels', - ], - 'receivers' => [ - 'title' => '', - 'description' => 'Channel recipient.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Designated recipient.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'contactId', - 'extendType' => 'true', - ], - 'required' => true, - 'backendName' => 'receivers', - ], - 'channelType' => [ + 'items' => ['description' => 'A string value to match.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'Returns resources if a specified property contains any string in this array.', + 'example' => '', + ], + ], + 'description' => 'Filters for observed resources.', + 'example' => '', + ], + 'ObserveResourceTypeFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '', 'description' => 'The exact resource type to query. Returns only resources of this type.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'A filter for a resource type.', + 'example' => '', + ], + 'Pagination' => [ + 'description' => 'Details of the paginated response.', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'title' => '', + 'example' => '', + ], + 'PartitionKeyFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'eq' => ['title' => '', 'description' => 'Returns only items whose partition key value equals this string.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'This filter routes requests directly to the correct physical partition, greatly improving query speed and lowering costs.', + 'example' => '', + ], + 'PrometheusManagedInstance' => [ + 'description' => 'The structure of a Prometheus managed instance.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['title' => 'RUM关联的Prometheus实例ID', 'description' => 'The ID of the Prometheus instance that is associated with Real User Monitoring (RUM).', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'prometheusInstanceId', 'example' => 'rum-xxx'], + 'prometheusInstanceName' => ['title' => 'RUM关联的Prometheus实例名称', 'description' => 'The name of the Prometheus instance that is associated with RUM.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'prometheusInstanceName', 'example' => 'rum-xxx'], + 'regionId' => ['title' => '阿里云RegionId', 'description' => 'The ID of the Alibaba Cloud region.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'regionId', 'example' => 'cn-hangzhou'], + 'workspace' => ['title' => '云监控2.0 workspace', 'description' => 'The Cloud Monitor 2.0 workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'workspace-test'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the instance was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'createTime', 'example' => '2025-03-11T08:21:58Z'], + 'instanceType' => ['title' => '实例类型', 'description' => 'The type of the instance.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'instanceType', 'example' => 'test'], + 'status' => ['title' => '实例状态', 'description' => 'The status of the instance.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'status', 'example' => 'Running'], + ], + 'title' => '', + 'example' => '', + ], + 'PromptTemplateItem' => [ + 'type' => 'object', + 'properties' => [ + 'role' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'content' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PushingSetting' => [ + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['description' => 'The UUID of the message template.', 'type' => 'string', 'title' => '', 'example' => '"template-abc123"'], + 'alertActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The alert action ID.', 'type' => 'string', 'title' => '', 'example' => '"action-123"'], + 'description' => 'The list of alert action IDs.', + 'title' => '', + 'example' => '', + ], + 'restoreActionIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The restore action ID.', 'type' => 'string', 'title' => '', 'example' => '"restore-789"'], + 'description' => 'The list of restore action IDs.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The push settings object.', + 'title' => '', + 'example' => '', + ], + 'QueryAlertRulesFilter' => [ + 'description' => 'Filter conditions. Fields at the same level are combined with a logical AND.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['description' => 'Filters alert rules by UUID.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UuidFilter'], + 'displayName' => ['description' => 'Filters alert rules by display name.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DisplayNameFilter'], + 'labels' => ['description' => 'Filters alert rules by label.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LabelsFilter'], + 'status' => ['description' => 'Filters alert rules by status.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/StatusFilter'], + 'enabled' => ['description' => 'Filters alert rules by enabled status.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/EnabledFilter'], + 'datasourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DatasourceTypeFilter'], + 'observeResourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ObserveResourceTypeFilter'], + 'observeResourceGlobalScope' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ObserveResourceGlobalScopeFilter'], + 'observeResourceList' => ['$ref' => '#/components/schemas/ObserveResourceListFilter', 'description' => '', 'title' => '', 'example' => ''], + 'observeResourceInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'i-bp1abcxxxxxxxx', 'deprecated' => true], + 'severityLevels' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SeverityLevelsFilter'], + 'notifyStrategyId' => ['$ref' => '#/components/schemas/NotifyStrategyIdFilter', 'description' => '', 'title' => '', 'example' => ''], + 'partitionKey' => ['$ref' => '#/components/schemas/PartitionKeyFilter', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'QueryAlertRulesInput' => [ + 'description' => 'The request body of the QueryAlertRules operation.', + 'type' => 'object', + 'properties' => [ + 'filter' => ['description' => 'The filter criteria. Only alert rules that match these criteria are returned.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QueryAlertRulesFilter'], + 'pagination' => ['description' => 'The pagination settings for the query. If omitted, the system returns the first page of results with the default page size.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Pagination'], + 'workspace' => ['description' => 'The ID of the workspace that contains the alert rules.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'QueryAlertRulesResult' => [ + 'description' => 'The result of a query for alert rules.', + 'type' => 'object', + 'properties' => [ + 'totalCount' => ['description' => 'The total number of alert rules that match the query.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'alertRules' => [ + 'description' => 'The list of alert rules for the current page.', + 'type' => 'array', + 'items' => ['description' => 'An alert rule.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AlertRuleV2'], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'QueryConfigUnified' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '', + 'type' => 'string', + 'description' => '', + 'example' => '', + 'required' => true, + 'enum' => ['PROMETHEUS_SINGLE_QUERY', 'UMODEL_METRICSET_QUERY', 'UMODEL_LOGSET_QUERY', 'APM_MULTI_QUERY', 'CLOUD_MONITORING_QUERY', 'UMODEL_METRICSET_MULTI_QUERY', 'UNKNOWN_QUERY'], + ], + 'expr' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'promQl' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => '', 'deprecated' => true], + 'enableDataCompleteCheck' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'metricSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'metric' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'queries' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricSetNamedQueryEntry', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', + ], + 'logSet' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'windowSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'offsetSecs' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'aggregate' => [ + 'title' => '', + 'type' => 'string', + 'description' => '', + 'example' => '', + 'enum' => ['AVG', 'MAX', 'MIN', 'SUM', 'LAST'], + ], + 'entityDomain' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'entityType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'entityFilters' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UmodelEntityFilter'], + 'description' => '', + 'example' => '', + ], + 'labelFilters' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UmodelLabelFilter'], + 'description' => '', + 'example' => '', + ], + 'entityFields' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UmodelEntityField'], + 'description' => '', + 'example' => '', + ], + 'serviceIdList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', + ], + 'filterList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ApmFilterConfig'], + 'description' => '', + 'example' => '', + ], + 'measureList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ApmMeasureConfig'], + 'description' => '', + 'example' => '', + ], + 'namespace' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'relationType' => [ + 'title' => '', + 'type' => 'string', + 'description' => '', + 'example' => '', + 'enum' => ['INSTANCE', 'GROUP', 'USER'], + ], + 'dimensions' => [ + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', + ], + 'groupId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'legacyType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'legacyRaw' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'RepeatNotifySetting' => [ + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => ['description' => 'The state that ends the management event.', 'type' => 'string', 'title' => '', 'example' => '"Resolved"'], + 'repeatInterval' => ['description' => 'The interval between repeated notifications.', 'type' => 'string', 'title' => '', 'example' => '5'], + ], + 'description' => 'The recurring notification settings object.', + 'title' => '', + 'example' => '', + ], + 'RumDnsResponse' => [ + 'description' => 'The domain name for RUM reporting.', + 'type' => 'object', + 'properties' => [ + 'domain' => ['title' => 'RUM上报域名', 'description' => 'The domain name for RUM reporting.', 'type' => 'string', 'example' => 'rum', 'visibility' => 'Public', 'backendName' => 'domain'], + 'result' => ['title' => '域名DNS初始化状态', 'description' => 'The DNS initialization status of the domain name.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'result'], + 'message' => ['title' => '初始化message（失败场景）', 'description' => 'The message returned if initialization fails.', 'type' => 'string', 'example' => '""', 'visibility' => 'Public', 'backendName' => 'message'], + ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', + ], + 'ScheduleConfigUnified' => [ + 'description' => 'The scheduling configuration.', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'The type of the schedule.', + 'type' => 'string', + 'title' => '', + 'example' => '', + 'required' => true, + 'enum' => ['FIXED'], + ], + 'intervalSecs' => ['description' => 'The interval between scheduled runs, in seconds.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + ], + 'title' => '', + 'example' => '', + ], + 'ServerResponseManageAlertRulesResult' => [ + 'description' => 'The response object for the request.', + 'type' => 'object', + 'properties' => [ + 'data' => ['description' => 'The result of the operation.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ManageAlertRulesResult'], + 'code' => ['description' => 'The operation status code.', 'type' => 'string', 'title' => '', 'example' => ''], + 'success' => ['description' => 'Indicates whether the request succeeded (`true`) or failed (`false`).', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'requestId' => ['description' => 'The unique ID for the request. Provide this ID when contacting support for assistance.', 'type' => 'string', 'title' => '', 'example' => ''], + 'message' => ['description' => 'A message detailing the outcome of the request, such as a success message or an error description.', 'type' => 'string', 'title' => '', 'example' => ''], + 'total' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'nextToken' => ['description' => 'The token used to retrieve the next page of results. If the token is not returned, there are no more results.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ServerResponseQueryAlertRulesResult' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'data' => ['description' => 'The response payload.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QueryAlertRulesResult'], + 'code' => ['description' => 'The status code of the response. A status code of `200` indicates a successful request.', 'type' => 'string', 'title' => '', 'example' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'requestId' => ['description' => 'The unique request ID, used for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => ''], + 'message' => ['description' => 'The response message. If the request fails, this field contains details about the error.', 'type' => 'string', 'title' => '', 'example' => ''], + 'total' => ['description' => 'The total number of alert rules that match the query.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. A null value indicates that no more results are available.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SeverityLevelsFilter' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'contains' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'A single severity level. Common values include `FATAL`, `ERROR`, `WARN`, `INFO`, and `DEBUG`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'Matches a log entry if its severity level appears in this array of strings.', + 'example' => '', + ], + ], + 'description' => 'Filters logs or events by severity level.', + 'example' => '', + ], + 'StatusFilter' => [ + 'description' => 'A filter used to query resources by status.', + 'type' => 'object', + 'properties' => [ + 'eq' => [ + 'description' => 'Filters the results to include only resources with the specified status.', + 'type' => 'string', + 'title' => '', + 'example' => '', + 'enum' => ['Alarm', 'Ok'], + ], + ], + 'title' => '', + 'example' => '', + ], + 'SubscriptionAndNotifyStrategyForListView' => [ + 'title' => '订阅与通知策略详情视图', + 'description' => 'An output view of an aggregated entity, which includes its own fields such as notifyStrategyUuid, subscriptionUuid, migrationBatchId, and version.'."\n" + ."\n" + .'- Snapshots of child entities populated at runtime, such as notifyStrategy, subscription, subscriptions, and responsePlan.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'type' => 'string', 'description' => '', 'example' => ''], + 'name' => ['title' => '名称', 'type' => 'string', 'description' => '', 'example' => ''], + 'description' => ['title' => '描述', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'notifyStrategyUuid' => ['title' => '关联的 notifyStrategy uuid（与 responsePlan uuid 共享）', 'type' => 'string', 'description' => '', 'example' => ''], + 'subscriptionUuid' => ['title' => '直接绑定的主订阅 uuid（NOTIFY 形态下的 1:1 关联）', 'type' => 'string', 'description' => '', 'example' => ''], + 'migrationBatchId' => ['title' => '迁移批次 ID（用户自建为空；迁移产物有值）', 'type' => 'string', 'description' => '', 'example' => ''], + 'migrationMeta' => ['title' => '迁移元数据 JSON 字符串', 'type' => 'string', 'description' => '', 'example' => ''], + 'version' => ['title' => '乐观锁版本号', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'workspace' => ['title' => '工作空间标识', 'type' => 'string', 'description' => '', 'example' => ''], + 'userId' => ['title' => '所有者 userId', 'type' => 'string', 'description' => '', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'type' => 'string', 'description' => '', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'type' => 'string', 'description' => '', 'example' => ''], + 'notifyStrategy' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyStrategyForSNSView'], + ], + 'example' => '', + ], + 'SubscriptionAndNotifyStrategyForModify' => [ + 'title' => '订阅与通知策略修改入参', + 'description' => 'The write payload for an aggregate entity, used for Create and Update operations.'."\n" + ."\n" + .'- **Create**: The `notifyStrategy` parameter is required. Provide either `subscription` (for a single main subscription) or `subscriptions`. The two parameters are mutually exclusive.'."\n" + ."\n" + .'- **Update**: The `uuid` and `version` parameters are required. The operation updates only the sub-entities you provide. For bulk changes to member subscriptions, use the `subscriptions` parameter (an array of `SubscriptionOp`).', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'description' => 'Required for update operations but optional for create operations. If omitted during creation, the backend automatically generates a UUID.', 'type' => 'string', 'example' => ''], + 'version' => ['title' => '乐观锁版本号', 'description' => 'Required for update operations. The value must match the current version of the record. If the versions do not match, the request fails with an `OPTIMISTIC_LOCK_FAILED` error.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'name' => ['title' => '名称', 'description' => 'Optional. If omitted, the backend derives the name from `notifyStrategy`.', 'type' => 'string', 'example' => ''], + 'description' => ['title' => '描述', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '是否启用（创建时默认启用）', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'notifyStrategy' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyStrategyForSNSModify'], + 'subscription' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubscriptionForSNSModify'], + 'subscriptions' => [ + 'title' => '成员订阅批量操作', + 'description' => 'For update operations only. Use this parameter to batch create, update, and remove member subscriptions.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubscriptionOp'], + 'example' => '', + ], + 'responsePlan' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IncidentResponsePlanForSNSModify'], + ], + 'example' => '', + ], + 'SubscriptionAndNotifyStrategyForView' => [ + 'title' => '订阅与通知策略详情视图', + 'description' => 'The output view of an aggregate entity, including fields such as `notifyStrategyUuid`, `subscriptionUuid`, `migrationBatchId`, and `version`.'."\n" + ."\n" + .'- Snapshots of child entities populated at runtime (`notifyStrategy`, `subscription`, `subscriptions`, and `responsePlan`).', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['title' => '聚合实体 uuid', 'type' => 'string', 'description' => '', 'example' => ''], + 'name' => ['title' => '名称', 'type' => 'string', 'description' => '', 'example' => ''], + 'description' => ['title' => '描述', 'type' => 'string', 'description' => '', 'example' => ''], + 'enabled' => ['title' => '是否启用', 'type' => 'boolean', 'description' => '', 'example' => ''], + 'notifyStrategyUuid' => ['title' => '关联的 notifyStrategy uuid（与 responsePlan uuid 共享）', 'type' => 'string', 'description' => '', 'example' => ''], + 'subscriptionUuid' => ['title' => '直接绑定的主订阅 uuid（NOTIFY 形态下的 1:1 关联）', 'type' => 'string', 'description' => '', 'example' => ''], + 'migrationBatchId' => ['title' => '迁移批次 ID（用户自建为空；迁移产物有值）', 'type' => 'string', 'description' => '', 'example' => ''], + 'migrationMeta' => ['title' => '迁移元数据 JSON 字符串', 'type' => 'string', 'description' => '', 'example' => ''], + 'version' => ['title' => '乐观锁版本号', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + 'workspace' => ['title' => '工作空间标识', 'type' => 'string', 'description' => '', 'example' => ''], + 'userId' => ['title' => '所有者 userId', 'type' => 'string', 'description' => '', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'type' => 'string', 'description' => '', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'type' => 'string', 'description' => '', 'example' => ''], + 'subscription' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubscriptionForSNSView'], + 'responsePlan' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IncidentResponsePlanForSNSView'], + 'notifyStrategy' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyStrategyForSNSView'], + 'subscriptions' => [ + 'title' => '全部成员订阅（含主订阅，反查得出）', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubscriptionForView'], + 'description' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'SubscriptionForModify' => [ + 'title' => '', + 'description' => 'The entity for viewing.', + 'type' => 'object', + 'properties' => [ + 'description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace test'], + 'subscriptionName' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '测试订阅'], + 'notifyStrategyId' => ['title' => '', 'description' => 'The UUID of the notification policy.', 'type' => 'string', 'example' => '123123'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'pushingSetting' => [ + 'title' => '', + 'description' => 'The push settings.', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['title' => '', 'description' => 'The UUID of the template.', 'type' => 'string', 'example' => '123123123'], + 'alertActionIds' => [ + 'title' => '', + 'description' => 'The list of action plan IDs for alert pushing.', + 'type' => 'array', + 'items' => ['description' => 'The action integration ID.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'example' => '', + ], + 'restoreActionIds' => [ + 'title' => '', + 'description' => 'The list of action integration plan IDs for recovery pushing.', + 'type' => 'array', + 'items' => ['description' => 'The action integration plan ID.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'example' => '', + ], + 'responsePlanId' => ['title' => '', 'description' => 'The action plan ID.', 'type' => 'string', 'example' => '123123123'], + ], + 'example' => '', + ], + 'workspaceFilterSetting' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], + 'agentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'agentUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'routes' => [ + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyRouteForSubscription'], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'subscribeLegacyEvent' => ['title' => '', 'description' => 'Specifies whether to subscribe to legacy product events (CMS 1.0, ARMS, or SLS events where workspace is null). Valid values:'."\n" + .'- true: Subscribe.'."\n" + .'- false or null: Do not subscribe.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'SubscriptionForSNSModify' => [ + 'title' => 'SNS 内嵌的订阅入参', + 'description' => 'Specifies the `subscription` child entity, which is an input parameter for the `SubscriptionAndNotifyStrategy` aggregation API.'."\n" + .'The API does not expose the following read-only backend fields:'."\n" + ."\n" + .'- `uuid` (auto-generated) and `name` (defaults to the primary SNS name, D9)'."\n" + ."\n" + .'- `regionId`, `mode` (BundleStrategy), and `subscriptionType` (forced to `NORMAL`; `AI_AGENT` is rejected, D10)'."\n" + ."\n" + .'- `agentConfig` (forced to `null`), `notifyStrategyUuid` (auto-bound), `syncFromType` (forced to `OBS`), and `enabled`', + 'type' => 'object', + 'properties' => [ + 'filterSetting' => ['title' => 'filter 配置', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/FilterSetting'], + 'workspaceFilterSetting' => ['title' => 'workspace filter 配置', 'description' => '', 'example' => '', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], + ], + 'example' => '', + ], + 'SubscriptionForSNSView' => [ + 'title' => 'SNS 内嵌的订阅查看视图', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['type' => 'string'], + 'name' => ['type' => 'string'], + 'enable' => ['type' => 'boolean'], + 'userId' => ['type' => 'string'], + 'workspace' => ['type' => 'string'], + 'regionId' => ['type' => 'string'], + 'notifyStrategyUuid' => ['title' => '反向关联到 SNS（= snsUuid）', 'type' => 'string'], + 'syncFromType' => ['type' => 'string'], + 'mode' => ['type' => 'string'], + 'subscriptionType' => ['type' => 'string'], + 'filterSetting' => ['$ref' => '#/components/schemas/FilterSetting'], + 'workspaceFilterSetting' => ['$ref' => '#/components/schemas/WorkspaceFilterSetting'], + 'createTime' => ['type' => 'string'], + 'updateTime' => ['type' => 'string'], + ], + ], + 'SubscriptionForView' => [ + 'title' => '', + 'description' => 'The entity for viewing.', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace test'], + 'enable' => ['title' => '', 'description' => 'Indicates whether the subscription is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'subscriptionName' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => '订阅测试'], + 'notifyStrategyId' => ['title' => '', 'description' => 'The UUID of the notification policy.', 'type' => 'string', 'example' => '23123123'], + 'updateTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2025-05-23T02:29:02Z'], + 'userId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '123123123'], + 'subscriptionId' => ['title' => '', 'description' => 'UUID', 'type' => 'string', 'example' => '123123123123'], + 'workspace' => ['title' => '', 'description' => 'workspace', 'type' => 'string', 'example' => 'workspace-test'], + 'filterSetting' => ['description' => 'The filter settings.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'pushingSetting' => [ + 'title' => '', + 'description' => 'The push settings.', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => ['title' => '', 'description' => 'The UUID of the template.', 'type' => 'string', 'example' => '123123123'], + 'alertActionIds' => [ + 'title' => '', + 'description' => 'The list of action integration IDs for alert pushing.', + 'type' => 'array', + 'items' => ['description' => 'The action integration ID.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'example' => '', + ], + 'restoreActionIds' => [ + 'title' => '', + 'description' => 'The list of action integration IDs for recovery pushing.', + 'type' => 'array', + 'items' => ['description' => 'The action integration ID.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'example' => '', + ], + 'responsePlanId' => ['title' => '', 'description' => 'The action plan ID.', 'type' => 'string', 'example' => '123123123'], + ], + 'example' => '', + ], + 'syncFromType' => ['description' => 'The source type of the synchronization policy.', 'type' => 'string', 'title' => '', 'example' => '"ARMS"'], + 'workspaceFilterSetting' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/WorkspaceFilterSetting'], + 'subscriptionType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => ['NORMAL', 'AI_AGENT'], + ], + 'agentConfig' => [ + 'type' => 'object', + 'properties' => [ + 'agentUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'routes' => [ + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NotifyRouteForSubscription'], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'subscribeLegacyEvent' => ['title' => '', 'description' => 'Specifies whether to subscribe to legacy product events (CMS 1.0, ARMS, or SLS events where workspace is null). Valid values:'."\n" + .'- true: Subscribe.'."\n" + .'- false or null: Do not subscribe.', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'SubscriptionOp' => [ + 'title' => '订阅批量操作单元', + 'description' => 'Update 接口中用于批量增删改成员订阅的操作描述。'."\n" + .'- op=create：必填 payload，uuid 由后端生成'."\n" + .'- op=update：必填 uuid + payload'."\n" + .'- op=remove：必填 uuid，payload 忽略'."\n", + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'title' => '操作类型', + 'type' => 'string', + 'enum' => ['create', 'update', 'remove'], + ], + 'uuid' => ['title' => '目标订阅 uuid', 'description' => 'update/remove 必填', 'type' => 'string'], + 'payload' => ['title' => '订阅完整载荷', 'description' => 'create/update 必填', '$ref' => '#/components/schemas/SubscriptionForModify'], + ], + ], + 'Tag' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '标签键', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'maxLength' => 128], + 'value' => ['title' => '标签值', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'test', 'maxLength' => 256], + ], + 'description' => 'The tag.', + 'title' => '标签', + 'example' => '', + ], + 'TagCondition' => [ + 'title' => '标签过滤条件', + 'description' => '基于 tag key/value 的过滤单元', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '标签键', 'type' => 'string'], + 'op' => [ + 'title' => '操作符', + 'type' => 'string', + 'enum' => ['EQ', 'EQI', 'START_WITH', 'END_WITH', 'CONTAIN', 'NOT_CONTAIN', 'IN', 'NOT_IN', 'EXIST'], + ], + 'value' => ['title' => '标签值', 'type' => 'string'], + ], + ], + 'TagSelector' => [ + 'title' => '标签选择器', + 'description' => 'A tag-based selector defined by either `conditions` and `relation` or a custom `expression`.', + 'type' => 'object', + 'properties' => [ + 'conditions' => [ + 'title' => '标签过滤条件列表', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/TagCondition'], + 'description' => '', + 'example' => '', + ], + 'relation' => [ + 'title' => '条件关系', + 'type' => 'string', + 'description' => '', + 'example' => '', + 'default' => 'AND', + 'enum' => ['AND', 'OR'], + ], + 'expression' => ['title' => '自定义表达式（高级模式，覆盖 conditions+relation）', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'example' => '', + ], + 'TransformAction' => [ + 'description' => 'The transform configuration.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'mapping' => [ + 'description' => 'The mapping configuration.', + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The severity level mapping configuration.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => '{"warning":"WARNING"}'], + 'backendName' => 'mapping', + 'title' => '', + 'example' => '', + ], + 'variable' => ['description' => 'The variable name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'variable', 'title' => '', 'example' => 'var1'], + 'filterSetting' => ['description' => 'The filter configuration.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'source' => ['description' => 'The reference path.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'source', 'title' => '', 'example' => 'data.subject'], + 'labelKey' => ['description' => 'The label name.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'labelKey', 'title' => '', 'example' => 'labelkey1'], + 'type' => ['description' => 'The transform type.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'type', 'title' => '', 'example' => 'SET_FIELD'], + 'value' => ['description' => 'The value to set.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'value', 'title' => '', 'example' => 'value1'], + 'regExp' => ['description' => 'The regular expression.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'regExp', 'title' => '', 'example' => '(.*):(.*)'], + 'target' => ['description' => 'The target location.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'target', 'title' => '', 'example' => 'SUBJECT'], + ], + 'title' => '', + 'example' => '', + ], + 'TransformerForModify' => [ + 'title' => 'A short description of struct', + 'description' => 'The data converter.', + 'type' => 'object', + 'properties' => [ + 'sortId' => ['title' => '排序数', 'description' => 'The sort number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'sortId'], + 'quitAfterMatch' => ['title' => '匹配处理后退出', 'description' => 'Specifies whether to exit after a match is processed.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'quitAfterMatch'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'workspace test', 'visibility' => 'Public', 'backendName' => 'description'], + 'filterSetting' => ['description' => 'The filter criteria.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'filterSetting'], + 'transformerName' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => 'name', 'visibility' => 'Public', 'backendName' => 'transformerName'], + 'actions' => [ + 'title' => '转换操作', + 'description' => 'The transform operations.', + 'type' => 'array', + 'items' => ['description' => 'The transform action.', '$ref' => '#/components/schemas/TransformAction', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', + 'backendName' => 'actions', + ], + ], + 'example' => '', + 'visibility' => 'Public', + ], + 'TransformerForView' => [ + 'title' => 'A short description of struct', + 'description' => 'The data converter.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => 'workspace', 'description' => 'The workspace.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'workspace', 'example' => 'workspace-test'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the converter was created.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'createTime', 'example' => '2025-03-11T08:21:58Z'], + 'enable' => ['title' => '是否启用', 'description' => 'Indicates whether the converter is enabled.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'enabled', 'example' => 'false'], + 'sortId' => ['title' => '排序数', 'description' => 'The sort ID.', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'sortId', 'example' => '1'], + 'transformerId' => ['title' => 'transformer Id', 'description' => 'The transformer ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'transformerId', 'example' => '1123123123123'], + 'quitAfterMatch' => ['title' => '匹配处理后退出', 'description' => 'Indicates whether to exit after a match is processed.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'quitAfterMatch', 'example' => 'false'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'description', 'example' => 'workspace test'], + 'filterSetting' => ['description' => 'The filter settings.', 'visibility' => 'Public', 'backendName' => 'filterSetting', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'updateTime' => ['title' => '更新时间', 'description' => 'The time when the converter was last updated.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'updateTime', 'example' => '2025-01-16T02:27:01Z'], + 'transformerName' => ['title' => '名称', 'description' => 'The name.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'backendName' => 'transformerName', 'example' => '测试处理流'], + 'actions' => [ + 'title' => '转换操作', + 'description' => 'The transform operations.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => ['description' => 'The transform action.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TransformAction', 'title' => '', 'example' => ''], + 'backendName' => 'actions', + 'example' => '', + ], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'userId', 'example' => '123123123**'], + ], + 'example' => '', + ], + 'UmodelEntityField' => [ + 'description' => 'The display configuration for a UModel entity field.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The name of the entity field.', 'type' => 'string', 'title' => '', 'example' => ''], + 'value' => ['description' => 'The field alias or display value.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'UmodelEntityFilter' => [ + 'description' => 'The filter to apply when querying entities. A filter consists of a `field`, an `operator`, and a `value`.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The field name to filter on.', 'type' => 'string', 'title' => '', 'example' => ''], + 'operator' => [ + 'description' => 'The comparison operator to use. Supported operators include `=`, `>`, `<`, `!=`, `IN`, and `NOT IN`.', + 'type' => 'string', + 'title' => '', + 'example' => '', + 'enum' => ['=', '!='], + ], + 'value' => ['description' => 'The value to compare the field against.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'UmodelLabelFilter' => [ + 'description' => 'A filter that selects resources based on a label. A label is a key-value pair that you can assign to resources.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The key of the label used for filtering.', 'type' => 'string', 'title' => '', 'example' => ''], + 'value' => ['description' => 'The value of the label to match.', 'type' => 'string', 'title' => '', 'example' => ''], + 'operator' => [ + 'description' => 'The logical operator used to compare the label\'s value.', + 'type' => 'string', + 'title' => '', + 'example' => '', + 'enum' => ['=', '!='], + ], + ], + 'title' => '', + 'example' => '', + ], + 'UuidFilter' => [ + 'description' => 'Contains the criteria for filtering by uuid.', + 'type' => 'object', + 'properties' => [ + 'eq' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'in' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'WorkspaceFilterSetting' => [ + 'type' => 'object', + 'properties' => [ + 'tagSelector' => ['description' => 'The tag filter.', '$ref' => '#/components/schemas/FilterSetting', 'title' => '', 'example' => ''], + 'workspaceUuids' => [ + 'type' => 'array', + 'items' => ['description' => 'The workspace UUID.', 'type' => 'string', 'title' => '', 'example' => '"ws-abc123"'], + 'description' => 'A list of workspace UUIDs.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The workspace filter settings object.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'apis' => [ + 'AddContexts' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context', + '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], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'contextType' => ['description' => 'The context type.', 'type' => 'string', 'required' => true, 'example' => 'memory', 'title' => ''], + 'memoryType' => ['description' => 'The memory type.', 'type' => 'string', 'required' => false, 'example' => 'short', 'title' => ''], + 'items' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'messages' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The properties of the message, such as `role` and `content`.', 'type' => 'any', 'example' => '{"content":"xxxx","role":"xxxx"}', 'title' => ''], + 'description' => 'A single message object.', + 'required' => false, 'title' => '', - 'description' => 'Channel type.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'CONTACT', - 'backendName' => 'channelType', - 'enum' => [ - 'DING', - 'WEIXIN', - 'FEISHU', - 'SLACK', - 'TEAMS', - 'CONTACT', - 'GROUP', - 'DUTY', - ], + 'example' => '', ], + 'description' => 'An array of message objects.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'extendType' => 'true', + 'content' => ['description' => 'The content of the context item.', 'type' => 'string', 'required' => false, 'example' => 'You are a conversation assistant.', 'title' => ''], + 'userId' => ['description' => 'The unique user ID.', 'type' => 'string', 'required' => false, 'example' => 'test_user_001', 'title' => ''], + 'agentId' => ['description' => 'The unique agent ID.', 'type' => 'string', 'required' => false, 'example' => '952730733889060865', 'title' => ''], + 'appId' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f', 'title' => ''], + 'runId' => ['description' => 'The run ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea', 'title' => ''], + 'labels' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value pair representing a single label.', 'type' => 'string', 'example' => '{"key":"xxxx","value":"xxxx"}', 'title' => ''], + 'description' => 'A map of key-value pairs to apply as labels.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'metadata' => ['description' => 'Key-value pairs to store as metadata.', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + 'infer' => ['description' => 'Specifies whether to perform inference based on the context. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'customInstructions' => ['description' => 'The custom instructions for processing the context.', 'type' => 'string', 'required' => false, 'example' => 'Your custom instructions here', 'title' => ''], + 'timestamp' => ['description' => 'The timestamp of the context item.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1774578167', 'title' => ''], + 'categories' => [ + 'type' => 'array', + 'items' => ['description' => 'A category name.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''], + 'description' => 'A list of categories to apply to the context item.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'immutable' => ['description' => 'Specifies whether the context item is immutable. If set to `true`, the item cannot be changed after it is created. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'expirationDate' => ['description' => 'The expiration timestamp for the context item.', 'type' => 'string', 'required' => false, 'example' => '1731231212334396', 'title' => ''], + 'triggerCondition' => ['description' => 'The condition that triggers the context.', 'type' => 'string', 'required' => false, 'example' => 'Identify and troubleshoot SLs issues', 'title' => ''], + 'experience' => ['description' => 'An object containing experience information for the context.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "taskType": "troubleshooting",'."\n" + .' "complexity": "medium",'."\n" + .' "confidence": 0.95'."\n" + .'}', 'title' => ''], ], - 'backendName' => 'channels', + 'description' => 'A single context item.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'filterSetting' => [ - 'description' => 'Routing conditions.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', + 'required' => true, + 'description' => 'An array of context items.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The unique ID for the request.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'contextId' => ['description' => 'The ID of the written record or event.', 'type' => 'string', 'title' => '', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e'], + 'status' => ['description' => 'The write status. Can be "accepted", "queued", or "created".', 'type' => 'string', 'title' => '', 'example' => 'accepted'], + ], + 'description' => 'An object that represents a single result.', + 'title' => '', + 'example' => '', ], - 'effectTimeRange' => [ + 'description' => 'An array of objects containing the results of the write operation.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddContexts', + 'summary' => 'Write to the context', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\",\\n \\"results\\": [\\n {\\n \\"contextId\\": \\"897294a7-67a4-4f60-976c-e136edc5f97e\\",\\n \\"status\\": \\"accepted\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'AddMemories' => [ + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory', + '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], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'Workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'Memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'timestamp' => ['type' => 'integer', 'format' => 'int64', 'example' => '12312314214', 'description' => '', 'title' => ''], + 'asyncMode' => ['description' => 'Asynchronous mode.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'messages' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'Content.', 'type' => 'string', 'required' => false, 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + 'role' => ['description' => 'Role.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], + ], + 'description' => 'Message.', + 'required' => false, 'title' => '', - 'description' => 'Valid time range.', - 'visibility' => 'Public', + 'example' => '', + ], + 'description' => 'Messages.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'User ID.', 'type' => 'string', 'required' => false, 'example' => 'test_user_001', 'title' => ''], + 'agentId' => ['description' => 'Application agent ID.', 'type' => 'string', 'required' => false, 'example' => '952730733889060865', 'title' => ''], + 'appId' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f', 'title' => ''], + 'runId' => ['description' => 'Run ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea', 'title' => ''], + 'infer' => ['description' => 'Infer.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'customInstructions' => ['description' => 'Custom instructions.', 'type' => 'string', 'required' => false, 'example' => 'Your custom instructions here', 'title' => ''], + 'metadata' => ['description' => 'Metadata.', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + ], + 'description' => 'Request body parameters.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '', - 'description' => 'Start time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'startTimeInMinute', - ], - 'timeZone' => [ - 'title' => '', - 'description' => 'Time Zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+08:00', - 'backendName' => 'timeZone', - ], - 'dayInWeek' => [ - 'title' => '', - 'description' => 'Effective days (Monday to Sunday).', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '1–7 represents Monday to Sunday.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'extendType' => 'true', + 'message' => ['description' => 'Details.', 'type' => 'string', 'example' => 'Memory processing has been queued for background execution', 'title' => ''], + 'status' => ['description' => 'Processing status.', 'type' => 'string', 'example' => 'Pending', 'title' => ''], + 'eventId' => ['description' => 'Event ID.', 'type' => 'string', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], + ], + 'description' => 'Request result.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Request results.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'Response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddMemories', + 'summary' => 'Add new facts, messages, or metadata to a user’s memory store. The AddMemories endpoint accepts raw text or conversation turns and commits them asynchronously, preparing the memories for subsequent search, retrieval, and graph queries.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:AddMemories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/memorystore/{#memoryStore}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"results\\": [\\n {\\n \\"message\\": \\"Memory processing has been queued for background execution\\",\\n \\"status\\": \\"Pending\\",\\n \\"eventId\\": \\"897294a7-67a4-4f60-976c-e136edc5f97e\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Changes the resource group of a resource.', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'resourceType' => ['description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'Service', 'title' => ''], + 'resourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******ey', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'title' => '', + 'description' => 'The schema of the response.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ChangeResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'CreateAddonRelease' => [ + 'summary' => 'Installs an add-on.', + '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' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '需要接入监控的组件 Addon 名称。', 'description' => 'The name of the add-on to integrate.', 'type' => 'string', 'required' => true, 'example' => 'cs-gpu'], + 'aliyunLang' => [ + 'title' => '组件的语言类型。', + 'description' => 'The language of the add-on.', + 'enumValueTitles' => ['en' => 'English', 'zh' => 'Chinese'], + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + 'dryRun' => [ + 'title' => '是否试运行，默认为 false。', + 'description' => 'Specifies whether to perform a dry run. The default value is false.', + 'enumValueTitles' => ['true' => 'Performs a dry run.', 'false' => 'Does not perform a dry run.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'envType' => [ + 'title' => '环境类型。如果 Policy 类型为 CS 和 ECS，对应使用，其他类型统一为 Cloud。', + 'description' => 'The environment type. Set this parameter to CS for container environments or ECS for ECS environments. For all other environment types, set this parameter to Cloud.', + 'enumValueTitles' => ['CS' => 'container environment', 'ECS' => 'ECS environment', 'Cloud' => 'Alibaba Cloud service environment'], + 'type' => 'string', + 'required' => false, + 'example' => 'CS', + ], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => 'The ID of the parent AddonRelease.', 'type' => 'string', 'required' => false, 'example' => 'policy-xxxxxxxxxxx'], + 'releaseName' => ['title' => '接入后的插件名称，如果不指定则生成默认规则名称。', 'description' => 'The name of the release after the integration. If you do not specify this parameter, a default name is generated.', 'type' => 'string', 'required' => false, 'example' => 'test-gpu-integration-name'], + 'values' => ['title' => '输入的元数据。', 'description' => 'The metadata.', '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' => 'The version of the add-on to integrate.', 'type' => 'string', 'required' => true, 'example' => '0.0.2'], + 'workspace' => ['title' => '安装组件资源的工作空间名称。'."\n", 'description' => 'The name of the workspace where the add-on is installed.', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'entityRules' => ['title' => '实体发现规则。', 'description' => 'The entity discovery rules.', '$ref' => '#/components/schemas/EntityDiscoverRule', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '环境策略 ID。', 'description' => 'The ID of the environment policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-yyyyyyyyyy'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据。', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'release' => [ + 'title' => '接入组件信息。', + 'description' => 'The information about the integrated add-on.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '接入监控的组件 Addon 名称。', 'description' => 'The name of the integrated add-on.', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警组数量。', 'description' => 'The number of alert rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'conditions' => [ + 'title' => '组件安装阶段信息。', + 'description' => 'The information about the add-on installation phases.', + 'type' => 'array', + 'items' => [ + 'description' => 'The operator. The supported matching methods are exact match, prefix match, and regular expression.', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => 'The time when the phase first transitioned.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => 'The time when the phase last transitioned.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => 'The details of the phase.', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => 'The status of the phase.', 'type' => 'string', 'example' => '{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}'], + 'type' => ['title' => '阶段类型。', 'description' => 'The type of the phase.', 'type' => 'string', 'example' => 'Loaded'], ], - 'backendName' => 'dayInWeek', - ], - 'endTimeInMinute' => [ 'title' => '', - 'description' => 'End time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '30', - 'backendName' => 'endTimeInMinute', + 'example' => '', ], - ], - 'backendName' => 'effectTimeRange', - ], - 'severities' => [ - 'description' => 'Severity level list.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Severity levels: CRITICAL, WARNING, INFO.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'extendType' => 'true', - ], - 'backendName' => 'severities', + 'example' => '', + ], + 'config' => ['title' => '组件配置。', 'description' => 'The configuration of the add-on.', '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' => 'The time when the add-on was integrated.', 'type' => 'string', 'example' => '2024-11-05T15:21:30+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => 'The number of dashboards.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => 'The environment ID.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => 'The number of exporters.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => 'Indicates whether a configuration is available.', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '安装的用户 ID。', 'description' => 'The ID of the user who installed the add-on.', 'type' => 'string', 'example' => '1654218965xxxxxx'], + 'language' => ['title' => '语言。', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => 'Indicates whether the add-on is a managed add-on.', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => 'The ID of the parent AddonRelease.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'policyId' => ['title' => '策略环境 ID。', 'description' => 'The ID of the environment policy.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxx'], + 'regionId' => ['title' => '地域 ID。', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => '安装后的 ReleaseID。', 'description' => 'The ID of the release.', 'type' => 'string', 'example' => '2e898e60-5e6a-46d1-a994-xxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 的名称。', 'description' => 'The name of the release.', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => 'The scenario of the add-on.', 'type' => 'string', 'example' => '1'], + 'status' => ['title' => '组件状态。', 'description' => 'The status of the add-on.', 'type' => 'string', 'example' => '200'], + 'updateTime' => ['title' => '更新时间。', 'description' => 'The time when the add-on was last updated.', 'type' => 'string', 'example' => '2024-09-13T02:21:02Z'], + 'userId' => ['title' => '所属用户 ID。', 'description' => 'The user ID.', 'type' => 'string', 'example' => '165421896xxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => 'The version of the add-on.', 'type' => 'string', 'example' => '1.0.0'], + 'envType' => ['title' => '环境类型。', 'description' => 'The environment type.', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'default'], + 'entityRules' => ['title' => '实体详情。', 'description' => 'The details of the entity.', '$ref' => '#/components/schemas/EntityGroupBase', 'example' => ''], ], + 'example' => '', ], - 'extendType' => 'true', + 'requestId' => ['title' => '请求 ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], - 'required' => true, - 'backendName' => 'routes', - ], - 'notifyStrategyName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Policy name.'."\n", - 'backendName' => 'name', + 'example' => '', ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'description', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Install Access Component', + 'description' => 'Creates a release for an add-on.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/*'], + ], ], - 'groupingSetting' => [ + ], + ], + '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\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"acs.ecs.instance\\",\\n \\"spl\\": \\".entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')\\"\\n }\\n ],\\n \\"description\\": \\"ECS 实例\\",\\n \\"entityGroupId\\": \\"eg-1234567890\\",\\n \\"entityRules\\": {\\n \\"ipMatchRule\\": [\\n {\\n \\"ipFieldKey\\": \\"hostIp\\",\\n \\"ipCIDR\\": \\"192.168.0.1/10\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"op\\": \\"in\\",\\n \\"fieldKey\\": \\"instanceId\\",\\n \\"fieldValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"in\\",\\n \\"tagKey\\": \\"instanceId\\",\\n \\"tagValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\\\n\\"\\n ]\\n }\\n ],\\n \\"resourceGroupId\\": \\"rg-acfm2m7atreujs1\\",\\n \\"entityTypes\\": [\\n \\"acs.ecs.instance\\"\\n ],\\n \\"regionIds\\": [\\n \\"cn-shanghai\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"op\\": \\"in\\",\\n \\"tagKey\\": \\"project\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"op\\": \\"in\\",\\n \\"tagKey\\": \\"project\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"ECS 全部实体\\",\\n \\"userId\\": \\"1654218***343050\\"\\n }\\n },\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'CreateAggTaskGroup' => [ + 'summary' => 'Create an aggregation task group.', + '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' => '', 'description' => 'Source Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'pq4apob9jm'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ 'title' => '', - 'description' => 'Grouping settings.', - 'visibility' => 'Public', + 'description' => 'Request body structure.', 'type' => 'object', 'properties' => [ - 'groupingKeys' => [ + 'aggTaskGroupConfig' => ['title' => '', 'description' => 'Aggregation task group configuration.'."\n" + .'Currently only the "RecordingRuleYaml" format is supported, which must conform to the RecordingRule format requirements of open-source Prometheus.', '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' => '', 'description' => 'Aggregation task group configuration type. Default: "RecordingRuleYaml" (open-source Prometheus RecordingRule format).', 'type' => 'string', 'example' => 'RecordingRuleYaml', 'default' => 'RecordingRuleYaml', 'required' => false], + 'aggTaskGroupName' => ['title' => '', 'description' => 'Aggregation task group name.', 'type' => 'string', 'required' => true, 'example' => 'test-group'], + 'cronExpr' => ['title' => '', 'description' => 'The specific scheduling expression when the scheduling mode is set to "Cron". For example, "0/1 * * * *" means scheduling every 1 minute starting from minute 0.', 'type' => 'string', 'example' => '0/1 * * * *', 'required' => false], + 'delay' => ['title' => '', 'description' => 'Fixed delay time for scheduling. Unit: seconds. Default: 30.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '120', 'minimum' => '0', 'example' => '30', 'default' => '30', 'required' => false], + 'description' => ['title' => '', 'description' => 'Aggregation task group description.', 'type' => 'string', 'example' => 'desc', 'required' => false], + 'fromTime' => ['title' => '', 'description' => 'Second-level timestamp corresponding to the scheduling start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724996015', 'required' => false], + 'maxRetries' => ['title' => '', 'description' => 'Maximum number of retries for executing aggregation tasks. Default: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false], + 'maxRunTimeInSeconds' => ['title' => '', 'description' => 'Maximum retry duration for executing aggregation tasks. Unit: seconds. Default: 600.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'default' => '600', 'required' => false], + 'precheckString' => ['title' => '', 'description' => 'Pre-check configuration. Not configured by default. The input string must be valid JSON.', 'type' => 'string', '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"}', 'required' => false], + 'scheduleMode' => [ 'title' => '', - 'description' => 'Grouping keys.', - 'visibility' => 'Public', + 'description' => 'Scheduling mode. "Cron" or "FixedRate". Default: "FixedRate".', + 'enumValueTitles' => ['FixedRate' => 'Fixed rate', 'Cron' => 'Cron expression'], + 'type' => 'string', + 'required' => false, + 'example' => 'FixedRate', + 'default' => 'FixedRate', + 'enum' => ['FixedRate', 'Cron'], + ], + 'scheduleTimeExpr' => ['title' => '', 'description' => 'Scheduling time expression. "@s" or "@m" is recommended, indicating the granularity of scheduling time window alignment. Default: "@m".', 'type' => 'string', 'example' => '@m', 'default' => '@m', 'required' => false], + 'status' => [ + 'title' => '', + 'description' => 'Aggregation task group status. "Running" or "Stopped". Default: Running.', + 'enumValueTitles' => ['Stopped' => 'Disabled', 'Running' => 'Enabled'], + 'type' => 'string', + 'example' => 'Running', + 'default' => 'Running', + 'enum' => ['Running', 'Stopped'], + 'required' => false, + ], + 'tags' => [ + 'title' => '', + 'description' => 'Resource group tags.', 'type' => 'array', 'items' => [ - 'description' => 'Grouping fields.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'severity', - 'extendType' => 'true', + 'description' => 'Resource tag value.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '', 'description' => 'Key of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '', 'description' => 'Value of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'backendName' => 'groupingKeys', + 'required' => false, + 'example' => '', + ], + 'targetPrometheusId' => ['title' => '', 'description' => 'Target Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + 'toTime' => ['title' => '', 'description' => 'Second-level timestamp corresponding to the scheduling end time. 0 means scheduling will not stop.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'overrideIfExists', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Whether to override and update when a resource with the same name exists during aggregation task group creation.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response body structure.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => ['title' => '', 'description' => 'Digest of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '', 'description' => 'Aggregation task group ID.', 'type' => 'string', 'example' => 'aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f'], + 'aggTaskGroupName' => ['title' => '', 'description' => 'Aggregation task group name.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'requestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7'], + 'sourcePrometheusId' => ['title' => '', 'description' => 'Source Prometheus instance ID of the aggregation task group.', 'type' => 'string', 'example' => 'rw-ecc04af14729b1a16e40a0d10068'], + 'status' => ['title' => '', 'description' => 'Current status of the aggregation task group.', 'type' => 'string', 'example' => 'Pending2Running'], + ], + 'example' => '', + ], + ], + ], + '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' => 'Create Aggregation Task Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateAggTaskGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/*'], + ], + ], + ], + ], + ], + 'CreateAlertWebhook' => [ + 'summary' => 'Create a 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' => 'The request parameters.', + 'type' => 'object', + 'properties' => [ + 'contentType' => [ + 'description' => 'The content type. Valid values:'."\n" + ."\n" + .'- JSON (default)'."\n" + ."\n" + .'- FORM', + 'type' => 'string', + 'default' => 'JSON', + 'enum' => ['JSON', 'FORM'], + 'required' => false, + 'example' => 'JSON', + 'title' => '', ], - 'times' => [ + 'headers' => [ + 'description' => 'The headers.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The header.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'title' => '', - 'description' => 'Trigger count.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'times', + 'example' => '', ], - 'periodMin' => [ + 'lang' => [ + 'description' => 'The language. Valid values:'."\n" + ."\n" + .'- zh\\_CN'."\n" + ."\n" + .'- en\\_US', + 'type' => 'string', + 'enum' => ['zh_CN', 'en_US'], + 'required' => false, + 'example' => 'zh_CN', 'title' => '', - 'description' => 'Check interval in minutes.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'periodMin', ], - 'silenceSec' => [ + 'method' => [ + 'description' => 'The request method. Valid values:'."\n" + ."\n" + .'- GET'."\n" + ."\n" + .'- POST', + 'type' => 'string', + 'required' => false, + 'default' => 'POST', + 'enum' => ['GET', 'POST'], + 'example' => 'GET', 'title' => '', - 'description' => 'Silence duration in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'backendName' => 'silenceSec', ], + 'name' => ['description' => 'The name of the webhook.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + 'url' => ['description' => 'The URL for the alert callback.', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com/test', 'title' => ''], + 'webhookId' => ['description' => 'The unique ID of the webhook.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'workspace' => ['type' => 'string', 'example' => 'my-workspace', 'description' => '', 'title' => ''], ], - 'required' => true, - 'backendName' => 'groupingSetting', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'customTemplateEntries' => [ + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'alertWebhookId' => ['description' => 'The unique ID of the webhook.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resource already exist .', 'description' => 'The resource already exists.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateAlertWebhook', + 'description' => 'Creates an alert webhook to use as a notification recipient.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"alertWebhookId\\": \\"test\\"\\n}","type":"json"}]', + ], + 'CreateBizTrace' => [ + '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' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['type' => 'string', 'description' => 'The workspace.', 'required' => false, 'title' => '', 'example' => 'default-cms-xxxxxxx-cn-hangzhou'], + 'bizTraceCode' => ['type' => 'string', 'description' => 'The identifier for the business trace. It can contain only letters, digits, and underscores (\\_). The first character must be a lowercase letter.', 'required' => false, 'title' => '', 'example' => 'label_env'], + 'bizTraceName' => ['type' => 'string', 'description' => 'The name of the business trace.', 'required' => false, 'title' => '', 'example' => 'just test'], + 'ruleConfig' => ['type' => 'string', 'description' => 'The configuration rules.', 'required' => false, 'title' => '', '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' => ['type' => 'string', 'description' => 'The advanced configuration.', 'required' => false, 'title' => '', 'example' => '{"sample":{"strategy":"BY_APP"}}'], + ], + 'description' => 'The request body.', + 'required' => false, 'title' => '', - 'description' => 'Notification channel template.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Template details.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'templateUuid' => [ - 'title' => '', - 'description' => 'Template UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '123123-12-31-231-23-12-3123', - 'backendName' => 'templateUuid', - ], - 'targetType' => [ - 'title' => '', - 'description' => 'Notification type.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'SMS', - 'backendName' => 'targetType', - ], - ], - 'extendType' => 'true', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'description' => 'The ID of the request.', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'bizTraceId' => ['type' => 'string', 'description' => 'The ID of the business trace.', 'title' => '', 'example' => 'e339260ed64c95d'], ], - 'backendName' => 'customTemplateEntries', - ], - 'ignoreRestoredNotification' => [ 'title' => '', - 'description' => 'Whether to notify on recovery.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'ignoreRestoredNotification', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'NotifyStrategyForView' => [ - 'title' => 'A short description of struct', - 'description' => 'Entity for viewing.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'routes' => [ + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateBizTrace', + 'summary' => 'Creates a business trace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', + ], + 'CreateCloudResource' => [ + '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' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', 'title' => ''], + ], + 'description' => '', 'title' => '', - 'description' => 'Notification channel routing configuration.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Routing object.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'channels' => [ - 'title' => '', - 'description' => 'Notification channel.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Notification channel.', - 'visibility' => 'Public', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateCloudResource', + 'summary' => 'Creates a cloud resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateCloudResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'CloudResource', 'arn' => 'acs:cms:{#regionId}:{#accountId}:cloudresource'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'CreateContextStore' => [ + 'summary' => 'Creates a context store.', + 'path' => '/workspace/{workspace}/contextstore', + '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], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'contextStoreName' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'title' => ''], + 'contextType' => ['description' => 'The type of the context store.', 'type' => 'string', 'required' => true, 'example' => 'memory', 'title' => ''], + 'description' => ['description' => 'The description of the context store.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + 'config' => [ + 'type' => 'object', + 'properties' => [ + 'source' => [ 'type' => 'object', 'properties' => [ - 'enabledSubChannels' => [ - 'title' => '', - 'description' => 'Enabled notification types.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Channel.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SMS', - 'extendType' => 'true', - ], - 'backendName' => 'enabledSubChannels', - ], - 'receivers' => [ - 'title' => '', - 'description' => 'Channel recipient.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Recipient.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user1', - 'extendType' => 'true', - ], - 'required' => true, - 'backendName' => 'receivers', - ], - 'channelType' => [ - 'title' => '', - 'description' => 'Channel type.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'CONTACT', - 'backendName' => 'channelType', - 'enum' => [ - 'DING', - 'WEIXIN', - 'FEISHU', - 'SLACK', - 'TEAMS', - 'CONTACT', - 'GROUP', - 'DUTY', - ], - ], + 'project' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'required' => false, 'example' => 'sls-test-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Log Service Logstore.', 'type' => 'string', 'required' => false, 'example' => 'sls-test-logstore', 'title' => ''], + 'startTime' => ['description' => 'The effective start time.', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '1751508233000', 'title' => ''], ], - 'extendType' => 'true', + 'description' => 'The configuration source.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'backendName' => 'channels', - ], - 'filterSetting' => [ - 'description' => 'Routing settings.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'effectTimeRange' => [ - 'title' => '', - 'description' => 'Field.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'startTimeInMinute' => [ - 'title' => '', - 'description' => 'Start time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1438', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'startTimeInMinute', - ], - 'timeZone' => [ - 'title' => '', - 'description' => 'Time Zone.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '+08:00', - 'backendName' => 'timeZone', - ], - 'dayInWeek' => [ - 'title' => '', - 'description' => 'Effective days (Monday to Sunday).', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '1–7 represents Monday to Sunday.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'extendType' => 'true', - ], - 'backendName' => 'dayInWeek', - ], - 'endTimeInMinute' => [ - 'title' => '', - 'description' => 'End time (in minutes).', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1439', - 'minimum' => '0', - 'example' => '60', - 'backendName' => 'endTimeInMinute', - ], + 'metadataField' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value map that defines the metadata fields and their corresponding data sources.', 'type' => 'string', 'example' => ' {'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }', 'title' => ''], + 'description' => 'The metadata fields.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'backendName' => 'effectTimeRange', ], - 'severities' => [ - 'description' => 'Severity level list.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Severity levels: CRITICAL, WARNING, INFO.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'INFO', - 'extendType' => 'true', - ], - 'backendName' => 'severities', + 'description' => 'The configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test_dataset', 'title' => ''], ], + 'description' => 'The properties of the dataset.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'extendType' => 'true', ], - 'required' => true, - 'backendName' => 'routes', - ], - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'notifyStrategyName' => [ + 'description' => 'The request body.', + 'required' => false, 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Test policy.'."\n", - 'backendName' => 'notifyStrategyName', + 'example' => '', ], - 'notifyStrategyId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '12312-31-23-123-1-23123', - 'backendName' => 'notifyStrategyId', + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', 'title' => ''], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], - 'createTime' => [ + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateContextStore', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', + ], + 'CreateContextStoreAPIKey' => [ + 'summary' => 'Creates an API key for a context store.', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/apikey', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The display name of the API key. Use this name to identify its purpose.', 'type' => 'string', 'required' => true, 'example' => 'Production Service Key', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, 'title' => '', - 'description' => 'Create Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', + 'example' => '', ], - 'enable' => [ + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], + 'apiKey' => ['description' => 'The value of the API key. This value is returned only upon creation. Store it in a secure location.', 'type' => 'string', 'example' => 'sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'title' => ''], + 'name' => ['description' => 'The display name of the API key.', 'type' => 'string', 'example' => 'Production Service Key', 'title' => ''], + ], 'title' => '', - 'description' => 'Whether enabled.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', + 'description' => 'The response data.', + 'example' => '', ], - 'description' => [ + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateContextStoreAPIKey', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"apiKey\\": \\"sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\",\\n \\"name\\": \\"Production Service Key\\"\\n}","type":"json"}]', + ], + 'CreateDataset' => [ + 'summary' => 'Creates a dataset.', + 'path' => '/workspace/{workspace}/dataset', + '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' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'datasetName' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], + 'description' => ['description' => 'The description of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'schema' => [ + 'type' => 'object', + 'required' => true, + 'additionalProperties' => ['description' => 'The definition of a field in the schema.', '$ref' => '#/components/schemas/IndexKey', 'title' => '', 'example' => ''], + 'description' => 'The schema of the dataset.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'description', + 'example' => '', ], - 'updateTime' => [ + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + ], 'title' => '', - 'description' => 'Update Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-05-30T02:29:09Z', - 'backendName' => 'updateTime', + 'description' => 'The data returned.', + 'example' => '', ], - 'groupingSetting' => [ - 'title' => '', - 'description' => 'Grouping Setting.', - 'visibility' => 'Public', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'CreateDeliveryTask' => [ + 'summary' => 'Create a data delivery task to deliver metric data from a data source to a storage destination or message queue. This task supports three delivery types: Prometheus Remote Write, Kafka, and MaxCompute. You can also use tags to filter which metrics are delivered and attach custom tags to them.', + 'path' => '/delivery-tasks', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ 'type' => 'object', 'properties' => [ - 'groupingKeys' => [ - 'title' => '', - 'description' => 'Grouping Keys', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Grouping Key.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'severity', - 'extendType' => 'true', - ], - 'backendName' => 'groupingKeys', - ], - 'times' => [ + 'taskName' => ['description' => 'The name of the task. The name can contain Chinese characters, English letters, underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => 'my-task', 'title' => ''], + 'dataSourceId' => ['description' => 'The ID of the Prometheus instance that serves as the data source.', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxx', 'title' => ''], + 'taskDescription' => ['description' => 'The task description.', 'type' => 'string', 'required' => false, 'example' => 'my delivery task', 'title' => ''], + 'labelFiltersType' => [ + 'description' => 'The mode for applying the label filters.', + 'type' => 'string', + 'enum' => ['Allow', 'Deny'], + 'required' => false, + 'example' => 'Allow', 'title' => '', - 'description' => 'Trigger count.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'times', ], - 'periodMin' => [ + 'labelFilters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value pair that specifies a filter condition. For example, `__name__: up` or `job: my_job`.', 'type' => 'string', 'example' => '__name__: up', 'title' => ''], + 'description' => 'The label conditions for filtering metrics. The key is the label name and the value is the value to match. The filtering behavior is controlled by `labelFiltersType`.', + 'required' => false, 'title' => '', - 'description' => 'Check interval in minutes.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'periodMin', + 'example' => '', ], - 'silenceSec' => [ + 'externalLabels' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value pair for an external label. For example, `region: cn-hangzhou`.', 'type' => 'string', 'example' => 'region: cn-hangzhou', 'title' => ''], + 'description' => 'A map of key-value pairs to attach as additional labels to all delivered metrics.', + 'required' => false, 'title' => '', - 'description' => 'Silence duration in seconds.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'backendName' => 'silenceSec', + 'example' => '', ], - ], - 'required' => true, - 'backendName' => 'groupingSetting', - ], - 'customTemplateEntries' => [ - 'title' => '', - 'description' => 'Notification channel template.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Notification template configuration.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'templateUuid' => [ - 'title' => '', - 'description' => 'Template UUID.', - 'visibility' => 'Public', - 'type' => 'string', + 'sinkList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'sinkType' => [ + 'description' => 'The type of the delivery destination (sink).', + 'type' => 'string', + 'required' => true, + 'enum' => ['Prometheus', 'AcsMaxCompute', 'AcsKafka'], + 'example' => 'Prometheus', + 'title' => '', + ], + 'sinkConfigs' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A configuration setting for the sink. The available settings depend on the `sinkType`.', 'type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'title' => ''], + 'description' => 'The configuration for the sink, specified as key-value pairs. The valid keys and values depend on the value of `sinkType`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => '123-12-312-312-31-23', - 'backendName' => 'templateUuid', + 'description' => 'An object that contains the configuration for a delivery destination.', + 'title' => '', + 'example' => '', ], - 'targetType' => [ + 'required' => true, + 'description' => 'An array of delivery destination objects.', + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-ae******ey', 'title' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the resource tag.', 'type' => 'string', 'required' => false, 'example' => '_cms_workspace', 'title' => ''], + 'value' => ['description' => 'The value of the resource tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + 'description' => 'A resource tag, specified as a key-value pair.', + 'required' => false, 'title' => '', - 'description' => 'Notification type.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'SMS', - 'backendName' => 'targetType', + 'example' => '', ], + 'description' => 'An array of resource tags.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'extendType' => 'true', ], - 'backendName' => 'customTemplateEntries', - ], - 'ignoreRestoredNotification' => [ - 'title' => '', - 'description' => 'Whether to notify on recovery.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'ignoreRestoredNotification', - ], - 'userId' => [ + 'description' => 'The request body.', + 'required' => false, 'title' => '', - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123****', - 'backendName' => 'userId', + 'example' => '', ], ], ], - 'PrometheusManagedInstance' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum-xxx', - 'backendName' => 'prometheusInstanceId', - ], - 'prometheusInstanceName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum-xxx', - 'backendName' => 'prometheusInstanceName', - ], - 'regionId' => [ + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The unique ID for the request.', 'type' => 'string', 'title' => '', 'example' => '4CB23A2E-B426-5D4B-9AA2-6C7A508D954B'], + 'taskId' => ['description' => 'The ID of the delivery task.', 'type' => 'string', 'example' => '98e367d8fb8cc83b', 'title' => ''], + ], 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', + 'description' => 'The data returned in the response.', + 'example' => '', ], - 'workspace' => [ - 'title' => '', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDeliveryTask', + 'requestParamsDescription' => '### SinkConfigs parameters'."\n" + ."\n" + .'**sinkType = Prometheus**'."\n" + ."\n" + .'| Key | Required | Description | Example value | Enumerated values |'."\n" + .'| --------------- | -------- | ------------------------------------------------------------------------- | --------------------------- | ---------------------------------------------------------------------------- |'."\n" + .'| Url | Yes | Remote Write endpoint. | `http://xxxx/api/v1/write` | |'."\n" + .'| Network | No | Network type. | `PublicNetwork` | \\- PublicNetwork (public network)
\\- PrivateNetwork (private network/VPC) |'."\n" + .'| VpcId | No | VPC ID. Required if `Network` is `PrivateNetwork`. | `vpc-xxxxxx` | |'."\n" + .'| VSwitchId | No | VSwitch ID. | `vsw-xxxxxx` | |'."\n" + .'| SecurityGroupId | No | Security group ID. | `sg-xxxxxx` | |'."\n" + .'| Header | No | Custom HTTP headers, specified as a JSON-formatted map string. | `{"aaa":"bbb","ccc":"ddd"}` | |'."\n" + .'| AuthType | No | Authentication type. | `BasicAuth` | \\- BasicAuth
\\- None |'."\n" + .'| Username | No | Username for basic authentication. Required if `AuthType` is `BasicAuth`. | `admin` | |'."\n" + .'| Password | No | Password for basic authentication. Required if `AuthType` is `BasicAuth`. | `xxxxxx` | |'."\n" + ."\n" + .'**sinkType = AcsKafka**'."\n" + ."\n" + .'| Key | Required | Description | Example value |'."\n" + .'| ---------- | -------- | ------------------ | ---------------- |'."\n" + .'| InstanceId | Yes | Kafka instance ID. | `alikafka_xxxxx` |'."\n" + .'| Topic | Yes | Kafka topic name. | `my-topic` |'."\n" + ."\n" + .'**sinkType = AcsMaxCompute**'."\n" + ."\n" + .'| Key | Required | Description | Example value |'."\n" + .'| ----------- | -------- | ------------------------ | --------------- |'."\n" + .'| ServiceName | Yes | MaxCompute service name. | `my-mc-service` |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4CB23A2E-B426-5D4B-9AA2-6C7A508D954B\\",\\n \\"taskId\\": \\"98e367d8fb8cc83b\\"\\n}","type":"json"}]', + ], + 'CreateEntityStore' => [ + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test-001'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'workspaceName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test-001'], + ], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'createTime' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', + 'example' => '', ], - 'instanceType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'instanceType', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create EntityStore', + 'summary' => 'Creates storage for an EntityStore.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEntityStore'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateEntityStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'EntityStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/entitystore'], + ], ], - 'status' => [ + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', + ], + 'CreateIntegrationPolicy' => [ + 'summary' => 'Creates an Integration Center policy.', + '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' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'entityGroup' => [ + 'description' => 'The entity group used to create the policy. You can quickly create a policy using an entity group. The clusterId and vpcId parameters are independent of each other.', + 'type' => 'object', + 'properties' => [ + 'clusterEntityType' => ['description' => 'The cluster entity type. Examples: acs.ack.cluster, acs.one.cluster, and acs.asi.cluster.', 'type' => 'string', 'required' => false, 'example' => 'acs.ack.cluster', 'title' => ''], + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'na61prod3-na61cloudhdfsssd', 'title' => ''], + 'entityUserId' => ['description' => 'The ID of the user who owns the cluster.', 'type' => 'string', 'required' => false, 'example' => '12xxxx', 'title' => ''], + 'entityGroupId' => ['description' => 'The entity group ID.', 'type' => 'string', 'required' => false, 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', 'title' => ''], + 'vpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp18fgg3ffxa9czna40xt', 'title' => ''], + 'disablePolicyShare' => ['description' => 'Specifies whether to disable unique policy binding. If this parameter is set to true, you can create multiple policies for a container cluster.', 'type' => 'boolean', 'required' => false, 'example' => 'ture', 'title' => ''], + 'clusterNamespace' => ['type' => 'string', 'title' => '', 'description' => '', 'required' => false, 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'policyName' => ['title' => '', 'description' => 'The policy name.', 'type' => 'string', 'required' => false, 'example' => 'prod-database'], + 'policyType' => ['title' => '', 'description' => 'The policy type. Valid values: CS, ECS, and Cloud.', 'type' => 'string', 'required' => true, 'example' => 'CS'], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz2km4kmhtbii', 'title' => ''], + 'tags' => [ + 'description' => 'The resource tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource tags.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'use', 'title' => ''], + 'value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'database', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'workspace' => ['title' => '', 'description' => 'The workspace.', 'type' => 'string', 'required' => false, 'example' => 'prometheus'], + ], + 'required' => false, 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Running', - 'backendName' => 'status', + 'example' => '', ], ], ], - 'PushingSetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'templateUuid' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"template-abc123"', - 'backendName' => 'templateUuid', - ], - 'alertActionIds' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"action-123"', - 'extendType' => 'true', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'policy' => [ + 'description' => 'The upload policy.', + 'type' => 'object', + 'properties' => [ + 'entityGroupId' => ['description' => 'The entity group ID.', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', 'title' => ''], + 'policyId' => ['title' => '', 'description' => 'The policy ID.', 'type' => 'string', 'example' => 'policy-14c8e9a29b0a46da843f8781471062ff'], + 'policyName' => ['title' => '', 'description' => 'The policy name.', 'type' => 'string', 'example' => 'metrics-inner-manage'], + 'policyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'CS'], + 'regionId' => ['title' => '', 'description' => 'The region.', 'type' => 'string', 'example' => 'cn-heyuan'], + 'userId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => 'u1234567'], + 'workspace' => ['title' => '', 'description' => 'The workspace where the policy resides.', 'type' => 'string', 'example' => 'prometheus'], + ], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'created' => ['description' => 'Indicates whether the policy was created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'backendName' => 'alertActionIds', - ], - 'restoreActionIds' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"restore-789"', - 'extendType' => 'true', - ], - 'backendName' => 'restoreActionIds', + 'title' => '', + 'example' => '', ], ], ], - 'RepeatNotifySetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'endIncidentState' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"Resolved"', - 'backendName' => 'endIncidentState', - ], - 'repeatInterval' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '5', - 'backendName' => 'repeatInterval', - ], + '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' => 'Create Access Center Policy', + 'description' => 'This operation creates an event integration.', + 'changeSet' => [ + ['createdAt' => '2025-10-28T08:08:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-13T07:13:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntegrationPolicy'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'RumDnsResponse' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'domain' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rum', - 'backendName' => 'domain', - ], - 'result' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'result', - ], - 'message' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'message', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateIntegrationPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'SubscriptionForModify' => [ - 'title' => 'A short description of struct', - 'description' => 'Entity for viewing.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'notifyStrategyId' => [ - 'title' => '', - 'description' => 'Notification policy UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123', - 'backendName' => 'notifyStrategyId', - ], - 'subscriptionName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Test subscription.'."\n", - 'backendName' => 'subscriptionName', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filtering settings.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'pushingSetting' => [ - 'title' => '', - 'description' => 'Push settings.', - 'visibility' => 'Public', + ], + 'CreateMemoryStore' => [ + 'path' => '/workspace/{workspace}/memorystore', + '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], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ + 'memoryStoreName' => ['description' => 'The name of the MemoryStore. The name must be unique within the workspace.', 'type' => 'string', 'required' => true, 'example' => 'test-memory-store', 'title' => ''], + 'description' => ['description' => 'The description of the MemoryStore.', 'type' => 'string', 'required' => false, 'example' => 'Test memory store for demonstration.', 'title' => ''], + 'shortTermTtl' => ['description' => 'The short-term TTL, which is the number of conversation rounds to retain.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + 'extractionStrategies' => [ + 'description' => 'The extraction strategies to use. Valid values include `Episodic`, `Summary`, and `Fact`.', + 'type' => 'array', + 'items' => ['description' => 'An extraction strategy.', 'type' => 'string', 'required' => false, 'example' => 'Fact', 'title' => ''], + 'required' => false, 'title' => '', - 'description' => 'Template UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'templateUuid', + 'example' => '', ], - 'restoreActionIds' => [ - 'title' => '', - 'description' => 'Action integration plan ID list.', - 'visibility' => 'Public', + 'customExtractionStrategies' => [ + 'description' => 'A list of custom extraction strategies.', 'type' => 'array', - 'items' => [ - 'description' => 'Action integration plan ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'extendType' => 'true', - ], - 'backendName' => 'restoreActionIds', - ], - 'responsePlanId' => [ + 'items' => ['description' => 'A custom extraction strategy.', '$ref' => '#/components/schemas/CustomExtractionStrategy', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, 'title' => '', - 'description' => 'Action plan ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'responsePlanId', + 'example' => '', ], - 'alertActionIds' => [ - 'title' => '', - 'description' => 'Alert push action plan ID list.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Action integration ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'extendType' => 'true', + 'sourceType' => ['description' => 'The source type of the memory. Valid values are `None` and `Trace`.', 'type' => 'string', 'example' => 'None/Trace', 'title' => ''], + 'traceSourceConfig' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => 'The name of the workspace that contains the trace source.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''], + 'query' => ['description' => 'The query to filter traces.', 'type' => 'string', 'example' => '(serviceName : "langchain-rag" or serviceName : "agentscope-code-correction") and hostname = frontend-proxy-999c48c8d-hvk6c ', 'title' => ''], + 'includeOutput' => ['description' => 'Specifies whether to include the output in the trace.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], - 'backendName' => 'alertActionIds', + 'description' => 'Configuration for the trace source. Required if `sourceType` is `Trace`.', + 'title' => '', + 'example' => '', ], ], - 'backendName' => 'pushingSetting', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'SubscriptionForView' => [ - 'title' => 'A short description of struct', - 'description' => 'Entity for viewing.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'notifyStrategyId' => [ - 'title' => '', - 'description' => 'Notification policy UUID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '23123123', - 'backendName' => 'notifyStrategyId', - ], - 'createTime' => [ - 'title' => '', - 'description' => 'Create Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', - ], - 'enable' => [ - 'title' => '', - 'description' => 'Whether enabled.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], - 'subscriptionName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Subscription test.'."\n", - 'backendName' => 'subscriptionName', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response data.', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'ID of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'example' => '', ], - 'filterSetting' => [ - 'description' => 'Filtering settings.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a memory store', + 'summary' => 'Creates a MemoryStore.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMemoryStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], ], - 'updateTime' => [ + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'CreatePipeline' => [ + 'path' => '/workspace/{workspace}/pipeline', + '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' => 'The workspace name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'workspace-test'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'pipelineName' => ['description' => 'The pipeline name.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], + 'description' => ['description' => 'The pipeline description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'pipeline' => [ + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The node ID.', 'type' => 'string', 'required' => false, 'example' => 'node_1', 'title' => ''], + 'type' => ['description' => 'The node type.', 'type' => 'string', 'required' => false, 'example' => 'dedup-fuzzy', 'title' => ''], + 'parameters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'A key-value map of the node parameters.', 'type' => 'any', 'example' => '{'."\n" + .' "output": "ID,key_0,key_2,key_3,key_4",'."\n" + .' "workspace": "workspace-test-dataset",'."\n" + .' "field": "key_0",'."\n" + .' "global": true,'."\n" + .' "dataset": "dataset_1"'."\n" + .' }', 'title' => ''], + 'description' => 'The node parameters.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A node object.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'The pipeline nodes.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The pipeline configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The data source type.', 'type' => 'string', 'required' => false, 'example' => 'logstore', 'title' => ''], + 'logstore' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The Log Service Project name.', 'type' => 'string', 'required' => false, 'example' => 'test-project', 'title' => ''], + 'logstore' => ['description' => 'The Logstore name.', 'type' => 'string', 'required' => false, 'example' => 'test-logstore', 'title' => ''], + 'query' => ['description' => 'The query statement to filter logs.', 'type' => 'string', 'required' => false, 'example' => 'status:500 and method:GET', 'title' => ''], + ], + 'description' => 'The Log Service Logstore configuration. This parameter is required when `source.type` is set to `logstore`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data source.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'sink' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The sink type.', 'type' => 'string', 'required' => false, 'example' => 'dataset', 'title' => ''], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + 'dataset' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => false, 'example' => 'dataset_1', 'title' => ''], + ], + 'description' => 'The destination dataset configuration. This parameter is required when `sink.type` is set to `dataset`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data sink for the processed output.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'executePolicy' => [ + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => 'The execution mode. Set to `runOnce` for a single execution, or `scheduled` for a recurring execution.', 'type' => 'string', 'required' => false, 'example' => 'runOnce', 'title' => ''], + 'runOnce' => [ + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + 'toTime' => ['description' => 'The end timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + ], + 'description' => 'The configuration for a one-time execution. This parameter is required when `executePolicy.mode` is set to `runOnce`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'scheduled' => [ + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The execution interval in seconds.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], + 'fromTime' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + ], + 'description' => 'The configuration for a scheduled execution. This parameter is required when `executePolicy.mode` is set to `scheduled`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The execution policy.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, 'title' => '', - 'description' => 'Update Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-05-23T02:29:02Z', - 'backendName' => 'updateTime', - ], - 'subscriptionId' => [ - 'title' => 'UUID', - 'description' => 'UUID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123123', - 'backendName' => 'subscriptionId', + 'example' => '', ], - 'userId' => [ + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-***'], + ], 'title' => '', - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'userId', + 'description' => 'The response data.', + 'example' => '', ], - 'pushingSetting' => [ - 'title' => '', - 'description' => 'Push settings.', - 'visibility' => 'Public', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreatePipeline', + 'summary' => 'Create a pipeline.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', + ], + 'CreatePrometheusInstance' => [ + 'summary' => 'Creates a Managed Service for Prometheus instance.', + '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' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'templateUuid' => [ + 'archiveDuration' => [ 'title' => '', - 'description' => 'Template UUID.', - 'visibility' => 'Public', + 'description' => 'The number of days that data is automatically archived after the storage period expires. A value of 0 indicates that data is not archived. Valid values for the archive duration:'."\n" + .'* V1: 60 to 365 days.'."\n" + .'* V2: 60 to 3650 days (3650 indicates permanent retention).', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => [], + 'required' => false, + 'example' => '60', + ], + 'authFreeReadPolicy' => ['description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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" + .'}', 'title' => ''], + 'authFreeWritePolicy' => ['description' => 'The authentication-free write policy.', '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" + .'}', 'title' => ''], + 'enableAuthFreeRead' => ['description' => 'Specifies whether to enable authentication-free read. This parameter is supported only for V2 instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'enableAuthFreeWrite' => ['description' => 'Specifies whether to enable authentication-free write. This parameter is supported only for V2 instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'enableAuthToken' => ['description' => 'Specifies whether to enable the authorization token. This parameter is supported only for V1 instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'prometheusInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'name1', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz5qqvjyatgoy', 'title' => ''], + 'status' => [ + 'description' => 'The instance status.', + 'enumValueTitles' => ['Running' => 'Running', 'Stoped' => 'Stoped'], 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'templateUuid', + 'default' => 'Running', + 'enum' => ['Running'], + 'required' => false, + 'example' => 'Running', + 'title' => '', ], - 'restoreActionIds' => [ + 'storageDuration' => [ 'title' => '', - 'description' => 'Recovery push action integration ID list.', - 'visibility' => 'Public', + 'description' => 'The storage duration (in days):'."\n" + .'* By write volume: 90 or 180.'."\n" + .'* By metric reporting volume: 15, 30, 60, 90, or 180.', + 'enumValueTitles' => [15 => '15 days.', 30 => '30 days.', 60 => '60 days.', 90 => '90 days.', 180 => '180 days.'], + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['15', '30', '60', '90', '180'], + 'required' => false, + 'example' => '90', + ], + 'tags' => [ + 'description' => 'The tags.', 'type' => 'array', 'items' => [ - 'description' => 'Action integration ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'extendType' => 'true', + 'description' => 'The tags.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => '110109200001214284', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'backendName' => 'restoreActionIds', - ], - 'responsePlanId' => [ + 'required' => false, 'title' => '', - 'description' => 'Action plan ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'backendName' => 'responsePlanId', + 'example' => '', ], - 'alertActionIds' => [ + 'workspace' => ['title' => '', 'description' => 'The workspace to which the instance belongs. Default value: default-cms-{userId}-{regionId}.', 'type' => 'string', 'required' => false, 'example' => 'wokspace1'], + 'paymentType' => [ 'title' => '', - 'description' => 'Alert push action integration ID list.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Action integration ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123', - 'extendType' => 'true', - ], - 'backendName' => 'alertActionIds', + 'description' => 'The billable methods. Valid values:'."\n" + .'* POSTPAY: pay-as-you-go by metric reporting volume.'."\n" + .'* POSTPAY_GB: pay-as-you-go by metric write volume.'."\n" + .'If this parameter is left empty, the default billing method configured by the user is used. If the user has not configured a default billing method, the system uses pay-as-you-go by metric reporting volume.', + 'enumValueTitles' => ['POSTPAY' => 'reporting volume.', 'POSTPAY_GB' => 'write volume.'], + 'type' => 'string', + 'enum' => ['POSTPAY', 'POSTPAY_GB'], + 'required' => false, + 'example' => 'POSTPAY', ], ], - 'backendName' => 'pushingSetting', - ], - ], - ], - 'Tag' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'env', - 'maxLength' => 128, - 'backendName' => 'key', - ], - 'value' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'maxLength' => 256, - 'backendName' => 'value', - ], - ], - ], - 'TransformAction' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'mapping' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"warning":"WARNING"}', - ], - 'backendName' => 'mapping', - ], - 'variable' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'var1', - 'backendName' => 'variable', - ], - 'filterSetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'source' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'data.subject', - 'backendName' => 'source', - ], - 'labelKey' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'labelkey1', - 'backendName' => 'labelKey', - ], - 'type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SET_FIELD', - 'backendName' => 'type', - ], - 'value' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'value1', - 'backendName' => 'value', - ], - 'regExp' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '(.*):(.*)', - 'backendName' => 'regExp', - ], - 'target' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SUBJECT', - 'backendName' => 'target', - ], - ], - ], - 'TransformerForModify' => [ - 'title' => 'A short description of struct', - 'description' => 'Data transformer.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'sortId' => [ - 'title' => '', - 'description' => 'Sort order.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'sortId', - ], - 'quitAfterMatch' => [ - 'title' => '', - 'description' => 'Exit after matching processing.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'quitAfterMatch', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filter Setting.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'transformerName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - 'backendName' => 'transformerName', - ], - 'actions' => [ - 'title' => '', - 'description' => 'Transformation operation.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Processing action.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TransformAction', - ], - 'backendName' => 'actions', - ], - ], - ], - 'TransformerForView' => [ - 'title' => 'A short description of struct', - 'description' => 'Data transformer.', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'title' => 'workspace', - 'description' => 'workspace', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace-test', - 'backendName' => 'workspace', - ], - 'createTime' => [ - 'title' => '', - 'description' => 'Create Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-11T08:21:58Z', - 'backendName' => 'createTime', - ], - 'enable' => [ - 'title' => '', - 'description' => 'Whether enabled.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], - 'sortId' => [ - 'title' => '', - 'description' => 'Sort order.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'sortId', - ], - 'transformerId' => [ - 'title' => 'transformer Id', - 'description' => 'transformer Id', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1123123123123', - 'backendName' => 'transformerId', - ], - 'quitAfterMatch' => [ - 'title' => '', - 'description' => 'Exit after matching processing.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'quitAfterMatch', - ], - 'description' => [ - 'title' => '', - 'description' => 'Description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'workspace test', - 'backendName' => 'description', - ], - 'filterSetting' => [ - 'description' => 'Filter Setting.', - 'visibility' => 'Public', - 'backendName' => 'filterSetting', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'updateTime' => [ - 'title' => '', - 'description' => 'Update Time.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-01-16T02:27:01Z', - 'backendName' => 'updateTime', - ], - 'transformerName' => [ - 'title' => '', - 'description' => 'Name.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Test processing flow.'."\n", - 'backendName' => 'transformerName', - ], - 'actions' => [ - 'title' => '', - 'description' => 'Transformation operation.', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Processing action.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TransformAction', - ], - 'backendName' => 'actions', - ], - 'userId' => [ + 'required' => false, 'title' => '', - 'description' => 'User ID.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123123123**', - 'backendName' => 'userId', + 'example' => '', ], ], ], - 'WorkspaceFilterSetting' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'tagSelector' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'tagSelector', - '$ref' => '#/components/schemas/FilterSetting', - ], - 'workspaceUuids' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '"ws-abc123"', - 'extendType' => 'true', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-abc123'], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', 'title' => ''], ], - 'backendName' => 'workspaceUuids', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - ], - ], - 'apis' => [ - 'PutWorkspace' => [ - 'summary' => 'Create Workspace', - 'path' => '/workspace/{workspaceName}', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => 'Create a prometheus instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreatePrometheusInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusInstance', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/*'], + ], + ], + ], ], + ], + 'CreatePrometheusView' => [ + 'summary' => 'Creates a Prometheus view.', + 'path' => '/prometheus-views', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => 'Body parameters', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'displayName' => [ + 'authFreeReadPolicy' => ['description' => 'Not in use.', '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" + .'}', 'title' => ''], + 'enableAuthFreeRead' => ['title' => '', 'description' => 'Specifies whether anonymous read is supported.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '', 'description' => 'Specifies whether authToken is supported.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'prometheusInstances' => [ + 'description' => 'The list of Prometheus instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'arms-1d581fac20a462dcde743d9628', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '167271234567890', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, 'title' => '', - 'description' => 'Display name of the workspace', + 'example' => '', + ], + 'prometheusViewName' => ['description' => 'The Prometheus view name.', 'type' => 'string', 'required' => true, 'example' => 'test-prom-view-name', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + 'status' => [ + 'description' => 'Not in use.', + 'enumValueTitles' => ['Running' => 'Running.'], 'type' => 'string', + 'default' => 'Running', + 'enum' => ['Running'], 'required' => false, - 'example' => 'workspace-test', - 'maxLength' => 256, + 'example' => 'null', + 'title' => '', ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => 'Description of the workspace', - 'type' => 'string', + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'test-key', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'test-value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'workspace test', - 'maxLength' => 256, - 'pattern' => '', - 'default' => '', + 'title' => '', + 'example' => '', ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => 'Name of the Log Service project', + 'version' => [ + 'title' => '', + 'description' => 'Valid values:'."\n" + .'- V1: legacy version'."\n" + .'- V2: new version.', + 'enumValueTitles' => ['V1' => 'V1 version.', 'V2' => 'V2 version.'], 'type' => 'string', 'required' => true, - 'example' => 'sls-project-test-001', - 'maxLength' => 128, - 'minLength' => 1, - 'default' => '', + 'enum' => ['V1', 'V2'], + 'example' => 'V2', ], + 'workspace' => ['title' => '', 'description' => 'Default value: default-cms-{userId}-{regionId}.', 'type' => 'string', 'required' => false, 'example' => 'cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor'], ], 'required' => false, - ], - ], - [ - 'name' => 'workspaceName', - 'in' => 'path', - 'schema' => [ - 'description' => 'Name of the workspace', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'maxLength' => 56, - 'minLength' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response schema', + 'title' => '', + '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' => 'Name of the workspace.', - 'type' => 'string', - 'example' => 'workspace-test-001', - ], + 'prometheusViewId' => ['description' => 'The Prometheus view ID.', 'type' => 'string', 'example' => 'cd5237f7dbd574cf9bbd648ff9efb16cd', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', - 'title' => 'Create or Modify Workspace', - 'translator' => 'machine', - ], - 'GetWorkspace' => [ - 'summary' => 'Get Workspace', - 'path' => '/workspace/{workspaceName}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"cd5237f7dbd574cf9bbd648ff9efb16cd\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => 'Create a prometheus view', + 'description' => 'Creates a site monitoring task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreatePrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/*'], + ], + ], + ], ], + ], + 'CreatePrometheusVirtualInstance' => [ + 'path' => '/virtual-instances', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'workspaceName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例 ID。', - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'namespace' => ['title' => '每个云产品在每个Regin只能创建一个虚拟实例', 'description' => 'Each cloud product supports only one virtual instance per region.', 'type' => 'string', 'required' => true, 'example' => 'cms_prometheus'], + 'tenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'description' => 'Creation Time', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => 'Workspace Description', - 'type' => 'string', - 'example' => 'workspace test', - 'pattern' => '', - 'default' => '', - ], - 'lastModifyTime' => [ - 'description' => 'Last Modified Time', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'regionId' => [ - 'title' => '地域ID', - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'pattern' => '', - 'default' => '', - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => 'Log Service Project Name', - 'type' => 'string', - 'example' => 'sls-project-test-001', - 'pattern' => '', - 'default' => '', - ], - 'workspaceName' => [ - 'title' => '工作空间名称', - 'description' => 'Workspace Name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'pattern' => '', - 'default' => '', - ], - 'displayName' => [ - 'description' => 'Workspace Display Name', - 'type' => 'string', - 'example' => 'workspace-test', + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************', 'title' => ''], + 'instance' => [ + 'title' => '实例ID', + 'description' => 'The instance.', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['title' => '地域ID', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-e815960b4c9ebc5c3d89790c7e82'], + 'regionId' => ['title' => '用户ID', 'description' => 'Region ID', 'type' => 'string', 'example' => 'cn-zhengzhou-jva'], + 'userId' => ['title' => '用户ID', 'description' => 'The user ID.', 'type' => 'string', 'example' => '167212345678'], + 'namespace' => ['title' => '云产品', 'description' => 'The cloud product.', 'type' => 'string', 'example' => 'ack-csi-fuse'], + 'httpApiUrl' => ['title' => 'HTTP API查询地址', 'description' => 'The HTTP API query URL.', 'type' => 'string', 'example' => 'http://xxxxxxx'], + 'createdAt' => ['title' => '创建时间', 'description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '1751520976660'], + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Get Workspace', - 'translator' => 'machine', - ], - 'ListWorkspaces' => [ - 'summary' => 'Get Workspace List', - 'path' => '/workspace', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Prometheus Monitoring Virtual Instance', + 'summary' => 'Creates a virtual instance for Prometheus monitoring.', + 'description' => 'Creates a virtual instance for Prometheus monitoring.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusVirtualInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreatePrometheusVirtualInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'CreateService' => [ + 'summary' => 'Creates a service for application observability.', + 'path' => '/workspace/{workspace}/service', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcms5OJOSH', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'workspaceName', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Workspace name, fuzzy search', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'serviceName' => ['description' => 'The service name.', 'type' => 'string', 'required' => true, 'example' => 'mag_test', 'title' => ''], + 'serviceType' => [ + 'description' => 'The service type.', + 'enumValueTitles' => ['TRACE' => 'application performance monitoring', 'RUM' => 'Real User Monitoring', 'XTRACE' => 'OpenTelemetry Tracing Analysis'], + 'type' => 'string', + 'required' => true, + 'example' => 'TRACE', + 'title' => '', + ], + 'displayName' => ['description' => 'The display name. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'Mag test application', 'title' => '', 'required' => false], + 'description' => ['description' => 'The service description. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'Mag test application', 'title' => '', 'required' => false], + 'attributes' => ['description' => 'The extended properties.', 'type' => 'string', 'example' => '{"language":"java"}', 'title' => '', 'required' => false], + 'serviceStatus' => ['description' => 'The service status. Do not specify this parameter when you create a service.', 'type' => 'string', 'example' => 'Created', 'title' => '', 'required' => false], + 'pid' => ['description' => 'The application ID. You do not typically need to specify this parameter.', 'type' => 'string', 'example' => 'bx3udsi5ie@ed2ba6beebdb6de', 'title' => '', 'required' => false], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxxxx', 'title' => '', 'required' => false], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The `key` of the tag.', 'type' => 'string', 'example' => 'env', 'title' => '', 'required' => false], + 'value' => ['description' => 'The `value` of the tag.', 'type' => 'string', 'example' => 'prod', 'title' => '', 'required' => false], + ], + 'description' => 'A tag.', + 'title' => '', + 'required' => false, + 'example' => '', + ], + 'description' => 'An array of tags.', + 'title' => '', + 'example' => '', + 'required' => false, + ], + ], 'required' => false, - 'example' => 'workspace-test-001', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination Token', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxxxxxx', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1793369865235921-cn-shenzhen', 'title' => ''], ], - [ - 'name' => 'maxResults', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Page size'."\n" - .'Default value:'."\n" - .' 50'."\n" - .'Maximum value:'."\n" - .' 50', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '0', - 'example' => '10', - 'default' => '100', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3A2FA9E9-9CF1-5CB1-A808-52828F14310D', 'title' => ''], + 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], + 'pid' => ['description' => 'The ID of the ARMS application for backward compatibility.', 'type' => 'string', 'example' => 'cwzxvuc6uo@d60088ad4797d26', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'Create Application Observability Service', + 'requestParamsDescription' => 'For the attributes extended property, you can specify the language property. If serviceType is set to TRACE, valid values for language are java, python, and golang. If serviceType is set to XTRACE, see the open source specifications at https\\://opentelemetry.io/docs/specs/semconv/registry/attributes/telemetry/ for valid language values.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'workspaceNameList', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'Workspace name, exact match', - 'type' => 'array', - 'items' => [ - 'description' => 'Workspace name, exact match', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test-001', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/*'], ], - 'required' => false, - 'example' => 'workspace-test-001', ], ], + ], + 'translator' => 'manual', + ], + 'CreateServiceObservability' => [ + 'summary' => 'Creates application observability and prepares the prerequisite resources required for integration.', + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1654218965343050-cn-hangzhou', 'title' => ''], + ], [ - 'name' => 'region', - 'in' => 'query', + 'name' => 'type', + 'in' => 'path', 'schema' => [ - 'description' => 'Region', + 'description' => 'The type of application observability.', + 'enumValueTitles' => ['rum' => 'Real User Monitoring', 'apm' => 'Application Performance Monitoring'], 'type' => 'string', - 'required' => false, - 'example' => 'cn-heyuan', + 'required' => true, + 'example' => 'apm', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => 'Page size'."\n" - .'Default value:'."\n" - .' 50'."\n" - .'Maximum value:'."\n" - .' 50', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'nextToken' => [ - 'description' => 'Pagination Token', - 'type' => 'string', - 'example' => 'xxxxxxxxxx', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID'."\n" - ."\n", - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'total' => [ - 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', - 'description' => 'Total count', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'workspaces' => [ - 'title' => '数组，返回示例目录。', - 'description' => 'List of workspaces', - 'type' => 'array', - 'items' => [ - 'title' => 'WorkspaceItemType', - 'description' => 'WorkspaceItemType', - 'type' => 'object', - 'properties' => [ - 'createTime' => [ - 'description' => 'Creation time', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'displayName' => [ - 'description' => 'Workspace display name', - 'type' => 'string', - 'example' => 'workspace-test', - ], - 'description' => [ - 'title' => '工作空间描述', - 'description' => 'Workspace description', - 'type' => 'string', - 'example' => 'workspace test', - 'pattern' => '', - 'default' => '', - ], - 'lastModifyTime' => [ - 'description' => 'Last modified time', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2025-03-11T08:21:58Z', - ], - 'regionId' => [ - 'title' => '地域ID', - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'pattern' => '', - 'default' => '', - ], - 'slsProject' => [ - 'title' => '日志服务项目名称', - 'description' => 'Log Service project name', - 'type' => 'string', - 'example' => 'sls-project-test-001', - 'pattern' => '', - 'default' => '', - ], - 'workspaceName' => [ - 'title' => '工作空间名称', - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - 'pattern' => '', - 'default' => '', - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - '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' => 'Get Workspace List', - 'translator' => 'machine', - ], - 'DeleteWorkspace' => [ - 'summary' => 'Delete Workspace', - 'path' => '/workspace/{workspaceName}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create application observability', + 'extraInfo' => 'Description:'."\n" + ."\n" + .'- Resource initialization involves multiple actions and may incur a delay. The API call only needs to be initiated successfully. You can call GetServiceObservability to check the status; if status returns running, the resource initialization is successful.'."\n" + ."\n" + .'- Application Performance Monitoring (APM), OpenTelemetry tracing, and Real User Monitoring (RUM) require separate resource initialization.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateServiceObservability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/service-observability/{#type}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'CreateServiceRecord' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}/record', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'workspaceName', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'serviceId', 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'em87vd@c2e25bcfe0e21ce0***', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'title' => '实例 ID。', - 'description' => 'Workspace Name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'recordType' => [ + 'title' => '', + 'description' => 'The type of the linked entry. Valid values:'."\n" + .'- logCorrelation: application log association.', + 'type' => 'string', + 'required' => true, + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', + ], + 'recordContent' => ['title' => '', 'description' => 'The entry content in JSON string format. The format may vary depending on the value of recordType.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "project": "proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou",'."\n" + .' "storeName": "app-biz-log",'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "bindType": "logstore",'."\n" + .' "traceIdRelateField": ""'."\n" + .'}'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a service-linked entry', + 'summary' => 'Creates a service-linked entry for associating configurations with the application monitoring service, such as log association.', + 'extraInfo' => 'When recordType is set to logCorrelation, two log binding types are supported:'."\n" + .'- bindType=logstore: indicates a Logstore.'."\n" + .'- bindType=storeview: indicates a StoreView.'."\n" + ."\n" + .'Ensure that the storage corresponding to the specified project and storeName values exists.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Delete Workspace', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'CreateCloudResource' => [ - 'summary' => '创建云资源中心', - 'path' => '/cloudresource', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateTicket' => [ + 'summary' => 'To share a console page or embed it into a third-party system without requiring a password, you can call the CreateTicket operation to generate a ticket. You can then use the ticket to create a password-free link.', + 'path' => '/tickets', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'expirationTime', + 'in' => 'query', + 'schema' => ['description' => '- The expiration time of the URL for the embedded page, in seconds. The value can range from 0 to 2,592,000 seconds (30 days). The default value is 86,400 seconds (one day).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '86400'], + ], + [ + 'name' => 'accessTokenExpirationTime', + 'in' => 'query', + 'schema' => ['description' => '- The expiration time of the access token, in seconds. This is the period during which a user can access the page APIs. The value can range from 0 to 86,400 seconds (one day). The default value is 86,400 seconds (one day).'."\n" + ."\n" + .'- The effective expiration time of the access token is the minimum value of accessTokenExpirationTime and expirationTime.'."\n" + ."\n" + .'- If you call the operation using a Security Token Service (STS) token, the effective expiration time of the access token is the minimum value of accessTokenExpirationTime, expirationTime, and the expiration time of the STS token.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '600'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'ticket' => ['title' => 'Id of the request', 'description' => 'The password-free ticket.', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - ], - 'GetCloudResource' => [ - 'summary' => '查询云资源中心', - 'path' => '/cloudresource', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', + 'title' => 'Create Login-free Ticket', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTicket'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateTicket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateUmodel' => [ + 'summary' => 'Creates a Umodel configuration.', + 'path' => '/workspace/{workspace}/umodel', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcms5OJOSH', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the Umodel.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace test'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '123-0F43-23423-AC43-34234'], + 'workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + 'title' => 'Create Umodel', + 'description' => 'Creates a Umodel configuration in a specified workspace.', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - ], - 'GetCloudResourceData' => [ - 'summary' => '查询云资源中心数据', - 'path' => '/cloudresource/data', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUmodel'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateUmodel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + ], + 'DeleteAddonRelease' => [ + 'summary' => 'Deletes add-on release information.', + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'from', + 'name' => 'releaseName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', - ], + 'schema' => ['title' => 'AddonRelease 的名称。', 'description' => 'The name of the AddonRelease.', 'type' => 'string', 'required' => false, 'example' => 'test-gpu-integration-name'], ], [ - 'name' => 'to', + 'name' => 'force', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', + 'title' => '是否硬性删除，默认 false。', + 'description' => 'Specifies whether to forcibly delete the add-on release. The default value is false.', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], + 'example' => 'false', ], ], [ - 'name' => 'query', + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '环境 ID。', 'description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxxx'], + ], + [ + 'name' => 'addonName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', - ], + 'schema' => ['title' => 'Addon 名称，当 AddonName 赋值时，将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', 'description' => 'The name of the add-on. If you specify this parameter, the ReleaseName parameter is ignored and all AddonReleases that belong to the add-on are uninstalled in a batch.', 'type' => 'string', 'required' => false, 'example' => 'cs-gpu'], ], ], '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' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['title' => '请求 ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC'], ], + 'description' => '', + 'title' => '', + '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}","type":"json"}]', - ], - 'DeleteCloudResource' => [ - 'summary' => '删除云资源中心', - 'path' => '/cloudresource', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => 'Uninstall Access Component', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/*'], + ], + ], + ], ], + ], + 'DeleteAggTaskGroup' => [ + 'summary' => 'Deletes an aggregation task group.', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => 'The ID of the Prometheus instance from which the aggregation task reads data.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '出参结构体', + 'description' => 'The response parameter struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['title' => '请求 id', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - ], - 'CreateEntityStore' => [ - 'summary' => 'Create storage related to EntityStore', - 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'post', + 'title' => 'Delete Aggregation Task Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteAggTaskGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}'], + ], + ], + ], ], + ], + 'DeleteAlertWebhooks' => [ + 'path' => '/webhooks', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspaceName', - 'in' => 'path', + 'name' => 'webhookIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'workspace name', - 'type' => 'string', + 'description' => 'Unique webhook identifiers.', + 'type' => 'array', + 'items' => ['description' => 'Unique webhook identifier.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => true, - 'example' => 'workspace-test-001', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response structure', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'workspaceName' => [ - 'description' => 'workspace name', - 'type' => 'string', - 'example' => 'workspace-test-001', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', - 'title' => 'Create EntityStore', - 'translator' => 'machine', - ], - 'GetEntityStore' => [ - 'summary' => 'Get EntityStore related storage information', - 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteAlertWebhooks', + 'summary' => 'Deletes one or more alert webhooks.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', + ], + 'DeleteBizTrace' => [ + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'workspaceName', + 'name' => 'bizTraceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - ], + 'schema' => ['description' => 'The ID of the business trace.', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d', 'title' => ''], ], ], 'responses' => [ @@ -8088,116 +8415,117 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'."\n", - ], - 'workspaceName' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'workspace-test-001', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - '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' => 'Get EntityStore', - 'translator' => 'machine', - ], - 'GetEntityStoreData' => [ - 'summary' => 'Query the entity and relationship data under a specified Workspace, returning the entity data within a certain time range (the returned result is transmitted after compression).', - 'path' => '/workspace/{workspace}/entitiesAndRelations', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteBizTrace', + 'summary' => 'Deletes a business trace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteBizTrace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'BizTrace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:biztrace/{#BizTraceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeleteCloudResource' => [ + 'path' => '/cloudresource', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'parameters' => [ + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteCloudResource', + 'summary' => 'Deletes a cloud resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'acceptEncoding', - 'in' => 'header', - 'schema' => [ - 'description' => 'Content encoding type for the compression algorithm', - 'type' => 'string', - 'required' => false, - 'example' => 'gzip', - 'default' => 'gzip', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteCloudResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'CloudResource', 'arn' => 'acs:cms:{#regionId}:{#accountId}:cloudresource'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DeleteContext' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context/{contextId}', + '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' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request Body', - 'type' => 'object', - 'properties' => [ - 'from' => [ - 'description' => 'Start time of the query.'."\n" - ."\n" - .'Unix timestamp format, representing the number of seconds since 1970-1-1 00:00:00 UTC.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767203', - ], - 'query' => [ - 'description' => 'Query statement', - 'type' => 'string', - 'required' => true, - 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', - ], - 'to' => [ - 'description' => 'End time of the query.'."\n" - ."\n" - .'Unix timestamp format, representing the number of seconds since 1970-1-1 00:00:00 UTC.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1721767283', - ], - ], - 'required' => false, - ], + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => 'The unique identifier of the context. This can be a generated record ID or event ID.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], ], ], 'responses' => [ @@ -8205,137 +8533,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => 'Total list of returned data', - 'type' => 'array', - 'items' => [ - 'description' => 'List of data corresponding to the request header', - 'type' => 'array', - 'items' => [ - 'description' => 'Data corresponding to the request header', - 'type' => 'string', - 'example' => 'data1', - ], - ], - ], - 'header' => [ - 'description' => 'List of request headers', - 'type' => 'array', - 'items' => [ - 'description' => 'Request header', - 'type' => 'string', - 'example' => 'headerKey', - ], - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'responseStatus' => [ - 'description' => 'Result status', - 'type' => 'object', - 'properties' => [ - 'result' => [ - 'description' => 'Execution result', - 'type' => 'string', - 'example' => 'Success,PartialSuccess,Error', - ], - 'retryPolicy' => [ - 'description' => 'Retry policy', - 'type' => 'string', - 'example' => 'None,Once,Continuous', - ], - 'level' => [ - 'description' => 'Status level', - 'type' => 'string', - 'example' => 'Info,Warn,Error', - ], - 'statusItem' => [ - 'description' => 'Detailed status information list', - 'type' => 'array', - 'items' => [ - 'description' => 'Detailed status information', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => 'Status code', - 'type' => 'string', - 'example' => 'Success,ExecuteTimeout,UModelNotExist', - ], - 'level' => [ - 'description' => 'Status level', - 'type' => 'string', - 'example' => 'Info,Warn,Error', - ], - 'message' => [ - 'description' => 'Calculation execution information', - 'type' => 'string', - 'example' => 'Query execution timeout after 30 seconds', - ], - 'suggestion' => [ - 'description' => 'Suggestions when an error occurs during execution', - 'type' => 'string', - 'example' => 'Try to reduce the query scope or increase timeout limit, then retry', - ], - ], - ], - ], - 'executionStates' => [ - 'description' => 'Information during the execution process', - 'type' => 'string', - 'example' => '{}', - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', 'title' => ''], + 'contextId' => ['description' => 'The unique identifier of the deleted context.', 'type' => 'string', 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], + 'status' => ['description' => 'The deletion status. For example, deleted.', 'type' => 'string', 'example' => 'deleted', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteContext', + 'summary' => 'Deletes a context.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Query Entity and Relationship Data', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\",\\n \\"contextId\\": \\"897294a7-67a4-4f60-976c-e136edc5f97e\\",\\n \\"status\\": \\"deleted\\"\\n}","type":"json"}]', ], - 'DeleteEntityStore' => [ - 'summary' => 'Delete EntityStore related storage', - 'path' => '/workspace/{workspaceName}/entitystore', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteContextStore' => [ + 'summary' => 'Deletes a context store.', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspaceName', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test-001', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], ], ], 'responses' => [ @@ -8343,77 +8586,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'request ID', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteContextStore', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Delete EntityStore', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'CreateUmodel' => [ - 'summary' => 'Create Umodel configuration', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteContextStoreAPIKey' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/apikey/{name}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request Body', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'Umodel description', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace test', - ], - ], - 'required' => false, - ], + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => false, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The API key\'s display name, which identifies its purpose.', 'type' => 'string', 'required' => false, 'example' => 'Production Service Key', 'title' => ''], ], ], 'responses' => [ @@ -8421,65 +8640,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '123-0F43-23423-AC43-34234', - ], - 'workspace' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'workspace-test', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteContextStoreAPIKey', + 'summary' => 'Deletes an API key.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', - 'title' => 'Create Umodel', - 'description' => 'Create Umodel configuration in the specified workspace', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', ], - 'GetUmodel' => [ - 'summary' => 'Get Umodel configuration information', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteContexts' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the ContextStore.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'title' => '', 'example' => 'test-context-store'], + ], + [ + 'name' => 'contextIds', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of context IDs.', 'type' => 'string', 'example' => 'mem_long_01,mem_long_02', 'title' => '', 'required' => false], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['description' => 'The filter condition, specified as a JSON string in the query. The syntax is the same as the `filter` parameter of the `SearchContext` operation.', 'type' => 'string', 'example' => '{"userId":"u-10001"}', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -8487,113 +8700,51 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'commonSchemaRef' => [ - 'description' => 'This field does not need to be filled currently', - 'type' => 'array', - 'items' => [ - 'description' => 'This field does not need to be filled currently', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => 'Common Umodel Schema group', - 'type' => 'string', - 'example' => 'test-job-123123', - ], - 'version' => [ - 'description' => 'Version', - 'type' => 'string', - 'example' => '5', - ], - ], - ], - ], - 'description' => [ - 'description' => 'Umodel description', - 'type' => 'string', - 'example' => 'workspace test', - ], - 'regionId' => [ - 'description' => 'Region', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '123-123123-sdf-435-3123', - ], - 'workspace' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'workspace-test', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'deletedCount' => ['description' => 'The number of deleted contexts.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteContexts', + 'summary' => 'Deletes contexts in bulk.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Get Umodel', - 'description' => 'Get Umodel configuration information', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"deletedCount\\": 55\\n}","type":"json"}]', ], - 'UpdateUmodel' => [ - 'summary' => 'Update Umodel configuration information', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'DeleteDataset' => [ + 'summary' => 'Deletes a dataset.', + 'path' => '/workspace/{workspace}/dataset/{datasetName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request Body', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'Description.', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace test', - ], - ], - 'required' => false, - ], + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], ], ], 'responses' => [ @@ -8601,65 +8752,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '234324-123-123-123-23423', - ], - 'workspace' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'workspace-test', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"234324-123-123-123-23423\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', - 'title' => 'Update Umodel', - 'description' => 'Update Umodel configuration information', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], - 'DeleteUmodel' => [ - 'summary' => 'Delete Umodel configuration information', - 'path' => '/workspace/{workspace}/umodel', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteDeliveryTask' => [ + 'summary' => 'Deletes a delivery task.', + 'path' => '/delivery-task/{taskId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'workspace', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => 'workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The delivery task ID.', 'type' => 'string', 'required' => true, 'example' => '98e367d8fb8cc83b', 'title' => ''], ], ], 'responses' => [ @@ -8667,239 +8797,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'request ID', - 'type' => 'string', - 'example' => '123123-3213-345-9941-345345345', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDeliveryTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123123-3213-345-9941-345345345\\"\\n}","type":"json"}]', - 'title' => 'Delete Umodel', - 'description' => 'Delete the Umodel under the specified workspace', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'GetUmodelData' => [ - 'summary' => 'Retrieve associated Umodel graph data', - 'path' => '/workspace/{workspace}/umodel/graph', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteEntityStore' => [ + 'path' => '/workspace/{workspaceName}/entitystore', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', + 'name' => 'workspaceName', 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], - ], - [ - 'name' => 'method', - 'in' => 'query', - 'schema' => [ - 'description' => 'Method', - 'type' => 'string', - 'required' => true, - 'example' => 'ListData', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request Body', - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'description' => 'Query conditions', - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "filter": {'."\n" - .' "domains": []'."\n" - .' },'."\n" - .' "offset": 0,'."\n" - .' "size": 100000'."\n" - .'}', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test-001'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Return result', - 'type' => 'object', - 'properties' => [ - 'nodes' => [ - 'description' => 'List of nodes', - 'type' => 'array', - 'items' => [ - 'description' => 'Nodes.', - 'type' => 'any', - 'example' => '{}', - ], - ], - 'links' => [ - 'description' => 'List of node link relationships', - 'type' => 'array', - 'items' => [ - 'description' => 'Node link relationship', - 'type' => 'any', - 'example' => '{}', - ], - ], - 'totalNodesCount' => [ - 'description' => 'Total number of nodes', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'totalLinksCount' => [ - 'description' => 'Total number of node links', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'errors' => [ - 'description' => 'Error information', - 'type' => 'array', - 'items' => [ - 'description' => 'Error information', - 'type' => 'object', - 'properties' => [ - 'message' => [ - 'description' => 'Details.', - 'type' => 'string', - 'example' => 'ok', - ], - 'type' => [ - 'description' => 'Error type', - 'type' => 'string', - 'example' => 'external', - ], - ], - ], - ], - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '123-123-234-345-123', - ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Get Umodel Data', - 'description' => 'Find Umodel', - 'translator' => 'machine', - ], - 'UpsertUmodelData' => [ - 'summary' => 'Write Umodel Elements', - 'path' => '/workspace/{workspace}/umodel/data', - 'methods' => [ - 'patch', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete EntityStore', + 'summary' => 'Deletes an EntityStore.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEntityStore'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteEntityStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'EntityStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}/entitystore'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DeleteIntegrationPolicy' => [ + 'path' => '/integration-policies/{policyId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], - ], - [ - 'name' => 'method', + 'name' => 'force', 'in' => 'query', - 'schema' => [ - 'description' => 'Method', - 'type' => 'string', - 'required' => false, - 'example' => 'Upsert', - ], + 'schema' => ['description' => 'Specifies whether to force delete the cloud native appliance.'."\n" + .'Default: `false`.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'List of elements', - 'type' => 'object', - 'properties' => [ - 'elements' => [ - 'description' => 'Element content', - 'type' => 'array', - 'items' => [ - 'description' => 'Element content', - 'type' => 'any', - 'required' => false, - 'example' => '{}', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'policy-273c360bed1948818c5fb861886bc405'], ], ], 'responses' => [ @@ -8907,89 +8906,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => 'Add or Overwrite Umodel (Elements)', - 'translator' => 'machine', - ], - 'DeleteUmodelData' => [ - 'summary' => 'Delete Umodel Elements', - 'path' => '/workspace/{workspace}/umodel/data', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Access Center Policy', + 'summary' => 'Deletes an Integration Center policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrationPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteIntegrationPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', + ], + 'DeleteMemories' => [ + 'summary' => 'Deletes memories based on filter properties. You must set at least one filter property. If no filter properties are set, a validation error is returned.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'default-cms-1793369865235921-cn-shenzhen', 'title' => ''], ], [ - 'name' => 'domain', + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the memory store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'agentId', 'in' => 'query', - 'schema' => [ - 'description' => 'Can specify the name of a specific Umodel data, leaving it blank means all', - 'type' => 'string', - 'required' => false, - 'example' => 'apm', - ], + 'schema' => ['description' => 'The agent ID of the application.', 'type' => 'string', 'required' => false, 'example' => '952730733889060865', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'userId', 'in' => 'query', - 'schema' => [ - 'description' => 'Can specify the name of a specific Umodel data, leaving it blank means all', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'test_user_001', 'title' => ''], ], [ - 'name' => 'kind', + 'name' => 'runId', 'in' => 'query', - 'schema' => [ - 'description' => 'Can specify the kind of a specific Umodel data, leaving it blank means all', - 'type' => 'string', - 'required' => false, - 'example' => 'metric_set', - ], + 'schema' => ['description' => 'The run ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-dd7c645fd6fe50d4', 'title' => ''], + ], + [ + 'name' => 'appId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => '98ea19fe-128b-4841-b318-0359bec3c65d', 'title' => ''], ], ], 'responses' => [ @@ -8997,60 +8991,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '111111-222-333-1111-33333', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteMemories', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"111111-222-333-1111-33333\\"\\n}","type":"json"}]', - 'title' => 'Delete Umodel Data', - 'description' => 'Delete the Umodel Data under a specified workspace', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'GetUmodelCommonSchemaRef' => [ - 'summary' => '获取Umodel配置信息', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteMemory' => [ + 'summary' => 'Deletes a memory.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/{memoryId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'default-cms-xxxxxx-cn-beijing', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the memory store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the memory.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], ], ], 'responses' => [ @@ -9058,756 +9046,326 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'commonSchemaRef' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'apm-common', - ], - 'version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.1.0', - ], - ], - ], - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteMemory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"apm-common\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetUmodelCommonSchemaRef', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', ], - 'DeleteUmodelCommonSchemaRef' => [ - 'summary' => '删除Umodel配置信息', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteMemoryStore' => [ + 'summary' => 'Deletes a Memory Store.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The name of the Workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'group', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'apm-common', - ], + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Memory Store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response data.', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'ID of the request', 'description' => 'The Request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a memory store', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMemoryStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => 'DeleteUmodelCommonSchemaRef', ], - 'UpsertUmodelCommonSchemaRef' => [ - 'summary' => '更新Umodel配置信息', - 'path' => '/workspace/{workspace}/umodel/common-schema-ref', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'https', - ], + 'DeletePipeline' => [ + 'path' => '/workspace/{workspace}/pipeline/{pipelineName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'workspace-test'], ], [ - 'name' => 'group', - 'in' => 'query', + 'name' => 'pipelineName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'card-service-daily01', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeletePipeline', + 'summary' => 'Deletes a pipeline.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', + ], + 'DeletePrometheusInstance' => [ + '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' => 'version', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0.1.0', - ], + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rw-abc123'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-************', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', - 'title' => 'UpsertUmodelCommonSchemaRef', - ], - 'CreateChat' => [ - 'summary' => '创建对话', - 'path' => '/chat', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Prometheus Instance', + 'summary' => 'Deletes a Prometheus instance.', + 'description' => 'Deletes a Prometheus instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', - 'sse', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeletePrometheusInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusInstance', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#prometheusInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'DeletePrometheusView' => [ + 'path' => '/prometheus-views/{prometheusViewId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/octet-stream', - ], - 'produces' => [ - 'application/octet-stream', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Prometheus view.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rw-xxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'digitalEmployeeName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'thread_id01', - ], - 'action' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'reconnect' => 'reconnect', - 'stop' => 'stop', - 'create' => 'create', - ], - 'example' => 'create', - ], - 'variables' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspace' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace01', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hongkong', - ], - 'project' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project01', - ], - 'lastMessageId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'message_id01', - ], - 'userContext' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"metadata":"test"}', - ], - ], - 'required' => false, - ], - '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', - 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'call_001', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'function', - ], - 'function' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'get_pod_metrics', - ], - 'arguments' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{ "namespace": "prod", "pod": "order-service-abc" }', - ], - '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, - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', - ], - 'interactions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user_input', - ], - 'result' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'content' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1765000012', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'references' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'metric_001', - ], - 'data' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete prometheus view instance.', + 'summary' => 'Deletes a Prometheus view instance.', + 'description' => 'Deletes a Prometheus view instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeletePrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/{#prometheusViewId}'], ], - 'required' => false, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'DeletePrometheusVirtualInstance' => [ + 'summary' => 'Deletes a Prometheus virtual instance by its ID.', + 'path' => '/virtual-instances/{prometheusInstanceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Prometheus virtual instance.', 'type' => 'string', 'required' => false, 'example' => 'virtual-xxxxxxxxxxxxxxxx', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'messages' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'title' => '消息版本号', - 'type' => 'string', - ], - 'parentCallId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sess_abc123', - 'title' => '上一层级执行ID', - ], - 'callId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'call_search_001', - 'title' => '当前执行ID', - ], - 'role' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tool', - 'title' => '消息发起角色', - ], - 'seq' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '消息序列号', - ], - 'timestamp' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'example' => '1765000005', - 'title' => 'timestamp / 纳秒', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'done', - 'title' => '消息具体类型', - ], - 'detail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - 'title' => '消息明细', - ], - 'contents' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - 'title' => '内容信息明细结构', - ], - 'title' => '内容信息', - ], - 'tools' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - 'title' => '工具明细结构', - ], - 'title' => '工具使用列表', - ], - 'agents' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - 'title' => '调用的Agent详细内容', - ], - 'title' => '调用的Agent列表', - ], - 'events' => [ - 'title' => '事件列表', - 'type' => 'array', - 'items' => [ - 'title' => '事件详细内容', - 'type' => 'object', - ], - ], - 'artifacts' => [ - 'title' => '产物产出信息', - 'type' => 'array', - 'items' => [ - 'title' => '产物明细的结构', - 'type' => 'object', - ], - ], - ], - 'title' => '消息数据明细结构', - ], - 'title' => '会话的消息列表', - ], - 'traceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '21504600000008405622576e3b48', - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个追踪ID', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0', - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个RequestID', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeletePrometheusVirtualInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'CreateDigitalEmployee' => [ - 'summary' => '创建DigitalEmployee', - 'path' => '/digital-employee', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteService' => [ + 'summary' => 'Deletes an Application Monitoring service.', + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-xxxxx', - ], - 'indexId' => [ - 'description' => '', - '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' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - ], - 'required' => false, - ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], - 'tags' => [ - 'title' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], - ], - 'required' => false, - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], ], ], 'responses' => [ @@ -9815,669 +9373,592 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51B6A3E8-EA9E-5143-BE11-8E5F83474C95', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"name\\": \\"test\\"\\n}","type":"json"}]', - ], - 'GetDigitalEmployee' => [ - 'summary' => '查询 DigitalEmployee', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Application Observability Service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/{#ServiceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"51B6A3E8-EA9E-5143-BE11-8E5F83474C95\\"\\n}","type":"json"}]', + ], + 'DeleteServiceRecord' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}/record', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'default-cms-1654218***343050-cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'serviceId', 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], + ], + [ + 'name' => 'recordType', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The type of the association entry. Valid values:'."\n" + .'logCorrelation: application log association', 'type' => 'string', 'required' => true, - 'example' => 'test', + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'acs:ram::12345678912:role/testrole', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'regionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'knowledges' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'bailian' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm-xxxxx', - ], - 'indexId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'index-xxxx', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'attributes' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'sop' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - ], - ], - 'employeeType' => [ - 'type' => 'string', - ], - 'tags' => [ - 'title' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a service association entry', + 'summary' => 'Deletes a service association entry.', + 'description' => 'Deletes a created service association entry.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DeleteUmodel' => [ + 'summary' => 'Deletes a Umodel configuration.', + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '123123-3213-345-9941-345345345'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123123-3213-345-9941-345345345\\"\\n}","type":"json"}]', + 'title' => 'Delete Umodel', + 'description' => 'Deletes a Umodel from a specified workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodel'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteUmodel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDigitalEmployee.NotFound', - 'errorMessage' => 'The specified DigitalEmployee does not exist.', + ], + 'DeleteUmodelCommonSchemaRef' => [ + 'summary' => 'Deletes a public Umodel schema reference.', + '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + [ + 'name' => 'group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The public Umodel schema group.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'title' => '', + 'example' => 'apm-common', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - ], - 'UpdateDigitalEmployee' => [ - 'summary' => '更新UpdateDigitalEmployee', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'patch', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => 'DeleteUmodelCommonSchemaRef', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelCommonSchemaRef'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteUmodelCommonSchemaRef', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + ], + 'DeleteUmodelData' => [ + 'path' => '/workspace/{workspace}/umodel/data', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'domain', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Umodel data to delete. Omit this parameter to delete all Umodel data.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'apm'], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Umodel data. If unspecified, data with any name is deleted.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'], + ], + [ + 'name' => 'kind', + 'in' => 'query', + 'schema' => ['description' => 'The kind of the Umodel data. If unspecified, data of all kinds is deleted.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'metric_set'], + ], + ], + 'responses' => [ + 200 => [ '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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-xxxx', - ], - 'indexId' => [ - 'description' => '', - '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' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - ], - 'required' => false, - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '111111-222-333-1111-33333'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Umodel Data', + 'summary' => 'Deletes Umodel elements.', + 'description' => 'Deletes Umodel data from a specified workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteUmodelData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], ], - 'required' => false, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"111111-222-333-1111-33333\\"\\n}","type":"json"}]', + ], + 'DeleteWorkspace' => [ + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', - ], - 'ListDigitalEmployees' => [ - 'summary' => '列出资源DigitalEmployee', - 'path' => '/digital-employee', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Workspace', + 'summary' => 'Deletes a workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'DescribeMetricMetaList' => [ + 'summary' => 'Queries metric metadata.', + 'path' => '/describe-metric-meta-list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'maxResults', + 'name' => 'namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The namespace, which is used to distinguish between services.', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'nextToken', + 'name' => 'metaFormat', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The metadata source. Valid values:'."\n" + .'- CMS: CloudMonitor Basic monitoring metrics.'."\n" + .'- PROM_BASIC: Prometheus CloudMonitor basic monitoring metrics.', 'type' => 'string', + 'enum' => ['CMS', 'PROM_BASIC'], 'required' => false, - 'example' => 'xxxxxx', + 'example' => 'CMS', 'title' => '', ], ], [ - 'name' => 'name', + 'name' => 'metricName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The metric name.', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization', 'title' => ''], ], [ - 'name' => 'employeeType', + 'name' => 'labels', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'system', - 'custom', + 'description' => 'Filters resources by label. The following labels are available:'."\n" + .'- metricCategory: the metric category description.'."\n" + .'- alertEnable: specifies whether alerting is required.'."\n" + .'- alertUnit: the recommended alert unit.'."\n" + .'- unitFactor: the unit conversion factor.'."\n" + .'- minAlertPeriod: the minimum alert period.'."\n" + .'- productCategory: the service type category.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label key.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The label name.', 'type' => 'string', 'required' => false, 'example' => 'productCategory', 'title' => ''], + 'value' => ['description' => 'The label value.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'displayName', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'tags', + 'name' => 'pageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - '$ref' => '#/components/schemas/Tag', - ], - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 2000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], ], [ - 'name' => 'resourceGroupId', + 'name' => 'keywords', 'in' => 'query', - 'schema' => [ - 'title' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', - ], + 'schema' => ['description' => 'The keyword.', 'type' => 'string', 'required' => false, 'example' => '实例理论', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'acs:ram::12345678912:role/testrole', - 'pattern' => '', - 'readOnly' => false, - 'default' => '', - ], - 'knowledges' => [ - 'description' => '', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '6370', 'title' => ''], + 'pageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''], + 'resources' => [ + 'description' => 'The metric configuration information of the resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric configuration information of the resources.', + 'type' => 'object', + 'properties' => [ + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'metricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'CPUUtilization', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'ECS CPU Utilization', 'title' => ''], + 'unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => '%', 'title' => ''], + 'labels' => [ + 'description' => 'The CloudMonitor labels. This parameter is returned only when metaFormat is set to CMS.', 'type' => 'object', - 'properties' => [ - 'bailian' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm-xxxx', - ], - 'indexId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'index-xxxx', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'attributes' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'sop' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - ], - ], - 'employeeType' => [ - 'type' => 'string', + 'additionalProperties' => ['description' => 'The CloudMonitor label content.', 'type' => 'string', 'example' => '{'."\n" + .' "DefaultTemplate": "false",'."\n" + .' "alertDefault": "80",'."\n" + .' "alertUnit": "%",'."\n" + .' "is_alarm": "true",'."\n" + .' "metricCategory": "instanceId",'."\n" + .' "minAlertPeriod": "60",'."\n" + .' "productCategory": "ecs",'."\n" + .' "unitFactor": "1"'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'resourceGroupId' => [ - 'title' => '资源组 ID', - 'type' => 'string', - 'example' => 'rg-ae******ey', + 'dimensions' => [ + 'description' => 'The resource filtering dimensions of CloudMonitor Basic.', + 'type' => 'array', + 'items' => ['description' => 'The resource filtering dimensions of CloudMonitor Basic.', 'type' => 'string', 'example' => '["userId","instanceId"]', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'tags' => [ - 'title' => '标签', + 'type' => ['description' => 'The metric type.', 'type' => 'string', 'example' => 'Gauge', 'title' => ''], + 'dimensionDescription' => [ + 'description' => 'The dimension description.', 'type' => 'array', 'items' => [ - 'title' => '标签', - '$ref' => '#/components/schemas/Tag', + 'description' => 'The dimension description.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'user_id', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'statistics' => ['description' => 'The statistical method of the metric. Example values:'."\n" + .'- Maximum: the maximum value.'."\n" + .'- Minimum: the minimum value.'."\n" + .'- Average: the average value.', 'type' => 'string', 'example' => 'Maximum', 'title' => ''], + 'periods' => ['description' => 'The period.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'metaFormat' => ['description' => 'The metadata source. CMS indicates CloudMonitor Basic monitoring metrics. PROM_BASIC indicates Prometheus CloudMonitor basic monitoring metrics.'."\n" + ."\n" + .'Sample value:'."\n" + .'CMS'."\n" + .'Valid values:'."\n" + .'CMS'."\n" + .'PROM_BASIC.', 'type' => 'string', 'example' => 'PROM_BASIC', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'DeleteDigitalEmployee' => [ - 'summary' => '删除DigitalEmployee', - 'path' => '/digital-employee/{name}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query cloudMonitor metric details', + 'description' => 'Queries the details of CloudMonitor monitoring metrics metadata.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricMetaList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"totalCount\\": 6370,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 2000,\\n \\"resources\\": [\\n {\\n \\"namespace\\": \\"acs_ecs_dashboard\\",\\n \\"metricName\\": \\"CPUUtilization\\",\\n \\"description\\": \\"ECS CPU Utilization\\",\\n \\"unit\\": \\"%\\",\\n \\"labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"DefaultTemplate\\\\\\": \\\\\\"false\\\\\\",\\\\n \\\\\\"alertDefault\\\\\\": \\\\\\"80\\\\\\",\\\\n \\\\\\"alertUnit\\\\\\": \\\\\\"%\\\\\\",\\\\n \\\\\\"is_alarm\\\\\\": \\\\\\"true\\\\\\",\\\\n \\\\\\"metricCategory\\\\\\": \\\\\\"instanceId\\\\\\",\\\\n \\\\\\"minAlertPeriod\\\\\\": \\\\\\"60\\\\\\",\\\\n \\\\\\"productCategory\\\\\\": \\\\\\"ecs\\\\\\",\\\\n \\\\\\"unitFactor\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\"\\n },\\n \\"dimensions\\": [\\n \\"[\\\\\\"userId\\\\\\",\\\\\\"instanceId\\\\\\"]\\"\\n ],\\n \\"type\\": \\"Gauge\\",\\n \\"dimensionDescription\\": [\\n {\\n \\"name\\": \\"user_id\\"\\n }\\n ],\\n \\"statistics\\": \\"Maximum\\",\\n \\"periods\\": \\"60\\",\\n \\"metaFormat\\": \\"PROM_BASIC\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeRegions' => [ + 'path' => '/regions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'name', - 'in' => 'path', + 'name' => 'language', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese. This is the default value.'."\n" + ."\n" + .'- en: English.'."\n" + ."\n" + .'- ja: Japanese.', + 'enumValueTitles' => ['ja' => 'ja', 'en' => 'en', 'zh' => 'zh'], 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'required' => false, + 'example' => 'zh', + 'title' => '', ], ], ], @@ -10486,1023 +9967,1076 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'regions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'localName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => 'China (Beijing)', 'title' => ''], + ], + 'description' => 'The region information.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of regions.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - ], - 'CreateThread' => [ - 'summary' => '创建会话', - 'path' => '/digitalEmployee/{name}/thread', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeRegions', + 'summary' => 'Retrieves a list of regions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + '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"}]', + ], + 'ExecuteQuery' => [ + 'path' => '/workspace/{workspace}/dataset/{datasetName}/query', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'datasetName', + 'in' => 'path', + 'schema' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'variables' => [ - 'description' => '', + 'type' => ['description' => 'The query type. Valid values: SQL and SPL.', 'type' => 'string', 'required' => true, 'example' => 'SQL', 'title' => ''], + 'query' => ['description' => 'The query statement to execute.', 'type' => 'string', 'required' => true, 'example' => 'SELECT count(1) from "datasetname"', 'title' => ''], + ], + 'description' => 'A container for the request parameters.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', 'title' => ''], + 'meta' => [ 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rum-monitor-test-aysls-pub-cn-heyuan-monitor', - ], - 'project' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'az_alipay', - ], + 'affectedRows' => ['description' => 'The number of scanned or processed log entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'elapsedMillisecond' => ['description' => 'The query execution time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231243', 'title' => ''], + 'progress' => ['description' => 'The query completion status. A value of `Complete` indicates that the query has finished.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], + 'count' => ['description' => 'The number of log entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], - 'required' => false, + 'description' => 'Metadata about the query execution.', + 'title' => '', + 'example' => '', + ], + 'data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The log entry, returned as a JSON-formatted string.', 'type' => 'string', 'example' => '{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}', 'title' => ''], + 'description' => 'An object that represents a single log entry.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'description' => 'An array of log entries. Each object in the array represents a log entry.', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ExecuteQuery', + 'summary' => 'Executes SQL and SPL queries.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"meta\\": {\\n \\"affectedRows\\": 1,\\n \\"elapsedMillisecond\\": 1231243,\\n \\"progress\\": \\"Complete\\",\\n \\"count\\": 1\\n },\\n \\"data\\": [\\n {\\n \\"key\\": \\"{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetAddon' => [ + 'summary' => 'Retrieves the details of an add-on.', + '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' => ['description' => 'This is a query parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'security-actiontrail'], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => ['description' => 'The version number of the add-on.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '*'], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Valid values: zh and en. Default value: zh.', 'type' => 'string', 'required' => false, 'title' => '', '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*****', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread_id01', + 'data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'alias' => ['description' => 'The alias of the component.', 'type' => 'string', 'example' => 'resume_vector_alias', 'title' => ''], + 'categories' => [ + 'description' => 'The list of component categories.', + 'type' => 'array', + 'items' => ['description' => 'The name of the category.', 'type' => 'string', 'example' => 'alibaba-cloud-service', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'dashboards' => [ + 'description' => 'The list of dashboards.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the dashboard.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the dashboard.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'name' => ['description' => 'The name of the dashboard.', 'type' => 'string', 'example' => 'rum_api_dot_metric_set', 'title' => ''], + 'url' => ['description' => 'The URL of the preview image.', 'type' => 'string', 'example' => 'http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The description of the add-on.', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan', 'title' => ''], + 'environments' => [ + 'description' => 'The environment information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a single environment.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Indicates whether the feature is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'label' => ['description' => 'The display name of the environment.', 'type' => 'string', 'example' => '容器环境', 'title' => ''], + 'dependencies' => [ + 'description' => 'The dependencies.', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => 'The dependencies on cluster types.', + 'type' => 'array', + 'items' => ['description' => 'The cluster type dependency.', 'type' => 'string', 'example' => 'ManagedKubernetes/Default', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'features' => [ + 'description' => 'The dependencies on probes.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Indicates whether the component depends on the target probe.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'services' => [ + 'description' => 'The dependencies on activated services.', + 'type' => 'array', + 'items' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'Prometheus', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Observability integration.', 'title' => ''], + 'name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85', 'title' => ''], + 'policies' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => ['description' => 'The status of the default policy for alert rules.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'defaultInstall' => ['description' => 'Indicates whether the add-on is installed by default.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'enableServiceAccount' => ['description' => 'Indicates whether a service account is assigned for communication with the console API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'metricCheckRule' => [ + 'description' => 'The metric check rule.', + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'description' => 'The data check rule that is used after installation.', + 'type' => 'array', + 'items' => ['description' => 'The data check rule that is used after installation.', 'type' => 'string', 'example' => 'up=1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'needRestartAfterIntegration' => ['description' => 'Indicates whether to guide the user to restart pods after the add-on is installed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'protocols' => [ + 'description' => 'The protocol.', + 'type' => 'array', + 'items' => [ + 'description' => 'The protocol.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the protocol.', 'type' => 'string', 'example' => 'Support OpenTelemetry Protocol', 'title' => ''], + 'icon' => ['description' => 'The URL of the icon.', 'type' => 'string', 'example' => 'icon URL', 'title' => ''], + 'label' => ['description' => 'The display name of the protocol.', 'type' => 'string', 'example' => 'OpenTelemetry', 'title' => ''], + 'name' => ['description' => 'The name of the protocol.', 'type' => 'string', 'example' => 'OpenTelemetry', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'targetAddonName' => ['description' => 'The name of the target add-on to which the system redirects.', 'type' => 'string', 'example' => 'cs-default', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'policyType' => ['description' => 'The type of the integration policy.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'commonSchemaRefs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'The group name of the common schema.', 'type' => 'string', 'example' => 'acs-ecs', 'title' => ''], + 'version' => ['description' => 'The version of the common schema.', 'type' => 'string', 'example' => '0.1.3', 'title' => ''], + ], + 'description' => 'The information about the associated common schema.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of associated common schemas.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'icon' => ['description' => 'The URL of the icon.', 'type' => 'string', 'example' => 'https://xxxxx', 'title' => ''], + 'keywords' => [ + 'description' => 'The keywords.', + 'type' => 'array', + 'items' => ['description' => 'A keyword.', 'type' => 'string', 'example' => 'metrics', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'language' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'latestReleaseCreateTime' => ['description' => 'The time when the latest version was created.', 'type' => 'string', 'example' => '2023-09-12 12:30:30', 'title' => ''], + 'name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'rum_api_dashboard_explorer_link_metric_set', 'title' => ''], + 'once' => ['description' => 'Indicates whether the add-on can be installed only once.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'scene' => ['description' => 'The scenario of the component.', 'type' => 'string', 'example' => 'middleware', 'title' => ''], + 'version' => ['description' => 'The version of the component.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'weight' => ['description' => 'The weight.', 'type' => 'string', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAddon', + 'description' => 'Retrieves the details of an add-on.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"threadId\\": \\"thread_id01\\"\\n}","type":"json"}]', + 'ramActions' => [], + '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"}]', ], - 'GetThread' => [ - 'summary' => '获取会话', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAddonCodeTemplate' => [ + 'path' => '/addons/{addonName}/alert-code-template', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'addonName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The name of the add-on.', 'example' => 'apm-opentelemetry'], ], [ - 'name' => 'threadId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'thread_id01', - ], + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The language. Valid values: zh (Chinese) and en (English). Default value: zh.', 'example' => 'zh'], + ], + [ + 'name' => 'environmentType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The type of environment. Valid values: CS (Container Service) and ECS.', 'example' => 'Client'], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The version of the component.', 'required' => false, 'title' => '', 'example' => '0.1.0'], ], ], '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' => '', - 'type' => 'string', - 'example' => 'thread-t71rrw-1s7r7z9gu0v2s', - ], - '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' => 'hd1', - ], - 'project' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'kubenest', + 'codes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'codeTemplate' => ['type' => 'string', 'description' => 'The code template.', 'title' => '', 'example' => 'javascript\\nnpm install @arms/rum-miniapp --save'], + 'name' => ['type' => 'string', 'description' => 'The name of the code template.', 'title' => '', 'example' => 'cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The list of code templates.', + 'title' => '', + 'example' => '', ], + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '0CEC5375-C554-562B-A65F-***'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAddonCodeTemplate', + 'summary' => 'Details of an add-on schema.', + 'description' => 'This topic provides an example of how to modify version `1` of alert template `123456`. In this example, the alert level is set to `Critical`, the statistical method is set to `Average`, the comparison operator for the alert threshold is set to `GreaterThanOrEqualToThreshold`, the alert threshold is set to `90`, and the number of retries is set to `3`. The response indicates that the alert template was successfully modified.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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"}]', + 'ramActions' => [], + '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"}]', ], - 'GetThreadData' => [ - 'summary' => '获取会话数据', - 'path' => '/digitalEmployee/{name}/thread/{threadId}/data', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAddonRelease' => [ + 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'releaseName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => 'AddonRelease 的名称。', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => true, 'example' => 'test-gpu-integration-name'], ], [ - 'name' => 'threadId', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '环境 ID。', 'description' => 'The ID of the environment.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'title' => '最大结果数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'data' => [ - 'title' => '消息数据', - 'type' => 'array', - 'items' => [ - 'title' => '消息数据', - 'type' => 'object', - 'properties' => [ - 'traceId' => [ - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个追踪ID', - 'type' => 'string', - ], - 'requestId' => [ - 'title' => '当前message请求的id数据'."\n" - .'根数据中第一个RequestID', - 'type' => 'string', - ], - 'messages' => [ - 'title' => '会话的消息列表', - 'type' => 'array', - 'items' => [ - 'title' => '消息数据明细结构', - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'title' => '消息数据的版本号', - 'type' => 'string', - ], - 'parentCallId' => [ - 'title' => '上一层级执行ID', - 'type' => 'string', - ], - 'callId' => [ - 'title' => '当前执行ID', - 'type' => 'string', - ], - 'role' => [ - 'title' => '消息发起角色', - 'type' => 'string', - ], - 'seq' => [ - 'title' => '消息序列号', - 'type' => 'integer', - 'format' => 'int32', - ], - 'timestamp' => [ - 'title' => 'timestamp / 纳秒', - 'type' => 'string', - ], - 'type' => [ - 'title' => '消息具体类型', - 'type' => 'string', - ], - 'detail' => [ - 'title' => '消息明细', - 'type' => 'string', - ], - 'contents' => [ - 'title' => '内容信息', - 'type' => 'array', - 'items' => [ - 'title' => '内容信息明细结构', - 'type' => 'object', - ], - ], - 'tools' => [ - 'title' => '工具使用列表', - 'type' => 'array', - 'items' => [ - 'title' => '工具明细结构', - 'type' => 'object', - ], - ], - 'agents' => [ - 'title' => '调用的Agent列表', - 'type' => 'array', - 'items' => [ - 'title' => '调用的Agent详细内容', - 'type' => 'object', - ], - ], - 'events' => [ - 'title' => '事件列表', - 'type' => 'array', - 'items' => [ - 'title' => '事件详细内容', - 'type' => 'object', - ], - ], - 'artifacts' => [ - 'title' => '产物产出信息', - 'type' => 'array', - 'items' => [ - 'title' => '产物明细的结构', - 'type' => 'object', - ], - ], - ], + 'config' => ['title' => '组件配置。', 'description' => 'The configuration of the component.', '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' => 'The details of the release.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => '组件 Addon 名称。', 'description' => 'The name of the add-on component.', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警规则数量。', 'description' => 'The number of alert rules.', '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' => 'Information about the installation phases.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => 'The time when the phase first transitioned.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => 'The time when the phase last transitioned.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => 'The detailed message.', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => 'The status of the phase.', 'type' => 'string', 'example' => 'True'], + 'type' => ['title' => '阶段类型。', 'description' => 'The type of the phase.', 'type' => 'string', 'example' => 'Loaded'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], + 'example' => '', + ], + 'config' => ['title' => '组件配置信息。', 'description' => 'The configuration information of the component.', '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' => 'The time when the add-on was accessed.', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => 'The number of dashboards.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => 'The ID of the environment.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => 'The number of plug-ins.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => 'Indicates whether a configuration exists.', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '接入用户 ID。', 'description' => 'The ID of the user who accessed the add-on.', 'type' => 'string', 'example' => '1707xxxxxxxxxxxx'], + 'language' => ['title' => '语言。', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => 'Indicates whether the component is a managed component.', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => 'The ID of the parent add-on release.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxx'], + 'policyId' => ['title' => '策略 ID。', 'description' => 'The ID of the policy.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxx'], + 'regionId' => ['title' => '区域 ID。', 'description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => 'Release ID。', 'description' => 'The ID of the release.', 'type' => 'string', 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 的名称。', 'description' => 'The name of the release.', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => 'The scenario of the component.', 'type' => 'string', 'example' => 'container'], + 'status' => ['title' => '组件状态。', 'description' => 'The status of the component.', 'type' => 'string', 'example' => 'running'], + 'updateTime' => ['title' => '更新时间。', 'description' => 'The time when the release was last updated.', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'userId' => ['title' => '所属用户 ID。', 'description' => 'The ID of the user to which the release belongs.', 'type' => 'string', 'example' => '1707xxxxxxxxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => 'The version of the component.', 'type' => 'string', 'example' => '0.0.2'], + 'envType' => ['title' => '环境类型。', 'description' => 'The type of the environment.', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'default'], + 'entityRules' => ['title' => '实体详情。', 'description' => 'The details of the entity.', '$ref' => '#/components/schemas/EntityGroupBase', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxxx', - 'title' => '分页参数，下一页信息', - ], - 'requestId' => [ - 'title' => '当前请求ID', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'threadId' => [ - 'title' => '当前会话ID', - 'description' => '', - 'type' => 'string', - 'example' => 'aliding_thread_448d05c048a3481f8c19bc1a6038f8f6', - ], - 'digitalEmployeeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - 'title' => '当前数字员工信息', - ], + 'requestId' => ['title' => '请求 ID。', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - ], - 'ListThreads' => [ - 'summary' => '列出会话', - 'path' => '/digitalEmployee/{name}/threads', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'View Add-on Component Information', + 'summary' => 'Queries the details and accessed state of an add-on release.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddonRelease'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/{#ReleaseName}'], + ], ], ], + ], + '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\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"acs.ecs.instance\\",\\n \\"spl\\": \\".entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')\\"\\n }\\n ],\\n \\"description\\": \\"ECS 实例\\",\\n \\"entityGroupId\\": \\"eg-1234567890\\",\\n \\"entityRules\\": {\\n \\"resourceGroupId\\": \\"rg-acfm2m7atreujs1\\",\\n \\"ipMatchRule\\": {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n },\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"project\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ],\\n \\"entityTypes\\": [\\n \\"acs.ecs.instance\\"\\n ],\\n \\"regionIds\\": [\\n \\"cn-shanghai\\"\\n ],\\n \\"labels\\": [\\n {\\n \\"tagKey\\": \\"project\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"tagKey\\": \\"instanceId\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\\\n\\"\\n ]\\n }\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"instanceId\\",\\n \\"op\\": \\"in\\",\\n \\"fieldValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"ECS 全部实体\\",\\n \\"userId\\": \\"1654218***343050\\"\\n }\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + ], + 'GetAddonSchema' => [ + 'summary' => 'The details of an add-on schema.', + 'path' => '/addons/{addonName}/schema', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'threadId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'thread_id01', - ], + 'name' => 'addonName', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The name of the add-on.', 'type' => 'string', 'required' => true, 'example' => 'cloud-rds-audit-log'], ], [ - 'name' => 'maxResults', + 'name' => 'aliyunLang', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The language of the response. Valid values: \\`zh\\` and \\`en\\`. The default value is \\`zh\\`.', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'nextToken', + 'name' => 'environmentType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The environment type. Valid values: \\`CS\\` (container) and \\`ECS\\`.', 'type' => 'string', 'required' => false, 'example' => 'CS'], ], [ - 'name' => 'filter', + 'name' => 'version', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dukang-oxs-pre-obeqi', - ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[{\'Type\': \'primaryDoc\', \'Id\': \'01ZM8y7\', \'Name\': \'key\'}, {\'Type\': \'text\', \'Id\': \'mHe1U1b\', \'Name\': \'value\'}, {\'Type\': \'text\', \'Id\': \'rRIhpBs\', \'Name\': u\'\\u4f5c\\u7528\'}]', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The version of the component.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '0.1.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' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread_id01', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'maxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'threads' => [ - 'description' => '', + 'fields' => [ + 'description' => 'A list of data table fields.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The information about a data table field.', 'type' => 'object', 'properties' => [ - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread-t71rrw-1s7r7z9gu0v2s', - ], - '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' => '*', + 'conditions' => [ + 'description' => 'A list of display conditions.', + 'type' => 'array', + 'items' => [ + 'description' => 'A display condition.', + 'type' => 'object', + 'properties' => [ + 'action' => ['description' => 'The control mode of the field.', 'type' => 'string', 'title' => '', 'example' => 'show'], + 'field' => ['description' => 'The name of the field.', 'type' => 'string', 'title' => '', 'example' => 'store.storageTarget'], + 'op' => ['description' => 'The operator for the condition.', 'type' => 'string', 'title' => '', 'example' => '=='], + 'value' => ['description' => 'The target value for the condition.', 'type' => 'any', 'title' => '', 'example' => 'Custom'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'variables' => [ - 'description' => '', + 'defaultValue' => ['description' => 'The default value.', 'type' => 'any', 'title' => '', 'example' => 'mysql.default'], + 'description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => 'MySQL datasource'], + 'disabled' => ['description' => 'Specifies whether the field is hidden. Valid values: \\`true\\` (hidden) and \\`false\\` (displayed).', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'element' => ['description' => 'The type of the element.', 'type' => 'string', 'title' => '', 'example' => 'input'], + 'fieldPath' => ['type' => 'string', 'description' => 'The path of the field.', 'title' => '', 'example' => 'mysql.host'], + 'label' => ['description' => 'The display name of the field.', 'type' => 'string', 'title' => '', 'example' => 'mysql'], + 'name' => ['description' => 'The name of the field.', 'type' => 'string', 'title' => '', 'example' => 'host'], + 'placeholder' => ['description' => 'The placeholder text.', 'type' => 'string', 'title' => '', 'example' => 'Please enter the metrics collection interval'], + 'props' => [ + 'description' => 'Other properties of the component.', 'type' => 'object', 'properties' => [ - 'workspace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hd1-np', + 'dataSource' => [ + 'description' => 'The information about the data source.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the data source.', + 'type' => 'object', + 'properties' => [ + 'label' => ['description' => 'The label.', 'type' => 'string', 'title' => '', 'example' => 'tagKey'], + 'value' => ['description' => 'The value of the label.', 'type' => 'string', 'title' => '', 'example' => 'tagValue'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'project' => [ - 'description' => 'SLS project。', - 'type' => 'string', - 'example' => 'ciec_rl_ads', + 'related' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'Related data.', 'title' => '', 'example' => 'mysql.host'], + 'description' => 'A collection of related data.', + 'title' => '', + 'example' => '', ], + 'selectMode' => ['type' => 'string', 'description' => 'The mode.', 'title' => '', 'example' => 'single'], ], + 'title' => '', + 'example' => '', ], - 'createTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-04-22T12:46:34Z', - ], - 'updateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-24 10:05:21', + 'type' => ['description' => 'The type of the field.', 'type' => 'string', 'title' => '', 'example' => 'string'], + 'validation' => [ + 'type' => 'object', + 'properties' => [ + 'max' => ['description' => 'The maximum value. The value is inclusive.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2000'], + 'maxLength' => ['description' => 'The maximum length that is supported by the text control.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'message' => ['description' => 'The details.', 'type' => 'string', 'title' => '', 'example' => 'length limit'], + 'min' => ['description' => 'The minimum value.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'minLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '16'], + 'regular' => ['type' => 'string', 'description' => 'The regular expression.', 'title' => '', 'example' => '^(http|https)://'], + 'required' => ['description' => 'Specifies whether the parameter is required.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], + 'description' => 'The validation rule for the field.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxxxx', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********'], + 'type' => ['description' => 'The type of the schema.', 'type' => 'string', 'title' => '', 'example' => 'common'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAddonSchema', + 'description' => 'Retrieves the schema of an add-on.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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"}]', + 'ramActions' => [], + '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"}]', ], - 'UpdateThread' => [ - 'summary' => '更新会话', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'GetAggTaskGroup' => [ + 'summary' => 'Queries an aggregation task group.', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs.', 'type' => 'string', 'required' => true, 'example' => 'rw-xxx'], ], [ - 'name' => 'threadId', + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'thread-t71rrw-1s7r7z9gu0v2s', - ], + 'schema' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '出参结构体', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'title' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MY ANTOM Tech Team Annual Dinner Performance Lucky Draw', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'active', - 'enum' => [ - 'active', - 'archived', + 'aggTaskGroup' => [ + 'title' => '聚合任务组', + 'description' => 'The aggregation task group.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfig' => ['title' => '聚合任务组配置', 'description' => 'The configuration of the aggregation task group.', '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' => 'The summary of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136xxx'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'example' => 'aggTaskGroup-xx'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'cronExpr' => ['title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', 'description' => 'The scheduling expression of the aggregation task group when the scheduling mode is set to Cron.', 'type' => 'string', 'example' => '0 1 3 * * ? *'], + 'delay' => ['title' => '调度的固定延迟时间', 'description' => 'The fixed delay time for scheduling, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'description' => ['title' => '聚合任务组描述'."\n" + ."\n", 'description' => 'The description of the aggregation task group.', 'type' => 'string', 'example' => 'test'], + 'fromTime' => ['title' => '调度开始时间对应的的秒级时间戳', 'description' => 'The UNIX timestamp in seconds that corresponds to the start time of the scheduling. This parameter is not yet in effect.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409495'], + 'maxRetries' => ['title' => '执行聚合任务的最大重试次数', 'description' => 'The maximum number of retries to execute the aggregation task.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'maxRunTimeInSeconds' => ['title' => '执行聚合任务的最大重试时间', 'description' => 'The maximum runtime of the aggregation task, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'precheckString' => ['title' => '预检测配置', 'description' => 'The dry run configuration.', 'type' => 'string', 'example' => '{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}'], + 'regionId' => ['title' => '地域 id', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-zhangjiakou'], + 'scheduleMode' => ['title' => '调度模式', 'description' => 'The scheduling mode.', 'type' => 'string', 'example' => 'FixedRate'], + 'scheduleTimeExpr' => ['title' => '调度时间表达式', 'description' => 'The scheduling time expression.', 'type' => 'string', 'example' => '@m'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => 'The ID of the source Prometheus instance for the aggregation task group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '聚合任务组状态', 'description' => 'The status of the aggregation task group.', 'type' => 'string', 'example' => 'Running'], + 'tags' => [ + 'title' => '资源组标签', + 'description' => 'The tags of the resource group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '资源组标签的键', 'description' => 'The key of the resource group tag.', 'type' => 'string', 'example' => 'key1'], + 'value' => ['title' => '资源组标签的值', 'description' => 'The value of the resource group tag.', 'type' => 'string', 'example' => 'value1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'targetPrometheusId' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => 'The ID of the target Prometheus instance for the aggregation task group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'toTime' => ['title' => '调度结束时间对应的秒级时间戳', 'description' => 'The UNIX timestamp in seconds that corresponds to the end time of the scheduling.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409495'], + 'updateTime' => ['title' => '聚合任务组的更新时间', 'description' => 'The time when the aggregation task group was updated. This is a timestamp.', 'type' => 'string', 'example' => '1757409499000'], + 'userId' => ['title' => '聚合任务组所属用户', 'description' => 'The user to which the aggregation task group belongs.', 'type' => 'string', 'example' => '123xxx'], ], + 'example' => '', ], + 'requestId' => ['title' => '请求 id', 'description' => 'The request ID.', 'type' => 'string', 'example' => '68DAF543-35DF-5762-BE90-F5C00B5DC036'], + 'success' => ['title' => '请求是否成功', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], ], - 'required' => false, + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'threadId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'thread_id01', - ], - 'version' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0.1.0', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Aggregation Task Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAggTaskGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetAggTaskGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"threadId\\": \\"thread-12313\\",\\n \\"version\\": 123123\\n}","type":"json"}]', + '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"}]', ], - 'DeleteThread' => [ - 'summary' => '删除会话', - 'path' => '/digitalEmployee/{name}/thread/{threadId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'GetBizTrace' => [ + 'summary' => 'Queries a business trace.', + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'threadId', + 'name' => 'bizTraceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'thread_id01', - ], + 'schema' => ['type' => 'string', 'description' => 'The ID of the business trace.', 'required' => false, 'title' => '', 'example' => 'e339260ed64c95d'], ], ], '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', - ], + 'requestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'item' => ['$ref' => '#/components/schemas/BizTraceConfig', 'description' => 'The business trace.', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetBizTrace', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\"\\n}","type":"json"}]', + 'ramActions' => [], + '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"}]', ], - 'UpdateIntegrationPolicy' => [ - 'summary' => 'Update the specified policy', - 'path' => '/integration-policies/{integrationPolicyId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'GetCloudResource' => [ + 'summary' => 'Retrieves information about cloud resources.', + 'path' => '/cloudresource', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcms5OJOSH'], + 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Request body parameters', 'type' => 'object', 'properties' => [ - 'feePackage' => [ - 'description' => 'Fee package type, CS_Pro/CS_Basic/empty.', - 'type' => 'string', - 'required' => false, - 'example' => 'CS_Pro', - ], - 'policyName' => [ - 'description' => 'Rule name, minimum 3 characters, maximum 63 characters, must start with a letter.', - 'type' => 'string', - 'required' => false, - 'example' => 'metrics-inner-manage', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID of the instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzoiafjtr7zyq', - ], - 'tags' => [ - 'description' => 'Resource tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag `key` value.', - 'type' => 'string', - 'required' => false, - 'example' => 'algo_bhv_expose_in_airec_exposure', - ], - 'value' => [ - 'description' => 'Tag `value` value.', - 'type' => 'string', - 'required' => false, - 'example' => '[{\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}]', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetCloudResource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'integrationPolicyId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Access center policy ID', - 'type' => 'string', - 'required' => true, - 'example' => 'polixy-xxxxxxxxx', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetCloudResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'CloudResource', 'arn' => 'acs:cms:{#regionId}:{#accountId}:cloudresource'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + ], + 'GetCloudResourceData' => [ + 'summary' => 'Queries all entity information of a specific cloud service within a specified time range.', + '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' => 'The start of the query time range.'."\n" + ."\n" + .'The value is a UNIX timestamp in seconds, which represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1721767203', 'title' => ''], + ], + [ + 'name' => 'to', + 'in' => 'query', + 'schema' => ['description' => 'The end of the query time range.'."\n" + ."\n" + .'The value is a UNIX timestamp in seconds, which represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1721767203', 'title' => ''], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => ['description' => 'The query statement.', 'type' => 'string', 'required' => true, 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response schema', + 'title' => '', + 'description' => 'The response body that contains the request status, data, and other information.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + 'data' => [ + 'description' => 'The total list of returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data list corresponding to the header.', + 'type' => 'array', + 'items' => ['description' => 'The data corresponding to the request header.', 'type' => 'string', 'example' => 'data1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'header' => [ + 'description' => 'The list of headers.', + 'type' => 'array', + 'items' => ['description' => 'The header.', 'type' => 'string', 'example' => 'headerKey', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'responseStatus' => [ + 'description' => 'The result status.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The execution result.', 'type' => 'string', 'example' => 'Success,PartialSuccess,Error', 'title' => ''], + 'retryPolicy' => ['description' => 'The retry policy.', 'type' => 'string', 'example' => 'None,Once,Continuous', 'title' => ''], + 'level' => ['description' => 'The status level.', 'type' => 'string', 'example' => 'Info,Warn,Error', 'title' => ''], + 'statusItem' => [ + 'description' => 'The detailed status information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed status information.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success,ExecuteTimeout,UModelNotExist', 'title' => ''], + 'level' => ['description' => 'The status level.', 'type' => 'string', 'example' => 'Info,Warn,Error', 'title' => ''], + 'message' => ['description' => 'The message content.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'suggestion' => ['description' => 'The suggestion when an execution error occurs.', 'type' => 'string', 'example' => 'Try to reduce the query scope or increase timeout limit, then retry', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'executionStates' => ['description' => 'The information during execution.', 'type' => 'string', 'example' => '{}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve cloud service entity data', + 'description' => '## Operation description'."\n" + .'- This operation queries all entities of a specific cloud service within a specified time range.'."\n" + .'- The `from` and `to` parameters specify the time range of the query in seconds-level timestamps.'."\n" + .'- The `spl` parameter supports entityStore query statements to filter or select the required entities and their properties.'."\n" + .'- If you need only specific fields, use the `project` clause in `spl` to filter them.'."\n" + .'- The response contains the specific property values of each entity and the corresponding list of property names for easy parsing and processing.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => 'Update Access Center Policy', - 'translator' => 'machine', + 'ramActions' => [], + '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\\": \\"successful\\",\\n \\"suggestion\\": \\"Try to reduce the query scope or increase timeout limit, then retry\\"\\n }\\n ],\\n \\"executionStates\\": \\"{}\\"\\n }\\n}","type":"json"}]', ], - 'DeleteIntegrationPolicy' => [ - 'summary' => 'Delete Access Center Policy', - 'path' => '/integration-policies/{policyId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'GetCmsService' => [ + 'summary' => 'Checks whether a Prometheus service or product is activated.', + 'path' => '/cmsservice', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'force', + 'name' => 'product', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Whether to forcibly delete the cloud-native all-in-one machine,'."\n" - .'default value: `false`.', - 'type' => 'boolean', + 'type' => 'string', + 'enum' => ['prometheus'], + 'title' => '', + 'description' => 'prometheus: Checks the activation status of the Prometheus service. The service is billed by reported data volume or written data volume.', 'required' => false, - 'example' => 'false', + 'enumValueTitles' => ['prometheus' => 'prometheus'], + 'example' => 'prometheus', ], ], [ - 'name' => 'policyId', - 'in' => 'path', + 'name' => 'service', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Policy environment ID.', 'type' => 'string', - 'required' => true, - 'example' => 'policy-273c360bed1948818c5fb861886bc405', + 'enum' => ['prometheus', 'prometheusgb', 'promethues', 'ackpro'], + 'title' => '', + 'description' => 'prometheus: Checks whether the Prometheus product that is billed by reported data volume is activated.prometheusgb: Checks whether the Prometheus product that is billed by written data volume is activated.', + 'required' => false, + 'enumValueTitles' => ['prometheusgb' => 'prometheusgb', 'promethues' => 'prometheus'], + 'example' => 'prometheus', ], ], ], @@ -11511,160 +11045,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'enabled' => ['type' => 'boolean', 'description' => 'Indicates whether the service or product is activated.', 'title' => '', 'example' => 'false'], + 'errorCode' => ['type' => 'string', 'title' => '', 'description' => 'PROM\\_NOT\\_OPEN: Prometheus is not activated.SLS\\_NOT\\_OPEN: Simple Log Service (SLS), a dependency of Prometheus, is not activated.CMS\\_SLR\\_NOT\\_EXIST: The service-linked role (SLR) for CloudMonitor does not exist.SLS\\_SLR\\_NOT\\_EXIST: The SLR for SLS does not exist.', 'example' => 'PROM_NOT_OPEN'], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', - 'title' => 'Delete Access Center Policy', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetCmsService', + 'description' => 'The product and service request parameters cannot be specified in the same request.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"enabled\\": false,\\n \\"errorCode\\": \\"PROM_NOT_OPEN\\"\\n}","type":"json"}]', 'translator' => 'machine', ], - 'CreateIntegrationPolicy' => [ - 'summary' => 'Create Access Center Policy', - 'path' => '/integration-policies', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetContext' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context/{contextId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the context.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], + ], + [ + 'name' => 'formatted', + 'in' => 'query', + 'schema' => ['description' => 'Whether to return the context in a formatted structure. Valid values: `true` and `false`. Default value: `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The details of the context.', 'type' => 'object', 'example' => '{}', 'title' => ''], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetContext', + 'summary' => 'Retrieves a single context.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'parameters' => [ + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'GetContextStore' => [ + 'summary' => 'Retrieves the details of a specified context store.', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request body.', - 'type' => 'object', - 'properties' => [ - 'entityGroup' => [ - 'description' => 'Entity group for creating the policy. Policies can be quickly created using the entity group, and `clusterId` and `vpcId` are independent of each other.', - 'type' => 'object', - 'properties' => [ - 'clusterEntityType' => [ - 'description' => 'Cluster entity type, such as acs.ack.cluster/acs.one.cluster/acs.asi.cluster or others.', - 'type' => 'string', - 'required' => false, - 'example' => 'acs.ack.cluster', - ], - 'clusterId' => [ - 'description' => 'Cluster ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'na61prod3-na61cloudhdfsssd', - ], - 'entityUserId' => [ - 'description' => 'User ID to which the cluster belongs.', - 'type' => 'string', - 'required' => false, - 'example' => '12xxxx', - ], - 'entityGroupId' => [ - 'description' => 'Entity group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'vpcId' => [ - 'description' => 'VPC ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp18fgg3ffxa9czna40xt', - ], - 'disablePolicyShare' => [ - 'description' => 'Whether to disable the unique binding of the Policy. If enabled, multiple Policies can be created for a single container cluster.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'ture', - ], - 'clusterNamespace' => [ - 'title' => '', - 'type' => 'string', - ], - ], - 'required' => false, - ], - 'policyName' => [ - 'title' => '策略名称', - 'description' => 'Policy name', - 'type' => 'string', - 'required' => false, - 'example' => 'prod-database', - ], - 'policyType' => [ - 'title' => '策略类型：CS/ECS/Cloud', - 'description' => 'Policy type: CS/ECS/Cloud', - 'type' => 'string', - 'required' => true, - 'example' => 'CS', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekz2km4kmhtbii', - ], - 'tags' => [ - 'description' => 'Resource tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag `key` value.', - 'type' => 'string', - 'required' => false, - 'example' => 'use', - ], - 'value' => [ - 'description' => 'Tag `value` value.', - 'type' => 'string', - 'required' => false, - 'example' => 'database', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'workspace' => [ - 'title' => '工作空间，不填则创建或使用默认工作空间。', - 'description' => 'Workspace.', - 'type' => 'string', - 'required' => false, - 'example' => 'prometheus', - ], - ], - 'required' => false, - ], + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], ], ], 'responses' => [ @@ -11672,1251 +11152,876 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'policy' => [ - 'description' => 'Uploaded policy.', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'contextStoreName' => ['description' => 'The context store name.', 'type' => 'string', 'example' => 'test-context-store', 'title' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'contextType' => ['description' => 'The type of the context store.', 'type' => 'string', 'example' => 'memory', 'title' => ''], + 'description' => ['description' => 'The description of the context store.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'status' => ['description' => 'The status of the context store.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'config' => [ 'type' => 'object', 'properties' => [ - 'entityGroupId' => [ - 'description' => 'Entity group ID.', - 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'policyId' => [ - 'title' => '策略id', - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-14c8e9a29b0a46da843f8781471062ff', - ], - 'policyName' => [ - 'title' => '策略名称', - 'description' => 'Policy name.', - 'type' => 'string', - 'example' => 'metrics-inner-manage', - ], - 'policyType' => [ - 'title' => '策略类型', - 'description' => 'Policy type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'regionId' => [ - 'title' => 'region', - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', + 'innerSource' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'example' => 'sls-test-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Log Service logstore.', 'type' => 'string', 'example' => 'sls-test-logstore', 'title' => ''], + ], + 'description' => 'The internal source.', + 'title' => '', + 'example' => '', ], - 'userId' => [ - 'title' => '用户id', - 'description' => 'User ID.', - 'type' => 'string', - 'example' => 'u1234567', + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'example' => 'sls-test-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Log Service logstore.', 'type' => 'string', 'example' => 'sls-test-logstore', 'title' => ''], + 'startTime' => ['description' => 'The time when the configuration takes effect. This value is a Unix timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1754962200000', 'title' => ''], + ], + 'description' => 'The configuration source.', + 'title' => '', + 'example' => '', ], - 'workspace' => [ - 'title' => 'Policy所在的工作空间。', - 'description' => 'The workspace where the Policy resides.', - 'type' => 'string', - 'example' => 'prometheus', + 'metadataField' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The key-value pairs that map metadata fields to their source attributes.', 'type' => 'string', 'example' => '{'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }', 'title' => ''], + 'description' => 'The metadata fields.', + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ + 'description' => 'The configuration of the context store.', 'title' => '', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', + 'example' => '', ], - 'created' => [ - 'description' => 'Whether it is created.', - 'type' => 'boolean', - 'example' => 'true', + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'test_dataset', 'title' => ''], + ], + 'description' => 'Information about the associated dataset.', + 'title' => '', + 'example' => '', ], + 'createTime' => ['description' => 'The creation time of the context store. This value is a Unix timestamp in seconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'updateTime' => ['description' => 'The last update time of the context store. This value is a Unix timestamp in seconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetContextStore', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Create Access Center Policy', - 'description' => 'This interface is used to support users in creating event integration.', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"contextStoreName\\": \\"test-context-store\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"contextType\\": \\"memory\\",\\n \\"description\\": \\"test\\",\\n \\"status\\": \\"active\\",\\n \\"config\\": {\\n \\"innerSource\\": {\\n \\"project\\": \\"sls-test-project\\",\\n \\"logstore\\": \\"sls-test-logstore\\"\\n },\\n \\"source\\": {\\n \\"project\\": \\"sls-test-project\\",\\n \\"logstore\\": \\"sls-test-logstore\\",\\n \\"startTime\\": \\"1754962200000\\"\\n },\\n \\"metadataField\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"project\\\\\\": \\\\\\"attributes.project\\\\\\",\\\\n \\\\\\"logstore\\\\\\": \\\\\\"attributes.logstore\\\\\\",\\\\n \\\\\\"agentId\\\\\\": \\\\\\"attributes.agent_id\\\\\\",\\\\n \\\\\\"scene\\\\\\": \\\\\\"attributes.scene\\\\\\"\\\\n }\\"\\n }\\n },\\n \\"dataset\\": {\\n \\"name\\": \\"test_dataset\\"\\n },\\n \\"createTime\\": \\"1695090077\\",\\n \\"updateTime\\": \\"1695090077\\"\\n}","type":"json"}]', ], - 'UpdateAddonRelease' => [ - 'summary' => 'Upgrade Access Component', - 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'GetDataset' => [ + 'path' => '/workspace/{workspace}/dataset/{datasetName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'releaseName', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => 'Release 的名称。', - 'description' => 'The name of the Release.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-gpu-integration-name', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request body.', - 'type' => 'object', - 'properties' => [ - 'addonVersion' => [ - 'title' => 'Addon 的版本信息。', - 'description' => 'Addon version information.', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.2', - ], - 'dryRun' => [ - 'title' => '是否预检本次请求。', - 'description' => 'Whether to pre-check this request.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '是', - 'false' => '否', - ], - 'example' => 'true', - ], - 'values' => [ - 'title' => '元数据信息。', - 'description' => 'Metadata information.', - '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' => 'Entity discovery rules.', - 'required' => false, - '$ref' => '#/components/schemas/EntityDiscoverRule', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'policyId', + 'name' => 'datasetName', 'in' => 'path', - 'schema' => [ - 'title' => '策略环境 ID。', - 'description' => 'Policy environment ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', - ], + 'schema' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '9F00A7AF-2728-5424-B321-79D39C00A1EC', + 'description' => ['description' => 'The description of the dataset.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'createTime' => ['description' => 'The time the dataset was created, as a Unix timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'requestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'updateTime' => ['description' => 'The time the dataset was last updated, as a Unix timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'datasetName' => ['description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'test_dataset', 'title' => ''], + 'regionId' => ['description' => 'The ID of the region where the dataset is located.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The structure of a field within the schema.', '$ref' => '#/components/schemas/IndexKey', 'title' => '', 'example' => ''], + 'description' => 'The data schema of the dataset.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDataset', + 'summary' => 'Retrieves the details of a specified dataset.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F00A7AF-2728-5424-B321-79D39C00A1EC\\"\\n}","type":"json"}]', - 'title' => 'Update Access Component Configuration', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"description\\": \\"test\\",\\n \\"createTime\\": \\"1695090077\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"updateTime\\": \\"1695090077\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"datasetName\\": \\"test_dataset\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"schema\\": {\\n \\"key\\": {\\n \\"chn\\": false,\\n \\"type\\": \\"\\",\\n \\"embedding\\": \\"\\",\\n \\"jsonKeys\\": {\\n \\"key\\": {\\n \\"type\\": \\"\\",\\n \\"chn\\": false\\n }\\n }\\n }\\n }\\n}","type":"json"}]', ], - 'ListIntegrationPolicyStorageRequirements' => [ - 'summary' => 'Get Storage Requirements Information for Access Center Policy', - 'path' => '/integration-policies/{policyId}/storage-requirements', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetDeliveryTask' => [ + 'summary' => 'Retrieves the details of a data delivery task.', + 'path' => '/delivery-task/{taskId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID', - 'description' => 'Access Center Policy ID', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - ], - [ - 'name' => 'addonName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon名称，如mysql。', - 'description' => 'Addon Release Name', - 'type' => 'string', - 'required' => false, - 'example' => 'release-1234357', - ], - ], - [ - 'name' => 'storageType', - 'in' => 'query', - 'schema' => [ - 'title' => '存储类型', - 'description' => 'Storage Type, LogStore/Prometheus/TraceStore/EventStore/EntityStore.', - 'type' => 'string', - 'required' => false, - 'example' => 'LogStore', - ], - ], - [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'AddonRelease的名称。', - 'description' => 'Name of AddonRelease.', - 'type' => 'string', - 'required' => false, - 'example' => 'kafka-17201012937917', - ], + 'schema' => ['description' => 'The delivery task ID.', 'type' => 'string', 'required' => true, 'example' => '98e367d8fb8cc83b', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], - 'storageRequirements' => [ - 'description' => 'List of storage requirements', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'apiVersion' => [ - 'description' => 'API Version', - 'type' => 'string', - 'example' => 'v1', - ], - 'kind' => [ - 'description' => 'Resource kind', - 'type' => 'string', - 'example' => 'Pod', - ], - 'metadata' => [ - 'description' => 'Metadata', - 'type' => 'object', - 'properties' => [ - 'annotations' => [ - 'description' => 'Annotations', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Annotations', - 'example' => 'prometheus.io/path', - ], - ], - 'labels' => [ - 'description' => 'Resource labels', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Resource labels', - 'example' => 'key=value', - ], - ], - 'name' => [ - 'description' => 'Resource name', - 'type' => 'string', - 'example' => 'pod-1234567', - ], - 'namespace' => [ - 'description' => 'Namespace', - 'type' => 'string', - 'example' => 'arms-prom', - ], + 'deliveryTask' => [ + 'description' => 'The delivery task details.', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['description' => 'The delivery task ID.', 'type' => 'string', 'example' => '8b07eeac8249866d', 'title' => ''], + 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'test-task', 'title' => ''], + 'taskDescription' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'my delivery task', 'title' => ''], + 'status' => ['description' => 'The current status of the task.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], + 'dataSourceId' => ['description' => 'The data source ID (Managed Service for Prometheus instance ID).', 'type' => 'string', 'example' => 'rw-xxxxxx', 'title' => ''], + 'labelFiltersType' => [ + 'description' => 'The metric filtering mode.', + 'enumValueTitles' => ['Deny' => 'Deny', 'Allow' => 'Allow'], + 'type' => 'string', + 'example' => 'Allow', + 'title' => '', + ], + 'labelFilters' => [ + 'description' => 'The metric filter conditions. Used together with labelFiltersType. The key is the metric label name, and the value is the match value.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'filterKey → filterValue. Example: __name__ → up, job → my_job.', 'type' => 'string', 'example' => '__name__: up', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'externalLabels' => [ + 'description' => 'The additional labels attached to all delivered metrics. The key is the label name, and the value is the label value.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'externalLabelsKey → externalLabelsValue. Example: region → ap-southeast-1.', 'type' => 'string', 'example' => 'region: cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-07-24T02:08:27Z', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T11:50:48Z', 'title' => ''], + 'extraInfo' => [ + 'description' => 'The extended information.', + 'type' => 'object', + 'properties' => [ + 'taskNameList' => [ + 'description' => 'The EventBridge task list.', + 'type' => 'array', + 'items' => ['description' => 'The EventBridge task name.', 'type' => 'string', 'example' => 'prometheus-deliver-98e367d8fb8cc83b-0', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'spec' => [ - 'description' => 'Resource spec', + 'title' => '', + 'example' => '', + ], + 'sinkList' => [ + 'description' => 'The list of delivery targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The delivery target configuration.', 'type' => 'object', 'properties' => [ - 'entityId' => [ - 'description' => 'Instance ID, which can be specified if you need to pinpoint to the instance level. It depends on the data in EntityStore.', - 'type' => 'string', - 'example' => 'es-xxxxx', - ], - 'instance' => [ - 'description' => 'Prom Instance ID.', - 'type' => 'string', - 'example' => 'i-bp122p85gthbniw8rsu9', - ], - 'instanceName' => [ - 'description' => 'Prom instance name', - 'type' => 'string', - 'example' => 'category_predict', - ], - 'project' => [ - 'description' => 'Optional parameter, determined based on the current environment type', - 'type' => 'string', - 'example' => 'datagrid_cdm', - ], - 'region' => [ - 'description' => 'Region', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'shareScope' => [ - 'description' => 'Storage sharing scope: Environment | Region | Workspace | Custom', - 'type' => 'string', - 'example' => 'Region', - ], - 'storageType' => [ - 'description' => 'Instance storage type', + 'sinkType' => [ + 'description' => 'The delivery target type.', + 'enumValueTitles' => ['AcsKafka' => 'AcsKafka', 'Prometheus' => 'Prometheus', 'AcsMaxcompute' => 'AcsMaxcompute'], 'type' => 'string', 'example' => 'Prometheus', + 'title' => '', ], - 'systemTags' => [ - 'description' => 'Tags to be applied to the target storage (injected as system tags)', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'system-key=value', - 'description' => 'Tags to be applied to the target storage (injected as system tags)', - ], - ], - 'tags' => [ - 'description' => 'Tags to be applied to the target storage (injected as regular tags)', + 'sinkConfigs' => [ + 'description' => 'The detailed configuration of the delivery target. The meanings of key/value pairs vary depending on the sinkType. For more information, see CreateDeliveryTask.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'key=value', - 'description' => 'Tags to be applied to the target storage (injected as regular tags)', - ], - ], - 'userId' => [ - 'description' => 'User ID', - 'type' => 'string', - 'example' => '12345678', - ], - 'workspace' => [ - 'description' => 'Workspace', - 'type' => 'string', - 'example' => 'test-api', + 'additionalProperties' => ['description' => 'The configuration items supported by each sinkType.', 'type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'status' => [ - 'description' => 'Storage requirement status', + 'title' => '', + 'example' => '', + ], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-chengdu', 'title' => ''], + 'tags' => [ + 'description' => 'The resource group tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag value.', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => 'Instance ID', - 'type' => 'string', - 'example' => 'rmq-cn-uqm3ket1t0u', - ], - 'interUrl' => [ - 'description' => 'Internal URL', - 'type' => 'string', - 'example' => 'http://192.168.xxxxxx', - ], - 'intraUrl' => [ - 'description' => 'External 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\'s metric center', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'region' => [ - 'description' => 'Region', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'storageType' => [ - 'description' => 'Instance storage type', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - 'addonReleaseNames' => [ - 'description' => 'Collection of AddonReleases.', - 'type' => 'array', - 'items' => [ - 'description' => 'Name of the AddonRelease.', - 'type' => 'string', - 'example' => 'kafka-17201238912', + 'key' => ['description' => 'The tag key of the resource group.', 'type' => 'string', 'example' => 'sourcetype', 'title' => ''], + 'value' => ['description' => 'The tag value of the resource group.', 'type' => 'string', 'example' => 'production', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'Get Storage Requirements Information for Access Center Policy', - 'description' => 'During the effective period of the policy, all alarms within the application group will no longer send notifications.'."\n" - .' '."\n" - .'This article provides an example of creating a pause alarm notification policy `PauseNotify` for the application group `7301****`. This application group will pause alarms from `1622949300000` to `1623208500000` (Beijing Time `2021-06-06 11:15:00` to `2021-06-09 11:15:00`).', - 'translator' => 'machine', - ], - 'ListIntegrationPolicyPodMonitors' => [ - 'summary' => 'Get PodMonitor Resources of Access Center Policy', - 'path' => '/integration-policies/{policyId}/pod-monitors', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve data delivery task details', + 'description' => 'Deletes a specified site monitoring task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'DeliveryTask', 'arn' => 'acs:cms:{#regionId}:{#accountId}:deliverytask/{#TaskId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"deliveryTask\\": {\\n \\"taskId\\": \\"8b07eeac8249866d\\",\\n \\"taskName\\": \\"test-task\\",\\n \\"taskDescription\\": \\"my delivery task\\",\\n \\"status\\": \\"Enable\\",\\n \\"dataSourceId\\": \\"rw-xxxxxx\\",\\n \\"labelFiltersType\\": \\"Allow\\",\\n \\"labelFilters\\": {\\n \\"key\\": \\"__name__: up\\"\\n },\\n \\"externalLabels\\": {\\n \\"key\\": \\"region: cn-hangzhou\\"\\n },\\n \\"createTime\\": \\"2025-07-24T02:08:27Z\\",\\n \\"updateTime\\": \\"2026-01-22T11:50:48Z\\",\\n \\"extraInfo\\": {\\n \\"taskNameList\\": [\\n \\"prometheus-deliver-98e367d8fb8cc83b-0\\"\\n ]\\n },\\n \\"sinkList\\": [\\n {\\n \\"sinkType\\": \\"Prometheus\\",\\n \\"sinkConfigs\\": {\\n \\"key\\": \\"Url: http://xxxx/api/v1/write\\"\\n }\\n }\\n ],\\n \\"regionId\\": \\"cn-chengdu\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"sourcetype\\",\\n \\"value\\": \\"production\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'GetEntityStore' => [ + 'path' => '/workspace/{workspaceName}/entitystore', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'workspaceName', 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID。', - 'description' => 'Access center policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-1d4634924c8ba599822c601fcee3', - ], - ], - [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => 'Addon Release name.', - 'type' => 'string', - 'required' => false, - 'example' => 'release-123456789', - ], - ], - [ - 'name' => 'namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间。', - 'description' => 'Namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - ], - [ - 'name' => 'encryptYaml', - 'in' => 'query', - 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => 'Whether to encrypt Yaml.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test-001'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => 'Cluster ID.', - 'type' => 'string', - 'example' => 'et15prod-et15storage', - ], - 'podMonitors' => [ - 'description' => 'PodMonitor list', - 'type' => 'array', - 'items' => [ - 'description' => 'PodMonitor list', - 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'description' => 'Addon name.', - 'type' => 'string', - 'example' => 'cloud-ecs', - ], - 'addonReleaseName' => [ - 'description' => 'Addon Release name.', - 'type' => 'string', - 'example' => 'release-2345678', - ], - 'addonVersion' => [ - 'description' => 'Addon version.', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => 'Configuration yaml.', - 'type' => 'string', - 'example' => 'apiVersion: xxxxx', - ], - 'enableStatus' => [ - 'description' => 'Enable status.', - 'type' => 'string', - 'example' => 'run', - ], - 'encryptYaml' => [ - 'description' => 'Encrypt yaml.', - 'type' => 'boolean', - 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK', - ], - 'endpoints' => [ - 'description' => 'Instance endpoints.', - 'type' => 'array', - 'items' => [ - 'description' => 'Endpoint details', - 'type' => 'object', - 'properties' => [ - 'interval' => [ - 'description' => 'Collection interval', - 'type' => 'string', - 'example' => '30s', - ], - 'matchedTargetCount' => [ - 'description' => 'Number of matched targets', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'path' => [ - 'description' => 'Metric collection path', - 'type' => 'string', - 'example' => '/metrics', - ], - 'port' => [ - 'description' => 'Port number', - 'type' => 'string', - 'example' => '9100', - ], - 'targetPort' => [ - 'description' => 'Target port', - 'type' => 'string', - 'example' => 'https', - ], - ], - ], - ], - 'matchedPodCount' => [ - 'description' => 'Number of matched pods', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'name' => [ - 'description' => 'Collection name.', - 'type' => 'string', - 'example' => 'znzmo_entity_test', - ], - 'namespace' => [ - 'description' => 'Namespace', - 'type' => 'string', - 'example' => 'sla-ns-d5aeb2b4f91b47', - ], - ], - ], - ], - 'policyId' => [ - 'description' => 'Policy 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', - ], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'."\n"], + 'workspaceName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test-001'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Query PodMonitor Resources of Access Center Policy', - 'description' => 'This article provides an example to query the alarm template list. The result shows that there are 2 alarm templates in the alarm template list, which are `ECS_Template1` and `ECS_Template2`.', - 'translator' => 'machine', - ], - 'ListIntegrationPolicyDashboards' => [ - 'summary' => 'Policy Dashboard List', - 'path' => '/integration-policies/{policyId}/dashboards', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get EntityStore', + 'summary' => 'Retrieves the storage information of an EntityStore.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntityStore'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetEntityStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'EntityStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}/entitystore'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\\\n\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', + ], + 'GetEntityStoreData' => [ + 'summary' => 'Queries the entity and relational data in a specified workspace to retrieve entity data for a specific time range.', + 'path' => '/workspace/{workspace}/entitiesAndRelations', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], + 'name' => 'acceptEncoding', + 'in' => 'header', + 'schema' => ['description' => 'The content encoding type of the compression algorithm.', 'type' => 'string', 'required' => false, 'default' => 'gzip', 'title' => '', 'example' => 'gzip'], ], [ - 'name' => 'addonName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Addon Name.', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-default', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test-001'], ], [ - 'name' => 'scene', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Component Scenario.', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'from' => ['description' => 'The start point in time for the query.'."\n" + ."\n" + .'This is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1721767203'], + 'query' => ['description' => 'The search statement.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10'], + 'to' => ['description' => 'The end point in time for the query.'."\n" + ."\n" + .'This is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1721767283'], + ], 'required' => false, - 'example' => 'databse', - ], - ], - [ - 'name' => 'language', - 'in' => 'query', - 'schema' => [ 'title' => '', - 'description' => 'Query Language', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - 'enum' => [ - 'zh', - 'en', - ], + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'total' => [ - 'description' => 'Number of components.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'dashboards' => [ - 'description' => 'List of dashboards.', + 'data' => [ + 'description' => 'The list of returned data.', 'type' => 'array', 'items' => [ - 'description' => 'List of dashboards.', - 'type' => 'object', - 'properties' => [ - 'uid' => [ - 'description' => 'ID of the current Alibaba Cloud primary account, read-only', - 'type' => 'string', - 'example' => '1258199346721590', - ], - 'engine' => [ - 'title' => '大盘引擎：'."\n" - .'grafana：共享grafana。'."\n" - .'cms：cms自研大盘引擎。', - 'description' => 'Dashboard engine:'."\n" - .'grafana: shared grafana.'."\n" - .'cms: cms self-developed dashboard engine.', - 'type' => 'string', - 'example' => 'grafana', - ], - 'title' => [ - 'description' => 'Title of the UI module (not name)', - 'type' => 'string', - 'example' => 'test', - ], - 'name' => [ - 'title' => '大盘名称', - 'description' => 'Dashboard name', - 'type' => 'string', - 'example' => 'k8s-pod', - ], - 'url' => [ - 'description' => 'pagerDuty integration webhook. Supports V1 and V2 versions', - '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' => 'Region', - 'type' => 'string', - 'example' => 'cn-hongkong', - ], - 'folderUid' => [ - 'description' => 'UID of the dashboard folder.', - 'type' => 'string', - 'example' => 'Env-AAA', - ], - 'tags' => [ - 'description' => 'List of tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag.', - 'type' => 'string', - 'example' => 'tag1', + 'description' => 'The list of data that corresponds to the request header.', + 'type' => 'array', + 'items' => ['description' => 'The data that corresponds to the request header.', 'type' => 'string', 'title' => '', 'example' => 'data1'], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'header' => [ + 'description' => 'The list of request headers.', + 'type' => 'array', + 'items' => ['description' => 'The request header.', 'type' => 'string', 'title' => '', 'example' => 'headerKey'], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'responseStatus' => [ + 'description' => 'The result status.', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The execution result.', 'type' => 'string', 'title' => '', 'example' => 'Success,PartialSuccess,Error'], + 'retryPolicy' => ['description' => 'The retry policy.', 'type' => 'string', 'title' => '', 'example' => 'None,Once,Continuous'], + 'level' => ['description' => 'The status level.', 'type' => 'string', 'title' => '', 'example' => 'Info,Warn,Error'], + 'statusItem' => [ + 'description' => 'A list of detailed status information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed status information.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success,ExecuteTimeout,UModelNotExist'], + 'level' => ['description' => 'The status level.', 'type' => 'string', 'title' => '', 'example' => 'Info,Warn,Error'], + 'message' => ['description' => 'The execution information.', 'type' => 'string', 'title' => '', 'example' => 'Query execution timeout after 30 seconds'], + 'suggestion' => ['description' => 'The suggestion provided when an execution fault occurs.', 'type' => 'string', 'title' => '', 'example' => 'Try to reduce the query scope or increase timeout limit, then retry'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'executionStates' => ['description' => 'Information about the execution procedure.', 'type' => 'string', 'title' => '', 'example' => '{}'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Query Dashboard List', - 'description' => 'This article provides an example of querying the alarm template list. The result shows that there are 2 alarm templates in the list, which are `ECS_Template1` and `ECS_Template2`.', - 'translator' => 'machine', - ], - 'ListIntegrationPolicyCustomScrapeJobRules' => [ - 'summary' => 'Get storage requirement information for the access center policy', - 'path' => '/integration-policies/{policyId}/custom-scrape-job-rules', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + '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' => 'Query Entity and Relationship Data', + 'changeSet' => [ + ['createdAt' => '2025-09-10T09:49:36.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntityStoreData'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Access center policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-d95435164593aece55f9999ce45c', - ], - ], - [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => 'Addon Release name.', - 'type' => 'string', - 'required' => false, - 'example' => 'release12345678', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetEntityStoreData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'EntityStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}/entitystore'], + ], ], ], + ], + ], + 'GetIntegrationPolicy' => [ + 'path' => '/integration-policies/{policyId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'encryptYaml', - 'in' => 'query', - 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => 'Whether to encrypt Yaml.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间。', - 'description' => 'Namespace.', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-prom', - ], + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['description' => 'Policy ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'clusterId' => [ - 'description' => 'Cluster ID.', - 'type' => 'string', - 'example' => 'et15prod-et15storage', - ], - 'customScrapeJobRules' => [ - 'description' => 'Custom scraping job rules', - 'type' => 'array', - 'items' => [ - 'description' => 'Custom service discovery rules', - 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'description' => 'Addon name.', - 'type' => 'string', - 'example' => 'cloud-ecs', - ], - 'addonReleaseName' => [ - 'description' => 'Addon Release name', - 'type' => 'string', - 'example' => 'release-12345678', - ], - 'addonVersion' => [ - 'description' => 'Addon version', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => 'Configuration yaml', - 'type' => 'string', - 'example' => 'scrape_cofnigs:'."\n" - .'- jobxxxxxx', - ], - 'enableStatus' => [ - 'description' => 'Enable status', - 'type' => 'string', - 'example' => 'mini', - ], - 'encryptYaml' => [ - 'description' => 'Encrypt yaml', - 'type' => 'boolean', - 'example' => 'true', - ], - 'matchedPodCount' => [ - 'description' => 'Matched pod count', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'message' => [ - 'description' => 'Detailed information.', - 'type' => 'string', - 'example' => 'ok', - ], - 'name' => [ - 'description' => 'Service name.', - 'type' => 'string', - 'example' => 'dlab1', - ], - 'namespace' => [ - 'description' => 'Namespace', - 'type' => 'string', - 'example' => 'prod-data', + 'policy' => [ + 'description' => 'Integration policy.', + 'type' => 'object', + 'properties' => [ + 'bindResource' => [ + 'description' => 'Bound resource information.', + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => 'Cluster ID.', 'type' => 'string', 'example' => '00b1630f02814f95a9bce717d8d56bb2 ', 'title' => ''], + 'clusterType' => ['description' => 'Cluster type.', 'type' => 'string', 'example' => 'ManagedKubernetes', 'title' => ''], + 'vpcCidr' => ['description' => 'VPC CIDR block.', 'type' => 'string', 'example' => '10.12.0.1/16', 'title' => ''], + 'vpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-2zegqpeyxplhtmdg70xnr', 'title' => ''], ], - 'scrapeConfigs' => [ - 'description' => 'Custom configurations', - 'type' => 'array', - 'items' => [ - 'description' => 'Custom configurations', + 'title' => '', + 'example' => '', + ], + 'entityGroup' => [ + 'description' => 'Entity group.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], + 'entityGroupId' => ['description' => 'Entity group ID.', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', 'title' => ''], + 'entityGroupName' => ['description' => 'Entity group name.', 'type' => 'string', 'example' => 'prod-database', 'title' => ''], + 'entityRules' => [ + 'description' => 'Entity rules.', 'type' => 'object', 'properties' => [ - 'jobName' => [ - 'description' => 'Scraping job name', - 'type' => 'string', - 'example' => 'mysql-exporter', + 'annotations' => [ + 'description' => 'Annotations.', + 'type' => 'array', + 'items' => [ + 'description' => 'Annotation.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'Tag key.', 'type' => 'string', 'example' => 'use', 'title' => ''], + 'tagValues' => [ + 'description' => 'Tag values.', + 'type' => 'array', + 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'db', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'message' => [ - 'description' => 'Detailed information.', - 'type' => 'string', - 'example' => 'successful', + 'entityTypes' => [ + 'description' => 'Entity type list.', + 'type' => 'array', + 'items' => ['description' => 'Entity type.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'metricsPath' => [ - 'description' => 'Metrics path', - 'type' => 'string', - 'example' => '/metrics', + 'fieldRules' => [ + 'description' => 'Field rule list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Field rule.', + 'type' => 'object', + 'properties' => [ + 'fieldKey' => ['description' => 'Unique identifier of the field.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'fieldValues' => [ + 'description' => 'Field values.', + 'type' => 'array', + 'items' => ['description' => 'Field value.', 'type' => 'string', 'example' => 'test-value', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'scheme' => [ - 'description' => 'Call method.', - 'type' => 'string', - 'example' => 'http', + 'instanceIds' => [ + 'description' => 'Instance IDs.', + 'type' => 'array', + 'items' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'scrapeInterval' => [ - 'description' => 'Scrape interval', - 'type' => 'string', - 'example' => '30s', + 'ipMatchRule' => [ + 'description' => 'IP match rule.', + 'type' => 'object', + 'properties' => [ + 'ipCidr' => ['description' => 'IP CIDR block.', 'type' => 'string', 'example' => '10.10.0.1/16', 'title' => ''], + 'ipFieldKey' => ['description' => 'Key of the IP field.', 'type' => 'string', 'example' => 'test-key', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'scrapeTimeout' => [ - 'description' => 'Scrape timeout', - 'type' => 'string', - 'example' => '60s', + 'labels' => [ + 'description' => 'Labels.', + 'type' => 'array', + 'items' => [ + 'description' => 'Label.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'Tag key of the instance.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'tagValues' => [ + 'description' => 'Tag value list.', + 'type' => 'array', + 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'serviceDiscoveryConfigs' => [ - 'description' => 'Service discovery configuration', + 'regionIds' => [ + 'description' => 'Region ID list.', + 'type' => 'array', + 'items' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rg-aek3aqsuvlv3yyq', 'title' => ''], + 'tags' => [ + 'description' => 'Tags.', 'type' => 'array', 'items' => [ - 'description' => 'Service discovery configuration', - 'type' => 'string', - 'example' => '{}', + 'description' => 'Resource tag.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'Tag key of the instance.', 'type' => 'string', 'example' => 'key2', 'title' => ''], + 'tagValues' => [ + 'description' => 'Tag value list.', + 'type' => 'array', + 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'values', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'regionId' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'userId' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'u123456', 'title' => ''], + 'workspace' => ['description' => 'Workspace.', 'type' => 'string', 'example' => 'test-api', 'title' => ''], + 'query' => ['description' => 'Used for query.', 'type' => 'string', 'example' => 'status: 200 AND totalTime > 0.5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'managedInfo' => [ + 'description' => 'Policy management information.', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => ['description' => 'Security group ID.', 'type' => 'string', 'example' => 'sg-xxxxxx', 'title' => ''], + 'vswitchId' => ['description' => 'VSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxxxxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'policyId' => ['description' => 'Policy ID.', 'type' => 'string', 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074', 'title' => ''], + 'policyName' => ['description' => 'Policy name.', 'type' => 'string', 'example' => 'ControlPolicy4DetailVportInfo', 'title' => ''], + 'policyType' => ['description' => 'Integration policy type.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'regionId' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'resourceGroupId' => ['description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxx', 'title' => ''], + 'tags' => [ + 'description' => 'Tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'Tag key.', 'type' => 'string', 'example' => 'use', 'title' => ''], + 'value' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'db', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'userId' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'u123456', 'title' => ''], + 'workspace' => ['description' => 'Workspace.', 'type' => 'string', 'example' => 'prometheus', 'title' => ''], + 'csUmodelStatus' => ['description' => 'UModel installation status in the container environment.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'policyId' => [ - 'description' => 'Policy 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', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Get Custom Service Discovery Rules for Access Center Policy', - 'translator' => 'machine', - ], - 'ListIntegrationPolicies' => [ - 'summary' => 'Query Access Center Policy List Information', - 'path' => '/integration-policies', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Integration Center Policy Details', + 'summary' => 'Query integration center policy information.', + 'changeSet' => [ + ['createdAt' => '2025-10-30T11:46:59.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIntegrationPolicy'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Policy ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'policy-93817a401f78435596d745a97d2e85a1', - ], - ], - [ - 'name' => 'policyName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name.', - 'type' => 'string', - 'required' => false, - 'example' => 'prod-database', - ], - ], - [ - 'name' => 'policyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Policy type', - 'type' => 'string', - 'required' => false, - 'example' => 'CS', - ], - ], - [ - 'name' => 'addonName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Addon name.', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-default', - ], - ], - [ - 'name' => 'filterRegionIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'Used for Region query, separated by commas', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing,cn-hangzhou', - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - ], - ], - [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxxxx', - ], - ], + 'ramActions' => [ [ - 'name' => 'tag', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Tag list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag list in JSON format.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag key', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'value' => [ - 'description' => 'Tag value', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetIntegrationPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'integrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], ], - 'required' => false, ], ], + ], + '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"}]', + ], + 'GetIntegrationVersionForCS' => [ + 'summary' => 'Queries the Integration Center version for a container cluster.', + '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' => 'nextToken', + 'name' => 'clusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Used to return more results. This parameter is not required for the first query. For subsequent queries, use the Token obtained from the response.', - 'type' => 'string', - 'required' => false, - 'example' => 'mvnX6zqg3P', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c502646fd0d1249baaf792b3a1b589e1b'], ], [ - 'name' => 'maxResults', + 'name' => 'clusterType', 'in' => 'query', + 'schema' => ['description' => 'The type of the cluster. Valid values: acs.ack.cluster and acs.asi.cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'acs.ack.cluster'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Maximum number of results to return. Default is 30, with a maximum of 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'type' => 'object', + 'properties' => [ + 'integrationVersion' => ['description' => 'The version of the Integration Center.', 'type' => 'string', 'title' => '', 'example' => 'V1'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetIntegrationVersionForCS', + 'description' => 'This operation is not available in the API Explorer.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'entityGroupIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'Filter for entity IDs, separated by commas', - 'type' => 'string', - 'required' => false, - 'example' => 'eg-1,eg-2,eg-3', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:GetIntegrationVersionForCS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"integrationVersion\\": \\"V1\\",\\n \\"requestId\\": \\"CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A\\"\\n}","type":"json"}]', + ], + 'GetMemories' => [ + 'summary' => 'Retrieves all memories.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/query', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'workspace', - 'in' => 'query', - 'schema' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'required' => false, - 'example' => 'demo', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'query', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Used for general queries', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'userId' => ['description' => 'The User ID.', 'type' => 'string', 'required' => false, 'example' => 'test_user_001', 'title' => ''], + 'agentId' => ['description' => 'The application\'s agent ID.', 'type' => 'string', 'required' => false, 'example' => '952730652285943809', 'title' => ''], + 'appId' => ['description' => 'The Application ID.', 'type' => 'string', 'required' => false, 'example' => '150130323', 'title' => ''], + 'runId' => ['description' => 'The Run ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-80ded1d6953c64ea', 'title' => ''], + 'filters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The key-value pairs that define the filter.', 'type' => 'any', 'title' => '', 'example' => '{"__strategy_type__":"Fact"}'], + 'title' => '', + 'description' => 'The filter criteria.', + 'required' => false, + 'example' => '{"__strategy_type__":"Fact"}', + ], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], + 'page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'test', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'prometheusInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cmee-622d27c2e87d49debceeebc7c642610e', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'bindResourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '绑定的资源Id', - 'description' => 'Bound resource ID', - 'type' => 'string', - 'required' => false, - 'example' => '622d27c2e87d49debceeebc7c642610e', - ], + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], ], ], 'responses' => [ @@ -12924,2230 +12029,1770 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'description' => 'Page size'."\n" - .'Default value:'."\n" - .' 50'."\n" - .'Maximum value:'."\n" - .' 50', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'nextToken' => [ - 'description' => 'Pagination token', - 'type' => 'string', - 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', - ], - 'policies' => [ - 'description' => 'Access policy list', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'results' => [ 'type' => 'array', 'items' => [ - 'description' => 'Access policy', 'type' => 'object', 'properties' => [ - 'bindResource' => [ - 'description' => 'Bound resource information', - 'type' => 'object', - 'properties' => [ - 'clusterId' => [ - 'description' => 'Cluster ID.', - 'type' => 'string', - 'example' => 'cv68tt87d78vyc89zy9v', - ], - 'clusterType' => [ - 'description' => 'Cluster type.', - 'type' => 'string', - 'example' => 'ManagedKubernetes', - ], - 'vpcCidr' => [ - 'description' => 'VPC CIDR', - 'type' => 'string', - 'example' => '100.100.0.1/16', - ], - 'vpcId' => [ - 'description' => 'Virtual Private Cloud (VPC).', - 'type' => 'string', - 'example' => 'vpc-uf664nyle5khp5d4d7hdo', - ], - ], - ], - 'entityGroup' => [ - 'description' => 'Entity group', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'Description.', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'entityGroupId' => [ - 'description' => 'Entity group ID', - 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'entityGroupName' => [ - 'description' => 'Entity group name', - 'type' => 'string', - 'example' => 'test-eg', - ], - 'entityRules' => [ - 'description' => 'Entity group', - 'type' => 'object', - 'properties' => [ - 'annotations' => [ - 'description' => 'Annotations', - 'type' => 'array', - 'items' => [ - 'description' => 'Annotation', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'key', - ], - 'tagValues' => [ - 'description' => 'Tag values', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag value', - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - 'entityTypes' => [ - 'description' => 'List of entity types', - 'type' => 'array', - 'items' => [ - 'description' => 'Entity type', - 'type' => 'string', - 'example' => 'ECS', - ], - ], - 'fieldRules' => [ - 'description' => 'Field rules', - 'type' => 'array', - 'items' => [ - 'description' => 'Field rule', - 'type' => 'object', - 'properties' => [ - 'fieldKey' => [ - 'description' => 'Unique identifier for the field.', - 'type' => 'string', - 'example' => 'test', - ], - 'fieldValues' => [ - 'description' => 'Field content, multiple values separated by English commas.', - 'type' => 'array', - 'items' => [ - 'description' => 'Field content, multiple values separated by English commas.', - 'type' => 'string', - 'example' => 'field1,fieled2', - ], - ], - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - ], - ], - ], - 'instanceIds' => [ - 'description' => 'Instance IDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => '6fq8fvvcb,owqeq789r', - ], - ], - 'ipMatchRule' => [ - 'description' => 'IP match rule', - 'type' => 'object', - 'properties' => [ - 'ipCidr' => [ - 'description' => 'IP segment', - 'type' => 'string', - 'example' => '100.100.1.0/16', - ], - 'ipFieldKey' => [ - 'description' => 'Key of the IP field', - 'type' => 'string', - 'example' => 'xxxx', - ], - ], - ], - 'labels' => [ - 'description' => 'Labels', - 'type' => 'array', - 'items' => [ - 'description' => 'Label `value` value.', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'test', - ], - 'tagValues' => [ - 'description' => 'Tag values', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag values', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - 'regionIds' => [ - 'description' => 'List of region IDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-beijing,cn-hangzhou', - ], - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-5i6dbwxfxuqihk7k', - ], - 'tags' => [ - 'description' => 'Instance tag information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag value', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'key', - ], - 'tagValues' => [ - 'description' => 'Tag value.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - ], - ], - 'query' => [ - 'description' => 'Search keywords, supporting document library name and description', - 'type' => 'string', - 'example' => '哈弗', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'userId' => [ - 'description' => 'User ID', - 'type' => 'string', - 'example' => '1236812738', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'test-api', - ], - ], - ], - 'managedInfo' => [ - 'description' => 'Policy network management information.', - 'type' => 'object', - 'properties' => [ - 'securityGroupId' => [ - 'description' => 'Security group ID', - 'type' => 'string', - 'example' => 'sg-xxxxx', - ], - 'vswitchId' => [ - 'description' => 'VSwitch ID.', - 'type' => 'string', - 'example' => 'vsw-xxxxxx', - ], - 'eniId' => [ - 'title' => '托管探针的eni网卡id。例如: eni-xxxx。', - 'description' => 'ENI card ID of the managed probe. For example: eni-xxxx.', - 'type' => 'string', - 'example' => 'eni-12345678', - ], - ], - ], - 'policyId' => [ - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - 'policyName' => [ - 'description' => 'Rule name.', - 'type' => 'string', - 'example' => '6f5HSsg3AP', - ], - 'policyType' => [ - 'description' => 'Access center policy type', - 'type' => 'string', - 'example' => 'ECS', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-xxxxx', - ], - 'userId' => [ - 'description' => 'User ID', - 'type' => 'string', - 'example' => '128470923', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'test-api', - ], - 'feePackage' => [ - 'description' => 'Billing type.', - 'type' => 'string', - 'enumValueTitles' => [ - 'CS_Pro' => 'CS_Pro', - 'CS_Basic' => 'CS_Basic', - ], - 'example' => 'CS_Pro', - ], - 'subAddonRelease' => [ - 'description' => 'Number of sub-releases', + 'actorId' => ['description' => 'The actor ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'agentId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '980565235819266048', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1747623093939', 'title' => ''], + 'hash' => ['description' => 'The memory hash.', 'type' => 'string', 'example' => '73ad89f2d56c2f8615e5dd0cef7b4c41c074277c91fa0e31fc5b41802c0481f2', 'title' => ''], + 'id' => ['description' => 'The memory ID.', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + 'memory' => ['description' => 'The memory content.', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + 'metadata' => [ + 'description' => 'The metadata.', 'type' => 'object', - 'properties' => [ - 'total' => [ - 'description' => 'Number of rules.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '278', - ], - 'ready' => [ - 'description' => 'Number of ready sub-releases', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - 'csUmodelStatus' => [ - 'description' => 'Container environment umodel installation status.', - 'type' => 'boolean', - 'example' => 'true', + 'additionalProperties' => ['description' => 'The custom metadata.', 'type' => 'any', 'title' => '', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '{"__strategy_type__":"Fact"}', + 'title' => '', ], + 'role' => ['description' => 'The role that sent the message.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'runId' => ['description' => 'The run ID.', 'type' => 'string', 'example' => 'jr-965a0b00cb42a43b', 'title' => ''], + 'score' => ['description' => 'The similarity score.', 'type' => 'number', 'format' => 'double', 'example' => '30.12', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'string', 'example' => '1752825865045', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'appId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'test_user_001', 'title' => ''], ], + 'description' => 'A memory object.', + 'title' => '', + 'example' => '', ], + 'description' => 'A list of results.', + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'totalCount' => [ - 'description' => 'Total number of entries', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'relations' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'destination' => ['description' => 'The destination of the relation.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'relationship' => ['description' => 'The type of the relation.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'source' => ['description' => 'The source of the relation.', 'type' => 'string', 'example' => 'test_namespace/RegistryModule-test2153b9f3-0be6-455e-9efd-05fd31f62885/alicloud', 'title' => ''], + ], + 'description' => 'A relation object.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of relations.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - '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' => 'Query Access Center Policy List Information', - 'description' => 'Query integration list', - 'translator' => 'machine', - ], - 'ListAddonReleases' => [ - 'summary' => 'List of addon releases', - 'path' => '/integration-policies/{policyId}/addon-releases', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMemories', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetMemories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"results\\": [\\n {\\n \\"actorId\\": \\"test_session_001\\",\\n \\"agentId\\": \\"980565235819266048\\",\\n \\"createdAt\\": \\"1747623093939\\",\\n \\"hash\\": \\"73ad89f2d56c2f8615e5dd0cef7b4c41c074277c91fa0e31fc5b41802c0481f2\\",\\n \\"id\\": \\"019ca1e5-7307-7d50-b943-5e628326a8ed\\",\\n \\"memory\\": \\"My name is Zhang San and I live in Hangzhou.\\",\\n \\"metadata\\": {\\n \\"key\\": \\"{\\\\\\"__strategy_type__\\\\\\":\\\\\\"Fact\\\\\\"}\\"\\n },\\n \\"role\\": \\"user\\",\\n \\"runId\\": \\"jr-965a0b00cb42a43b\\",\\n \\"score\\": 30.12,\\n \\"updatedAt\\": \\"1752825865045\\",\\n \\"userId\\": \\"test_session_001\\",\\n \\"appId\\": \\"test_user_001\\"\\n }\\n ],\\n \\"relations\\": [\\n {\\n \\"destination\\": \\"test\\",\\n \\"relationship\\": \\"test\\",\\n \\"source\\": \\"test_namespace/RegistryModule-test2153b9f3-0be6-455e-9efd-05fd31f62885/alicloud\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetMemory' => [ + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/{memoryId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '策略环境 ID。', - 'description' => 'Policy environment ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'default-cms-1793369865235921-cn-shenzhen', 'title' => ''], ], [ - 'name' => 'addonName', - 'in' => 'query', + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => 'The memory ID.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '组件 Addon 名称。', - 'description' => 'Addon component name.', - 'type' => 'string', - 'required' => false, - 'example' => 'cs-gpu', + 'type' => 'object', + 'properties' => [ + 'immutable' => ['description' => 'This property is mutable.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'owner' => ['description' => 'The owner of the memory.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'updatedAt' => ['description' => 'The time when the memory was last updated.', 'type' => 'string', 'example' => '1744428159434', 'title' => ''], + 'organization' => ['description' => 'The organization.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'memory' => ['description' => 'The memory content.', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + 'metadata' => ['description' => 'The metadata.', 'type' => 'string', 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + 'id' => ['description' => 'The memory ID.', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + 'expirationDate' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '1751595283143', 'title' => ''], + 'createdAt' => ['description' => 'The time when the memory was created.', 'type' => 'string', 'example' => '1751595283143', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'userId' => ['type' => 'string', 'example' => 'test_user_001', 'description' => '', 'title' => ''], + 'agentId' => ['type' => 'string', 'example' => 'test_user_001', 'description' => '', 'title' => ''], + 'runId' => ['type' => 'string', 'example' => 'test_user_001', 'description' => '', 'title' => ''], + 'appId' => ['type' => 'string', 'example' => 'test_user_001', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMemory', + 'summary' => 'Retrieves a single memory.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'parentAddonReleaseId', - 'in' => 'query', - 'schema' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonReleaseId.', - 'type' => 'string', - 'required' => false, - 'example' => 'policy-xxxxxxxxxxxxx', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetMemory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"immutable\\": \\"test\\",\\n \\"owner\\": \\"test\\",\\n \\"updatedAt\\": \\"1744428159434\\",\\n \\"organization\\": \\"test\\",\\n \\"memory\\": \\"My name is Zhang San and I live in Hangzhou.\\",\\n \\"metadata\\": \\"{\\\\\\"sessionId\\\\\\":\\\\\\"test_session_001\\\\\\"}\\",\\n \\"id\\": \\"019ca1e5-7307-7d50-b943-5e628326a8ed\\",\\n \\"expirationDate\\": \\"1751595283143\\",\\n \\"createdAt\\": \\"1751595283143\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"userId\\": \\"test_user_001\\",\\n \\"agentId\\": \\"test_user_001\\",\\n \\"runId\\": \\"test_user_001\\",\\n \\"appId\\": \\"test_user_001\\"\\n}","type":"json"}]', + ], + 'GetMemoryHistory' => [ + 'summary' => 'Retrieve memory history.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/{memoryId}/history', + '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' => 'Workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'Memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + [ + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => 'Memory ID.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'releases' => [ - 'description' => 'Set of add-on component information.', + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', 'title' => ''], + 'results' => [ 'type' => 'array', 'items' => [ - 'description' => 'Set of add-on component information.', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => 'Addon 名称。', - 'description' => 'Addon name.', - 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警规则数量。', - 'description' => 'Number of alert rules.', - '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' => 'Installation phase information.', + 'id' => ['description' => 'Memory ID.', 'type' => 'string', 'example' => 'b25d6ad7-306f-4040-9890-4dddd2505a2e', 'title' => ''], + 'memoryId' => ['description' => 'Memory ID.', 'type' => 'string', 'example' => '019cacf6-7b39-7f61-8314-548f07ca449a', 'title' => ''], + 'input' => [ 'type' => 'array', 'items' => [ - 'description' => 'Installation phase information.', 'type' => 'object', 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => 'First transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => 'Last transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => 'Details.', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => 'Phase status.', - 'type' => 'string', - 'example' => 'True', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => 'Phase type.', - 'type' => 'string', - 'example' => 'Loaded', - ], + 'role' => ['description' => 'Message sender role.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'content' => ['description' => 'Message content.', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], ], + 'description' => 'Message.', + 'title' => '', + 'example' => '', ], + 'description' => 'Original message.', + 'title' => '', + 'example' => '', ], - 'config' => [ - 'title' => '组件配置信息。', - 'description' => 'Component configuration information.', - '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' => 'Access time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => 'Number of dashboards.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => 'Number of plugins.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => 'Whether there is a configuration.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '接入用户 ID。', - 'description' => 'Access user ID.', - 'type' => 'string', - 'example' => '175xxxxxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => 'Language.', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => 'Whether it is a managed component.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonReleaseId.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略 ID。', - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '区域 ID。', - 'description' => 'Region 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 name.', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => 'Component scenario.', - 'type' => 'string', - 'example' => 'container', - ], - 'status' => [ - 'title' => '状态。', - 'description' => 'Status.', - 'type' => 'string', - 'example' => 'running', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => 'Update time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:23+08:00', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => 'Owner user ID.', - 'type' => 'string', - 'example' => '175xxxxxxxxxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => 'Component version.', - 'type' => 'string', - 'example' => '0.0.2', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => 'Environment type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default', + 'newMemory' => ['description' => 'New memory.', 'type' => 'string', 'example' => 'I really like Python.', 'title' => ''], + 'userId' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'event' => ['description' => 'Event type.', 'type' => 'string', 'example' => 'ADD', 'title' => ''], + 'createdAt' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '1764556182850', 'title' => ''], + 'updatedAt' => ['description' => 'Update time.', 'type' => 'string', 'example' => '1771036123785', 'title' => ''], + 'oldMemory' => ['description' => 'Old memory.', 'type' => 'string', 'example' => 'I really don\'t like Python at all.', 'title' => ''], + 'metadata' => ['description' => 'Metadata.', 'type' => 'object', 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + ], + 'description' => 'Return value.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Return value.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Response data.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMemoryHistory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"results\\": [\\n {\\n \\"id\\": \\"b25d6ad7-306f-4040-9890-4dddd2505a2e\\",\\n \\"memoryId\\": \\"019cacf6-7b39-7f61-8314-548f07ca449a\\",\\n \\"input\\": [\\n {\\n \\"role\\": \\"user\\",\\n \\"content\\": \\"My name is Zhang San and I live in Hangzhou.\\"\\n }\\n ],\\n \\"newMemory\\": \\"I really like Python.\\",\\n \\"userId\\": \\"test_session_001\\",\\n \\"event\\": \\"ADD\\",\\n \\"createdAt\\": \\"1764556182850\\",\\n \\"updatedAt\\": \\"1771036123785\\",\\n \\"oldMemory\\": \\"I really don\'t like Python at all.\\",\\n \\"metadata\\": {\\n \\"sessionId\\": \\"test_session_001\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetMemoryStore' => [ + 'summary' => 'Queries a memory store.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}', + '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'default-cms-1654218965343050-cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850', 'title' => ''], + 'shortTermTtl' => ['description' => 'The retention period of short-term memory.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'memoryStoreName' => ['description' => 'The memory store name.', 'type' => 'string', 'example' => 'test-memory-store', 'title' => ''], + 'workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default-cms-xxxxxx-cn-beijing', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', 'title' => ''], + 'extractionStrategies' => [ + 'description' => 'The extraction strategies. Valid values: Episodic, Summary, and Fact.', + 'type' => 'array', + 'items' => ['description' => 'The extraction strategies. Valid values: Episodic, Summary, and Fact.', 'type' => 'string', 'example' => 'Fact', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'customExtractionStrategies' => [ + 'description' => 'The custom extraction strategies.', + 'type' => 'array', + 'items' => ['description' => 'The custom extraction strategies.', '$ref' => '#/components/schemas/CustomExtractionStrategy', 'example' => '[{}]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'shortTermStorage' => [ + 'description' => 'The short-term memory storage.', + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The Simple Log Service project name.', 'type' => 'string', 'example' => 'wk_cms_data_warehouse', 'title' => ''], + 'logstore' => ['description' => 'The Simple Log Service Logstore name.', 'type' => 'string', 'example' => 'memory-store', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'sourceType' => ['title' => '', 'description' => 'The memory source.', 'type' => 'string', 'example' => 'Trace'], + 'traceSourceConfig' => [ + 'title' => '', + 'description' => 'The configuration used when sourceType is set to Trace.', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '', 'description' => 'The workspace where the trace resides.', 'type' => 'string', 'example' => 'test-workspace'], + 'includeOutput' => ['title' => '', 'description' => 'Specifies whether to include LLM output in memory extraction.', 'type' => 'boolean', 'example' => ''], + 'query' => ['title' => '', 'description' => 'The Simple Log Service query statement used to filter traces.', 'type' => 'string', 'example' => '(serviceName : "langchain-rag" or serviceName : "agentscope-code-correction") and hostname = frontend-proxy-999c48c8d-hvk6c '], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query a memory store', + 'description' => 'Typically used together with the QueryMetricMeta operation for querying metrics and the QueryMetricList/QueryMetricLast operation for querying monitoring data.'."\n" + .'## Request type '."\n" + .'POST|GET.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"description\\": \\"test\\",\\n \\"createTime\\": \\"1764556182850\\",\\n \\"updateTime\\": \\"1764556182850\\",\\n \\"shortTermTtl\\": 10,\\n \\"memoryStoreName\\": \\"test-memory-store\\",\\n \\"workspace\\": \\"default-cms-xxxxxx-cn-beijing\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\",\\n \\"extractionStrategies\\": [\\n \\"Fact\\"\\n ],\\n \\"customExtractionStrategies\\": [\\n {\\n \\"strategyName\\": \\"test1\\",\\n \\"strategyType\\": \\"Fact\\",\\n \\"extractionPrompt\\": \\"test\\",\\n \\"updatePrompt\\": \\"test\\",\\n \\"description\\": \\"test\\"\\n }\\n ],\\n \\"shortTermStorage\\": {\\n \\"project\\": \\"wk_cms_data_warehouse\\",\\n \\"logstore\\": \\"memory-store\\"\\n },\\n \\"sourceType\\": \\"Trace\\",\\n \\"traceSourceConfig\\": {\\n \\"workspace\\": \\"test-workspace\\",\\n \\"includeOutput\\": false,\\n \\"query\\": \\"(serviceName : \\\\\\"langchain-rag\\\\\\" or serviceName : \\\\\\"agentscope-code-correction\\\\\\") and hostname = frontend-proxy-999c48c8d-hvk6c \\"\\n }\\n}","type":"json"}]', + ], + 'GetPipeline' => [ + 'summary' => 'Query pipeline', + 'path' => '/workspace/{workspace}/pipeline/{pipelineName}', + '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' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'pipelineName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3430AE20-AFFF-597C-B553-2DF04B2933AA'], + 'pipelineName' => ['description' => 'The pipeline name.', 'type' => 'string', 'example' => 'pipeline-name-1', 'title' => ''], + 'description' => ['description' => 'The description of the pipeline.', 'type' => 'string', 'example' => 'workspace test', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2025-03-11T08:21:58Z', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-02-06T14:09:11Z', 'title' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The type of the data source.', 'type' => 'string', 'example' => 'logstore', 'title' => ''], + 'logstore' => [ + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'example' => 'test-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Log Service Logstore.', 'type' => 'string', 'example' => 'test-logstore', 'title' => ''], + 'query' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'subAddonRelease' => [ - 'title' => '子AddonRelease的统计信息', - 'description' => 'Sub-AddonRelease statistics.', + 'description' => 'The configuration of the Log Service Logstore.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The pipeline\'s data source.', + 'title' => '', + 'example' => '', + ], + 'pipeline' => [ + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'ready' => [ - 'title' => '已就绪的子Release数量', - 'description' => 'Number of ready sub-Releases.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'total' => [ - 'title' => '子Release数量', - 'description' => 'Number of sub-Releases.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'id' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'node_1', 'title' => ''], + 'type' => ['description' => 'The node type.', 'type' => 'string', 'example' => 'dedup-fuzzy', 'title' => ''], + 'parameters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The node-specific parameters.', 'type' => 'any', 'example' => '{'."\n" + .' "output": "ID,key_0,key_2,key_3,key_4",'."\n" + .' "workspace": "workspace-test-dataset",'."\n" + .' "field": "key_0",'."\n" + .' "global": true,'."\n" + .' "dataset": "dataset_1"'."\n" + .' }', 'title' => ''], + 'description' => 'The parameters for the node.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'A node in the pipeline.', + 'title' => '', + 'example' => '', ], - 'nextVersion' => [ - 'description' => 'Starting version number for the remaining list.', - 'type' => 'string', - 'example' => 'None', + 'description' => 'The nodes in the pipeline.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The pipeline configuration.', + 'title' => '', + 'example' => '', + ], + 'sink' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The sink type.', 'type' => 'string', 'example' => 'dataset', 'title' => ''], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'dataset' => ['description' => 'The dataset name.', 'type' => 'string', 'example' => 'dataset_1', 'title' => ''], ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => 'Entity details.', - '$ref' => '#/components/schemas/EntityGroupBase', + 'description' => 'The dataset configuration.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The pipeline\'s data sink.', + 'title' => '', + 'example' => '', + ], + 'executePolicy' => [ + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => 'The execution mode.', 'type' => 'string', 'example' => 'runOnce', 'title' => ''], + 'runOnce' => [ + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => 'The start time of the execution, as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013', 'title' => ''], + 'toTime' => ['description' => 'The end time of the execution, as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013', 'title' => ''], ], - 'apiVersion' => [ - 'description' => 'API version.', - 'type' => 'string', - 'example' => '2023-03-30', + 'description' => 'The configuration for a one-time execution.', + 'title' => '', + 'example' => '', + ], + 'scheduled' => [ + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The execution interval in seconds.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'fromTime' => ['description' => 'The start time of the execution, as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1772519013', 'title' => ''], ], + 'description' => 'The configuration for a scheduled execution.', + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], - 'total' => [ - 'title' => '组件数量。', - 'description' => 'Number of components.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'description' => 'The execution policy.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The returned data.', + 'example' => '', ], ], ], - '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' => 'View Add-on Component List', - 'description' => 'Query the list of access configurations', - 'translator' => 'machine', - ], - 'GetIntegrationPolicy' => [ - 'summary' => 'Query the list of access center policies', - 'path' => '/integration-policies/{policyId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetPipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:GetPipeline', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Pipeline', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/pipeline/{#PipelineName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3430AE20-AFFF-597C-B553-2DF04B2933AA\\",\\n \\"pipelineName\\": \\"pipeline-name-1\\",\\n \\"description\\": \\"workspace test\\",\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"updateTime\\": \\"2026-02-06T14:09:11Z\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"source\\": {\\n \\"type\\": \\"logstore\\",\\n \\"logstore\\": {\\n \\"project\\": \\"test-project\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"query\\": \\"\\"\\n }\\n },\\n \\"pipeline\\": {\\n \\"nodes\\": [\\n {\\n \\"id\\": \\"node_1\\",\\n \\"type\\": \\"dedup-fuzzy\\",\\n \\"parameters\\": {\\n \\"key\\": \\"{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"output\\\\\\": \\\\\\"ID,key_0,key_2,key_3,key_4\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"workspace\\\\\\": \\\\\\"workspace-test-dataset\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"field\\\\\\": \\\\\\"key_0\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"global\\\\\\": true,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"dataset\\\\\\": \\\\\\"dataset_1\\\\\\"\\\\n\\\\t\\\\t\\\\t}\\"\\n }\\n }\\n ]\\n },\\n \\"sink\\": {\\n \\"type\\": \\"dataset\\",\\n \\"dataset\\": {\\n \\"workspace\\": \\"workspace-test\\",\\n \\"dataset\\": \\"dataset_1\\"\\n }\\n },\\n \\"executePolicy\\": {\\n \\"mode\\": \\"runOnce\\",\\n \\"runOnce\\": {\\n \\"fromTime\\": 1772519013,\\n \\"toTime\\": 1772519013\\n },\\n \\"scheduled\\": {\\n \\"interval\\": \\"86400\\",\\n \\"fromTime\\": 1772519013\\n }\\n }\\n}","type":"json"}]', + ], + 'GetPrometheusInstance' => [ + 'summary' => 'Queries the details of a specified Managed Service for Prometheus instance.', + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcmsCP2WWY'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'prometheusInstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rw-abc123', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language. Default value: zh. Valid values: zh, en.', 'type' => 'string', 'default' => 'zh', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'policy' => [ - 'description' => 'Access policy.', + 'prometheusInstance' => [ + 'description' => 'The details of the Prometheus instance.', 'type' => 'object', 'properties' => [ - 'bindResource' => [ - 'description' => 'Bound resource information.', + 'accessType' => ['title' => '', 'description' => 'The access type. Valid values:'."\n" + .'- readWrite'."\n" + .'- readOnly'."\n" + .'- httpReadOnly', 'type' => 'string', 'example' => 'readOnly'], + 'archiveDuration' => ['title' => '', 'description' => 'The number of days that data is automatically archived after the storage period expires. A value of 0 indicates that data is not archived. A value of 3650 indicates that data is permanently retained.', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'authFreeReadPolicy' => ['title' => '', 'description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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' => 'The authentication-free write policy. IP CIDR blocks and VPC IDs are supported.', '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' => '', 'description' => 'The authentication token.', 'type' => 'string', 'example' => 'eJwixxxxx'], + 'createTime' => ['title' => '', 'description' => 'The time when the instance was created. The time is in UTC+0 and in the yyyy-MM-ddTHH:mmZ format.', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'enableAuthFreeRead' => ['title' => '', 'description' => 'Indicates whether authentication-free read is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthFreeWrite' => ['title' => '', 'description' => 'Indicates whether authentication-free write is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthToken' => ['description' => 'Indicates whether the authentication token is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'extraInfo' => [ + 'title' => '', + 'description' => 'The extended information.', 'type' => 'object', - 'properties' => [ - 'clusterId' => [ - 'description' => 'Cluster ID.'."\n", - 'type' => 'string', - 'example' => '00b1630f02814f95a9bce717d8d56bb2 ', - ], - 'clusterType' => [ - 'description' => 'Cluster type.', - 'type' => 'string', - 'example' => 'ManagedKubernetes', - ], - 'vpcCidr' => [ - 'description' => 'VPC CIDR.', - 'type' => 'string', - 'example' => '10.12.0.1/16', - ], - 'vpcId' => [ - 'description' => 'VPC ID.', - 'type' => 'string', - 'example' => 'vpc-2zegqpeyxplhtmdg70xnr', - ], + 'additionalProperties' => ['description' => 'The additional extended information.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'example' => '', + ], + 'httpApiInterUrl' => ['description' => 'The HTTP public endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'httpApiIntraUrl' => ['description' => 'The HTTP private endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'httpApiInternalUrl' => ['description' => 'The HTTP internal endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'instanceType' => ['title' => '', 'description' => 'The Prometheus instance type.', 'type' => 'string', 'example' => 'remote-write'], + 'paymentType' => ['title' => '', 'description' => 'The billing method. Valid values:'."\n" + .'- POSTPAY: pay-as-you-go based on the number of reported metrics.'."\n" + .'- POSTPAY_GB: pay-as-you-go based on the volume of written metrics.', 'type' => 'string', 'example' => 'POSTPAY'], + 'product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs (arms or cms).', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-524ada714221af267c73122af2e1', 'title' => ''], + 'prometheusInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test-prom-name', 'title' => ''], + 'pushGatewayInterUrl' => ['description' => 'The PushGateway public endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'pushGatewayIntraUrl' => ['description' => 'The PushGateway private endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx'."\n", 'title' => ''], + 'pushGatewayInternalUrl' => ['description' => 'The PushGateway internal endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'remoteReadInterUrl' => ['description' => 'The public read endpoint.', 'type' => 'string', 'example' => ' http://workspace-default-cms-xxxxxxx', 'title' => ''], + 'remoteReadIntraUrl' => ['description' => 'The private read endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-1xxxxxxxxxx', 'title' => ''], + 'remoteReadInternalUrl' => ['description' => 'The RemoteRead internal endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-1xxxxxxxxxx', 'title' => ''], + 'remoteWriteInterUrl' => ['description' => 'The public write endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx', 'title' => ''], + 'remoteWriteIntraUrl' => ['description' => 'The private write endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx', 'title' => ''], + 'remoteWriteInternalUrl' => ['description' => 'The RemoteWrite internal endpoint.', 'type' => 'string', 'example' => 'https://workspace-default-cms-xxxxxxxxxx', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + 'resourceType' => ['title' => '', 'description' => 'Fixed value: PrometheusInstance.', 'type' => 'string', 'example' => 'Prometheus'], + 'status' => ['title' => '', 'description' => 'The instance status.', 'type' => 'string', 'example' => 'Running'], + 'storageDuration' => ['title' => '', 'description' => 'The storage duration, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'supportAuthTypes' => [ + 'title' => '', + 'description' => 'The supported authentication types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The authentication type.', + 'enumValueTitles' => ['BasicAuth' => 'HTTP basic authentication.', 'AuthFree' => 'Authentication-free.', 'AuthToken' => 'Token-based authentication.'], + 'type' => 'string', + 'enum' => ['BasicAuth', 'AuthFree', 'AuthToken'], + 'example' => 'BasicAuth', + 'title' => '', ], + 'example' => '', ], - 'entityGroup' => [ - 'description' => 'Entity group.', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'Description.', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'entityGroupId' => [ - 'description' => 'Entity group ID.', - 'type' => 'string', - 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', - ], - 'entityGroupName' => [ - 'description' => 'Entity group name.', - 'type' => 'string', - 'example' => 'prod-database', - ], - 'entityRules' => [ - 'description' => 'Entity rules.', - 'type' => 'object', - 'properties' => [ - 'annotations' => [ - 'description' => 'Annotations.', - 'type' => 'array', - 'items' => [ - 'description' => 'Annotations.', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'use', - ], - 'tagValues' => [ - 'description' => 'Tag values.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag values.', - 'type' => 'string', - 'example' => 'db', - ], - ], - ], - ], - ], - 'entityTypes' => [ - 'description' => 'List of entity types.', - 'type' => 'array', - 'items' => [ - 'description' => 'Entity type.', - 'type' => 'string', - 'example' => 'CS', - ], - ], - 'fieldRules' => [ - 'description' => 'List of field rules.', - 'type' => 'array', - 'items' => [ - 'description' => 'Field rule.', - 'type' => 'object', - 'properties' => [ - 'fieldKey' => [ - 'description' => 'Unique identifier for the field.', - 'type' => 'string', - 'example' => 'test', - ], - 'fieldValues' => [ - 'description' => 'Field content.', - 'type' => 'array', - 'items' => [ - 'description' => 'Field content.', - 'type' => 'string', - 'example' => 'test-value', - ], - ], - 'op' => [ - 'description' => 'Operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - ], - ], - ], - 'instanceIds' => [ - 'description' => 'Instance ID.', - 'type' => 'array', - 'items' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u', - ], - ], - 'ipMatchRule' => [ - 'description' => 'IP matching rule.', - 'type' => 'object', - 'properties' => [ - 'ipCidr' => [ - 'description' => 'IP segment.', - 'type' => 'string', - 'example' => '10.10.0.1/16', - ], - 'ipFieldKey' => [ - 'description' => 'Key for the IP field.', - 'type' => 'string', - 'example' => 'test-key', - ], - ], - ], - 'labels' => [ - 'description' => 'Labels.', - 'type' => 'array', - 'items' => [ - 'description' => 'Label `key` value.', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'The operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'The tag key of the instance.', - 'type' => 'string', - 'example' => 'key1', - ], - 'tagValues' => [ - 'description' => 'List of tag values.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - ], - 'regionIds' => [ - 'description' => 'List of region IDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-aek3aqsuvlv3yyq', - ], - 'tags' => [ - 'description' => 'Tag values.', - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tag value.', - 'type' => 'object', - 'properties' => [ - 'op' => [ - 'description' => 'The operation to be performed.', - 'type' => 'string', - 'example' => 'add', - ], - 'tagKey' => [ - 'description' => 'The tag key of the instance.', - 'type' => 'string', - 'example' => 'key2', - ], - 'tagValues' => [ - 'description' => 'List of tag values.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'values', - ], - ], - ], - ], - ], - ], - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => 'u123456', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'test-api', + 'tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'openStorage', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '130303196111114281', 'title' => ''], ], - 'query' => [ - 'description' => 'For querying', - 'type' => 'string', - 'example' => 'status: 200 AND totalTime > 0.5', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '170731234567', 'title' => ''], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => 'V1'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'ws1'], + 'folderUrl' => ['title' => '', 'description' => 'The dashboard directory URL.', 'type' => 'string', 'example' => 'https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx'], + 'grafanaInstanceId' => ['title' => '', 'description' => 'The instance ID of the attached managed Grafana instance.', 'type' => 'string', 'example' => 'SHARED'], + 'grafanaInstanceName' => ['title' => '', 'description' => 'The name of the associated managed Grafana instance.', 'type' => 'string', 'example' => '共享版'], + 'paymentTypeUpdateTime' => ['title' => '', 'description' => 'The time when the billing method of the instance was last modified, in UTC format.', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + ], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + ], + 'example' => '', + ], + ], + ], + '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 \\"httpApiInternalUrl\\": \\" 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 \\"pushGatewayInternalUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"remoteReadInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"remoteReadIntraUrl\\": \\"https://workspace-default-cms-1xxxxxxxxxx\\",\\n \\"remoteReadInternalUrl\\": \\"https://workspace-default-cms-1xxxxxxxxxx\\",\\n \\"remoteWriteInterUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"remoteWriteIntraUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"remoteWriteInternalUrl\\": \\"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' => 'Get prometheus instance details', + 'description' => 'Retrieves the details of a Managed Service for Prometheus instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetPrometheusInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusInstance', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#prometheusInstanceId}'], + ], + ], + ], + ], + ], + 'GetPrometheusUserSetting' => [ + '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' => '', 'description' => 'The language of the response. Valid values: zh and en. Default value: zh.', 'type' => 'string', 'required' => false, 'default' => 'zh', 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'prometheusUserSetting' => [ + 'description' => 'The details of the user settings for Prometheus.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The value of the configuration item.', 'title' => '', 'example' => 'value1'], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '058550FA-DDBE-519E-9C6D-93521B9A5E90'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetPrometheusUserSetting', + 'summary' => 'Retrieves the user settings for Prometheus.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusUserSetting\\": {\\n \\"key\\": \\"value1\\"\\n },\\n \\"requestId\\": \\"058550FA-DDBE-519E-9C6D-93521B9A5E90\\"\\n}","type":"json"}]', + ], + 'GetPrometheusView' => [ + 'summary' => 'Queries the details of a specified Prometheus view instance.', + '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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rw-xxxxxx', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language. Default value: zh. Valid values: zh and en.', 'type' => 'string', 'default' => 'zh', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusView' => [ + 'description' => 'The view instance.', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => ['title' => '', 'description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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' => '', 'description' => 'The authentication token string.', 'type' => 'string', 'example' => 'eJxxxxxx'], + 'createTime' => ['title' => '', 'description' => 'The time when the instance was created. The time is in UTC+0 and in the yyyy-MM-ddTHH:mmZ format.', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'enableAuthFreeRead' => ['title' => '', 'description' => 'Indicates whether authentication-free read is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'enableAuthToken' => ['title' => '', 'description' => 'Indicates whether the authentication token is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'httpApiInterUrl' => ['description' => 'The public HTTP URL.', 'type' => 'string', 'example' => 'http://xxxxxxxx', 'title' => ''], + 'httpApiIntraUrl' => ['description' => 'The internal HTTP URL.', 'type' => 'string', 'example' => 'http://xxxxxxxx', 'title' => ''], + 'httpApiInternalUrl' => ['description' => 'The internal HTTP URL.', 'type' => 'string', 'example' => 'https://workspace-xxx.cn-hangzhou-internal.log.aliyuncs.com/prometheus/workspace-xxx/aliyun-prom-rw-xxx', 'title' => ''], + 'instanceType' => ['title' => '', 'description' => 'The instance type. The value is fixed as prom-view.', 'type' => 'string', 'example' => 'prom-view'], + 'paymentType' => ['title' => '', 'description' => 'The billing type. The value is currently fixed as FREE.', 'type' => 'string', 'example' => 'FREE'], + 'product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstances' => [ + 'description' => 'The list of Prometheus instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of Prometheus instances.', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-63549e054ff596a4149927961dff', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-north-2-gov-1', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '122xxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'prometheusViewId' => ['description' => 'The Prometheus view ID.', 'type' => 'string', 'example' => 'view-xxx', 'title' => ''], + 'prometheusViewName' => ['description' => 'The Prometheus view name.', 'type' => 'string', 'example' => 'view1', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'remoteReadInterUrl' => ['description' => 'The public URL for remote read.', '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', 'title' => ''], + 'remoteReadIntraUrl' => ['description' => 'The internal URL for remote read.', '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', 'title' => ''], + 'remoteReadInternalUrl' => ['description' => 'The internal endpoint for remote read.', 'type' => 'string', 'example' => 'http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-internal.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + 'resourceType' => ['title' => '', 'description' => 'The resource type. The value is fixed as PrometheusView.', 'type' => 'string', 'example' => 'RegistryModule'], + 'status' => ['title' => '', 'description' => 'The status of the backend data storage.', 'type' => 'string', 'example' => 'Pending2Running'], + 'supportAuthTypes' => [ + 'description' => 'The supported authentication types.', + 'type' => 'array', + 'items' => ['description' => 'The supported authentication types.', 'type' => 'string', 'example' => 'BasicAuth', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'managedInfo' => [ - 'description' => 'Policy management information.', - 'type' => 'object', - 'properties' => [ - 'securityGroupId' => [ - 'description' => 'Security group ID.', - 'type' => 'string', - 'example' => 'sg-xxxxxx', - ], - 'vswitchId' => [ - 'description' => 'VSwitch ID.', - 'type' => 'string', - 'example' => 'vsw-xxxxxxxxx', + 'tags' => [ + 'description' => 'The tag keys of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The integration key of PagerDuty.', 'type' => 'string', 'example' => 'global_score_series', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '371293199010092839', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'policyId' => [ - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074', - ], - 'policyName' => [ - 'description' => 'Rule name.', - 'type' => 'string', - 'example' => 'ControlPolicy4DetailVportInfo', - ], - 'policyType' => [ - 'description' => 'Access policy type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '11222', 'title' => ''], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => 'V1'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the environment belongs.', 'type' => 'string', 'example' => 'cms-monitor-test-aysls-pub-cn-fuzhou-monitor'], + 'folderUrl' => ['title' => '', 'description' => 'The dashboard URL.', 'type' => 'string', 'example' => 'https://xxxx'], + 'grafanaInstanceId' => ['title' => '', 'description' => 'The instance ID of the attached managed Grafana instance.', 'type' => 'string', 'example' => 'g-xxx '], + 'grafanaInstanceName' => ['title' => '', 'description' => 'The name of the associated managed Grafana instance.', 'type' => 'string', 'example' => 'gxxx'], + ], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8'], + ], + 'example' => '', + ], + ], + ], + '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 \\"httpApiInternalUrl\\": \\"https://workspace-xxx.cn-hangzhou-internal.log.aliyuncs.com/prometheus/workspace-xxx/aliyun-prom-rw-xxx\\",\\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 \\"remoteReadInternalUrl\\": \\"http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-internal.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' => 'Query the details of a specified prometheus view instance', + 'description' => 'Queries a specified Prometheus view instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetPrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/{#prometheusViewId}'], + ], + ], + ], + ], + ], + 'GetService' => [ + 'summary' => 'Retrieves the details of an Application Monitoring service.', + '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' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', 'title' => ''], + 'service' => [ + 'description' => 'The service object.', + 'type' => 'object', + 'properties' => [ + 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'."\n", 'title' => ''], + 'serviceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'demo-app', 'title' => ''], + 'createTime' => ['description' => 'The time when the service was created.', 'type' => 'string', 'example' => '2025-05-13T03:32:55Z', 'title' => ''], + 'serviceType' => [ + 'description' => 'The service type.', + 'enumValueTitles' => ['TRACE' => 'TRACE', 'RUM' => 'RUM', 'XTRACE' => 'XTRACE'], 'type' => 'string', - 'example' => 'rg-xxxxx', + 'example' => 'TRACE', + 'title' => '', ], + 'serviceStatus' => ['description' => 'The service status. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'displayName' => ['description' => 'The display name. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'demo应用', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default-cms-1106439496876715-cn-hangzhou', 'title' => ''], + 'pid' => ['description' => 'The ID of the ARMS application that is compatible with earlier versions.', 'type' => 'string', 'example' => 'by6rjzro2j@0fe8dfa799e5906', 'title' => ''], + 'description' => ['description' => 'The description. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'attributes' => ['description' => 'The extended information.', 'type' => 'string', 'example' => '{"language":"java"}', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz', 'title' => ''], 'tags' => [ - 'description' => 'Tag keys.', 'type' => 'array', 'items' => [ - 'description' => 'Tags.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'use', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => 'db', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'prod', 'title' => ''], ], + 'description' => 'The tag.', + 'title' => '', + 'example' => '', ], - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => 'u123456', - ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'prometheus', - ], - 'csUmodelStatus' => [ - 'type' => 'boolean', - 'description' => 'Cs umodel status', + 'description' => 'The array of tags.', + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request.', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidService.NotFound', 'errorMessage' => 'The specified Service does not exist.', 'description' => ''], + ], ], - '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' => 'Query Access Center Policy Details', - 'translator' => 'machine', - ], - 'GetAddonRelease' => [ - 'summary' => 'Check addon release (view connection status)', - 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', - 'methods' => [ - 'get', + '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' => 'Query Application Observability Service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/{#ServiceId}'], + ], + ], + ], ], + ], + 'GetServiceObservability' => [ + 'path' => '/workspace/{workspace}/service-observability/{type}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'releaseName', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => 'AddonRelease 的名称。', - 'description' => 'The name of the AddonRelease.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-gpu-integration-name', - ], + 'schema' => ['description' => 'The Cloud Monitor 2.0 workspace.', 'type' => 'string', 'required' => true, 'example' => 'my-test-ws', 'title' => ''], ], [ - 'name' => 'policyId', + 'name' => 'type', 'in' => 'path', 'schema' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', + 'description' => 'The application observability type.', + 'enumValueTitles' => ['rum' => 'Real User Monitoring (RUM).', 'apm' => 'Application Performance Monitoring (APM).'], 'type' => 'string', 'required' => true, - 'example' => 'policy-xxxxxxxxxxxx', + 'example' => 'apm', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'config' => [ - 'title' => '组件配置。', - 'description' => 'Component configuration.', + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4852B9B5-345C-5CBC-A15F-786D83ECCBBA'], + 'type' => [ + 'description' => 'The type of application observability.', + 'enumValueTitles' => ['rum' => 'RUM', 'apm' => 'APM'], 'type' => 'string', - 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', + 'example' => 'apm', + 'title' => '', ], - 'release' => [ - 'description' => 'Detailed information.', + 'regionId' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default-cms-1654218***343050-cn-hangzhou', 'title' => ''], + 'status' => [ + 'description' => 'The resource initialization status.', + 'enumValueTitles' => ['Running' => 'normal'], + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'entryPointInfo' => [ + 'description' => 'The endpoint and authentication information.', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => '组件 Addon 名称。', - 'description' => 'Addon component name.', - 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警规则数量。', - 'description' => 'Number of alert rules.', - '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' => 'Installation phase information.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => 'First transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => 'Last transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => 'Details.', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => 'Phase status.', - 'type' => 'string', - 'example' => 'True', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => 'Phase type.', - 'type' => 'string', - 'example' => 'Loaded', - ], - ], - ], - ], - 'config' => [ - 'title' => '组件配置信息。', - 'description' => 'Component configuration information.', - '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' => 'Connection time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => 'Number of dashboards.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => 'Number of plugins.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => 'Whether there is a configuration.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '接入用户 ID。', - 'description' => 'User ID for connection.', - 'type' => 'string', - 'example' => '1707xxxxxxxxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => 'Language.', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => 'Whether it is a managed component.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonRelease ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略 ID。', - 'description' => 'Policy ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '区域 ID。', - 'description' => 'Region 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' => 'The name of the Release.', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => 'Component scenario.', - 'type' => 'string', - 'example' => 'container', - ], - 'status' => [ - 'title' => '组件状态。', - 'description' => 'Component status.', - 'type' => 'string', - 'example' => 'running', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => 'Update time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:12+08:00', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => 'Owner user ID.', - 'type' => 'string', - 'example' => '1707xxxxxxxxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => 'Component version.', - 'type' => 'string', - 'example' => '0.0.2', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => 'Environment type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default', - ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => 'Entity details.', - '$ref' => '#/components/schemas/EntityGroupBase', - ], + 'authToken' => ['description' => 'The authentication token for reporting data.', 'type' => 'string', 'example' => 'gaddp****@de20f2***1ce***', 'title' => ''], + 'publicDomain' => ['description' => 'The public endpoint.', 'type' => 'string', 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com', 'title' => ''], + 'privateDomain' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com', 'title' => ''], + 'project' => ['description' => 'The Simple Log Service project.', 'type' => 'string', 'example' => 'proj-xtrace-xxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + 'feeType' => ['description' => 'The billing type.', 'type' => 'string', 'example' => 'arms=serverless;xtrace=serverless', 'title' => ''], + 'settings' => [ + 'description' => 'The system configuration.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The configuration key-value pairs.', 'type' => 'string', 'example' => '{"trace_aggregate":"enable"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'quotas' => [ + 'description' => 'The quota configuration.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The quota configuration key-value pairs.', 'type' => 'string', 'example' => '{"arms_agent_hour": "48"}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Application Observability', + 'summary' => 'Retrieves an application observability instance.', + 'extraInfo' => 'settIngs系统配置支持如下：'."\n" + .'* trace_aggregate : enable / disable，用于开源探针接入场景控制是否关闭指标生成', + 'changeSet' => [ + ['createdAt' => '2025-07-23T04:58:08.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceObservability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetServiceObservability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/service-observability/{#type}'], + ], ], ], ], - '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' => 'View Add-on Component Information', - 'translator' => 'machine', + '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"}]', ], - 'DeleteAddonRelease' => [ - 'summary' => 'Delete addon release information', - 'path' => '/integration-policies/{policyId}/addon-releases', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'GetServiceRecord' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}/record', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'releaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'AddonRelease 的名称。', - 'description' => 'The name of the AddonRelease.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-gpu-integration-name', - ], - ], - [ - 'name' => 'force', - 'in' => 'query', - 'schema' => [ - 'title' => '是否硬性删除，默认 false。', - 'description' => 'Whether to force deletion, default is false.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '是', - 'false' => '否', - ], - 'example' => 'false', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'policyId', + 'name' => 'serviceId', 'in' => 'path', - 'schema' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-xxxxxxxxxxxxx', - ], + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], ], [ - 'name' => 'addonName', + 'name' => 'recordType', 'in' => 'query', 'schema' => [ - 'title' => 'Addon 名称，当 AddonName 赋值时，将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', - 'description' => 'Addon name. When AddonName is provided, it will ignore the ReleaseName parameter and batch uninstall all AddonReleases belonging to the same Addon.', + 'title' => '', + 'description' => 'The type of the linked entry. Currently supported values:'."\n" + .'logCorrelation: indicates application log association.', 'type' => 'string', - 'required' => false, - 'example' => 'cs-gpu', + 'required' => true, + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'record' => [ + 'description' => 'The record.', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'default-cms-1610600919225911-cn-beijing'], + 'serviceId' => ['title' => '', 'description' => 'The unique identifier of the service.', 'type' => 'string', 'example' => 'ckj0xn6ma3@b96491402f8e1f15a8c79'], + 'recordType' => ['title' => '', 'description' => 'The type of the linked entry. Currently supported values:'."\n" + .'logCorrelation: indicates application log association.', 'type' => 'string', 'example' => 'logCorrelation'], + 'recordContent' => ['title' => '', 'description' => 'The entry content in JSON string format. The returned content varies depending on the recordType.', 'type' => 'string', 'example' => '{"project":"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou","storeName":"app-biz-log","regionId":"cn-hangzhou","bindType":"logstore","traceIdRelateField":""}'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get a service-linked entry', + 'summary' => 'Queries a service-linked entry.', + 'description' => 'Retrieves a service-linked entry.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Uninstall Access Component', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"record\\": {\\n \\"workspace\\": \\"default-cms-1610600919225911-cn-beijing\\",\\n \\"serviceId\\": \\"ckj0xn6ma3@b96491402f8e1f15a8c79\\",\\n \\"recordType\\": \\"logCorrelation\\",\\n \\"recordContent\\": \\"{\\\\\\"project\\\\\\":\\\\\\"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou\\\\\\",\\\\\\"storeName\\\\\\":\\\\\\"app-biz-log\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\\\"bindType\\\\\\":\\\\\\"logstore\\\\\\",\\\\\\"traceIdRelateField\\\\\\":\\\\\\"\\\\\\"}\\"\\n }\\n}","type":"json"}]', ], - 'CreateAddonRelease' => [ - 'summary' => 'Install the access component, representing a single access attempt', - 'path' => '/integration-policies/{policyId}/addon-releases', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetUmodel' => [ + 'summary' => 'Retrieves the configuration of a Umodel.', + 'path' => '/workspace/{workspace}/umodel', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求体参数。', - 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'addonName' => [ - 'title' => '需要接入监控的组件 Addon 名称。', - 'description' => 'The Addon name of the component that needs to be monitored.', - 'type' => 'string', - 'required' => true, - 'example' => 'cs-gpu', - ], - 'aliyunLang' => [ - 'title' => '组件的语言类型。', - 'description' => 'The language type of the component.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '英语', - 'zh' => '中文', - ], - 'example' => 'zh', - ], - 'dryRun' => [ - 'title' => '是否试运行，默认为 false。', - 'description' => 'Whether it is a dry run, default is false.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '试运行', - 'false' => '不试运行', - ], - 'example' => 'false', - ], - 'envType' => [ - 'title' => '环境类型。如果 Policy 类型为 CS 和 ECS，对应使用，其他类型统一为 Cloud。', - 'description' => 'Environment type. If the Policy type is CS and ECS, use accordingly; otherwise, it is unified as Cloud.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CS' => '容器环境', - 'ECS' => 'ECS环境', - 'Cloud' => '云服务环境', + 'commonSchemaRef' => [ + 'description' => 'This parameter is reserved.', + 'type' => 'array', + 'items' => [ + 'description' => 'This parameter is reserved.', + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'The public Umodel schema group.', 'type' => 'string', 'title' => '', 'example' => 'test-job-123123'], + 'version' => ['description' => 'The version.', 'type' => 'string', 'title' => '', 'example' => '5'], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'CS', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonReleaseId.', - 'type' => 'string', - 'required' => false, - 'example' => 'policy-xxxxxxxxxxx', - ], - 'releaseName' => [ - 'title' => '接入后的插件名称，如果不指定则生成默认规则名称。', - 'description' => 'The plugin name after access. If not specified, a default rule name will be generated.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-gpu-integration-name', - ], - 'values' => [ - 'title' => '输入的元数据。', - 'description' => 'Input metadata.', - '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' => 'The version of the Addon component that needs to be monitored.', - 'type' => 'string', - 'required' => true, - 'example' => '0.0.2', - ], - 'workspace' => [ - 'title' => '安装组件资源的工作空间名称。'."\n", - 'description' => 'The workspace name for installing the component resources.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'entityRules' => [ - 'title' => '实体发现规则。', - 'description' => 'Field rules', - 'required' => false, - '$ref' => '#/components/schemas/EntityDiscoverRule', + 'title' => '', + 'example' => '', ], + 'description' => ['description' => 'The Umodel description.', 'type' => 'string', 'title' => '', 'example' => 'workspace test'], + 'regionId' => ['description' => 'The region of the resource.', 'type' => 'string', 'title' => '', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '123-123123-sdf-435-3123'], + 'workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'Get Umodel', + 'description' => 'Retrieves the configuration of a Umodel.', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodel'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '环境策略 ID。', - 'description' => 'Environment policy ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-yyyyyyyyyy', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetUmodel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], ], ], ], + ], + 'GetUmodelCommonSchemaRef' => [ + 'summary' => 'Retrieves the referenced common 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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据。', - 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'release' => [ - 'title' => '接入组件信息。', - 'description' => 'Accessed component information.', - 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'title' => '接入监控的组件 Addon 名称。', - 'description' => 'The Addon name of the component being monitored.', - 'type' => 'string', - 'example' => 'cs-gpu', - ], - 'alertRuleCount' => [ - 'title' => '告警组数量。', - 'description' => 'Number of alert groups.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'conditions' => [ - 'title' => '组件安装阶段信息。', - 'description' => 'Component installation phase information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Operator, supporting exact match, prefix match, and regular expression three methods.', - 'type' => 'object', - 'properties' => [ - 'firstTransitionTime' => [ - 'title' => '第一次转换时间。', - 'description' => 'First transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'lastTransitionTime' => [ - 'title' => '最后一次转换时间。', - 'description' => 'Last transition time.', - 'type' => 'string', - 'example' => '2024-11-04T16:10:22+08:00', - ], - 'message' => [ - 'title' => '详细信息。', - 'description' => 'Detailed information.', - 'type' => 'string', - 'example' => 'The addon loaded successfully', - ], - 'status' => [ - 'title' => '阶段状态。', - 'description' => 'Phase status.', - 'type' => 'string', - 'example' => '{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}', - ], - 'type' => [ - 'title' => '阶段类型。', - 'description' => 'Phase type.', - 'type' => 'string', - 'example' => 'Loaded', - ], - ], - ], - ], - 'config' => [ - 'title' => '组件配置。', - 'description' => 'Component configuration.', - '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' => 'Connection time.', - 'type' => 'string', - 'example' => '2024-11-05T15:21:30+08:00', - ], - 'dashboardCount' => [ - 'title' => '大盘数量。', - 'description' => 'Number of dashboards.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'environmentId' => [ - 'title' => '环境 ID。', - 'description' => 'Environment ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'exporterCount' => [ - 'title' => '插件数量。', - 'description' => 'Number of plugins.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'haveConfig' => [ - 'title' => '是否有配置。', - 'description' => 'Whether it has configuration.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'installUserId' => [ - 'title' => '安装的用户 ID。', - 'description' => 'ID of the user who installed it.', - 'type' => 'string', - 'example' => '1654218965xxxxxx', - ], - 'language' => [ - 'title' => '语言。', - 'description' => 'Language.', - 'type' => 'string', - 'example' => 'zh', - ], - 'managed' => [ - 'title' => '是否为托管组件。', - 'description' => 'Whether it is a managed component.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'parentAddonReleaseId' => [ - 'title' => '父级 AddonReleaseId。', - 'description' => 'Parent AddonReleaseId.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxxx', - ], - 'policyId' => [ - 'title' => '策略环境 ID。', - 'description' => 'Policy environment ID.', - 'type' => 'string', - 'example' => 'policy-xxxxxxxxxx', - ], - 'regionId' => [ - 'title' => '地域 ID。', - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'releaseId' => [ - 'title' => '安装后的 ReleaseID。', - 'description' => 'ReleaseID after installation.', - 'type' => 'string', - 'example' => '2e898e60-5e6a-46d1-a994-xxxxxxxxxx', - ], - 'releaseName' => [ - 'title' => 'Release 的名称。', - 'description' => 'Name of the Release.', - 'type' => 'string', - 'example' => 'test-gpu-integration-name', - ], - 'scene' => [ - 'title' => '组件场景。', - 'description' => 'Component scenario.', - 'type' => 'string', - 'example' => '1', - ], - 'status' => [ - 'title' => '组件状态。', - 'description' => 'Component status.', - 'type' => 'string', - 'example' => '200', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => 'Update time.', - 'type' => 'string', - 'example' => '2024-09-13T02:21:02Z', - ], - 'userId' => [ - 'title' => '所属用户 ID。', - 'description' => 'ID of the owner user.', - 'type' => 'string', - 'example' => '165421896xxxxxx', - ], - 'version' => [ - 'title' => '组件版本。', - 'description' => 'Component version.', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'envType' => [ - 'title' => '环境类型。', - 'description' => 'Environment type.', - 'type' => 'string', - 'example' => 'CS', - ], - 'workspace' => [ - 'title' => '工作空间。', - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default', - ], - 'entityRules' => [ - 'title' => '实体详情。', - 'description' => 'Entity details.', - '$ref' => '#/components/schemas/EntityGroupBase', + 'commonSchemaRef' => [ + 'description' => 'The referenced common Umodel Schema.', + 'type' => 'array', + 'items' => [ + 'description' => 'The referenced common Umodel Schema.', + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'The common Umodel Schema group.', 'type' => 'string', 'title' => '', 'example' => 'apm-common'], + 'version' => ['description' => 'The version.', 'type' => 'string', 'title' => '', 'example' => '0.1.0'], ], + 'title' => '', + 'example' => '', ], - ], - 'requestId' => [ - 'title' => '请求 ID。', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Install Access Component', - 'description' => 'Used to create a site monitoring task', - 'translator' => 'machine', - ], - 'GetServiceObservability' => [ - 'summary' => 'Get Application Observability Instance', - 'path' => '/workspace/{workspace}/service-observability/{type}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"apm-common\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetUmodelCommonSchemaRef', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodelCommonSchemaRef'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetUmodelCommonSchemaRef', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + ], + 'GetUmodelData' => [ + 'path' => '/workspace/{workspace}/umodel/graph', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => 'CMS2.0 Workspace', - 'type' => 'string', - 'required' => true, - 'example' => 'my-test-ws', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], ], [ - 'name' => 'type', - 'in' => 'path', + 'name' => 'method', + 'in' => 'query', + 'schema' => ['description' => 'The method.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ListData'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Application Observability Type', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'rum' => '用户体验监控', - 'apm' => '应用性能监控', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The query conditions.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "filter": {'."\n" + .' "domains": []'."\n" + .' },'."\n" + .' "offset": 0,'."\n" + .' "size": 100000'."\n" + .'}'], ], - 'example' => 'apm', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '4852B9B5-345C-5CBC-A15F-786D83ECCBBA', - ], - 'type' => [ - 'description' => 'Application Observability Type', - 'type' => 'string', - 'enumValueTitles' => [ - 'rum' => 'rum', - 'apm' => 'apm', - ], - 'example' => 'apm', - ], - 'regionId' => [ - 'description' => 'Region', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'workspace' => [ - 'description' => 'Workspace Name', - 'type' => 'string', - 'example' => 'default-cms-1654218***343050-cn-hangzhou', + 'nodes' => [ + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => ['description' => 'A node.', 'type' => 'any', 'title' => '', 'example' => '{}'], + 'title' => '', + 'example' => '', ], - 'status' => [ - 'description' => 'Resource Initialization Status', - 'type' => 'string', - 'enumValueTitles' => [ - 'Running' => '正常', - ], - 'example' => 'Running', + 'links' => [ + 'description' => 'The list of links between nodes.', + 'type' => 'array', + 'items' => ['description' => 'A link between nodes.', 'type' => 'any', 'title' => '', 'example' => '{}'], + 'title' => '', + 'example' => '', ], - 'entryPointInfo' => [ - 'description' => 'Endpoint and Authentication Information', - 'type' => 'object', - 'properties' => [ - 'authToken' => [ - 'description' => 'Authentication Token for Data Reporting', - 'type' => 'string', - 'example' => 'gaddp****@de20f2***1ce***', - ], - 'publicDomain' => [ - 'description' => 'Public Network Access Address', - 'type' => 'string', - 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com', - ], - 'privateDomain' => [ - 'description' => 'Private Network Access Address', - 'type' => 'string', - 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com', - ], - 'project' => [ - 'description' => 'SLS Project', - 'type' => 'string', - 'example' => 'proj-xtrace-xxxxx', + 'totalNodesCount' => ['description' => 'The total number of nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'totalLinksCount' => ['description' => 'The total number of links between nodes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'errors' => [ + 'description' => 'The error messages.', + 'type' => 'array', + 'items' => [ + 'description' => 'The error message.', + 'type' => 'object', + 'properties' => [ + 'message' => ['description' => 'The detailed information.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'type' => ['description' => 'The type of the error.', 'type' => 'string', 'title' => '', 'example' => 'external'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'feeType' => [ - 'description' => 'Billing Type', - 'type' => 'string', - 'example' => 'arms=serverless;xtrace=serverless', - ], - 'settings' => [ - 'description' => 'System Configuration', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"trace_aggregate":"enable"}', - 'description' => 'Configuration Key-Value Pairs', - ], - ], - 'quotas' => [ - 'description' => 'Quota Configuration', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"arms_agent_hour": "48"}', - 'description' => 'Quota Configuration Keys', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '123-123-234-345-123'], ], + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Get Application Observability', - 'extraInfo' => 'settIngs系统配置支持如下：'."\n" - .'* trace_aggregate : enable / disable，用于开源探针接入场景控制是否关闭指标生成', - 'translator' => 'machine', - ], - 'DeleteService' => [ - 'summary' => 'Delete Service', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Umodel Data', + 'summary' => 'Retrieves graph data associated with a Umodel.', + 'description' => 'This operation retrieves the graph data associated with a Umodel.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodelData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetUmodelData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + '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"}]', + ], + 'GetWorkspace' => [ + 'path' => '/workspace/{workspaceName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - 'title' => '工作空间', - ], - ], - [ - 'name' => 'serviceId', + 'name' => 'workspaceName', 'in' => 'path', - 'schema' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - 'title' => '应用服务id', - ], + 'schema' => ['title' => '实例 ID。', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test-001'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '51B6A3E8-EA9E-5143-BE11-8E5F83474C95', - 'title' => '请求id', - ], + 'createTime' => ['description' => 'The time when the workspace was created.', 'type' => 'string', 'format' => 'iso8601_normal', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'description' => ['title' => '工作空间描述', 'description' => 'The description of the workspace.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'workspace test'], + 'lastModifyTime' => ['description' => 'The time when the workspace was last modified.', 'type' => 'string', 'format' => 'iso8601_normal', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'regionId' => ['title' => '地域ID', 'description' => 'The region ID.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'cn-heyuan'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'sls-project-test-001'], + 'workspaceName' => ['title' => '工作空间名称', 'description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'pattern' => '', 'default' => '', 'example' => 'workspace-test-001'], + 'displayName' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"51B6A3E8-EA9E-5143-BE11-8E5F83474C95\\"\\n}","type":"json"}]', - 'title' => 'Delete Application Observability Service', - 'translator' => 'machine', - ], - 'UpdateService' => [ - 'summary' => 'Update Service', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Workspace', + 'summary' => 'Retrieves a workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:GetWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}'], + ], + ], + ], ], + '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"}]', + ], + 'ListAddonReleases' => [ + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'workspace', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - 'title' => '工作空间', - ], + 'schema' => ['title' => '策略环境 ID。', 'description' => 'The policy environment ID.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], ], [ - 'name' => 'serviceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - 'title' => '应用资源id', - ], + 'name' => 'addonName', + 'in' => 'query', + 'schema' => ['title' => '组件 Addon 名称。', 'description' => 'The name of the add-on.', 'type' => 'string', 'required' => false, 'example' => 'cs-gpu'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request body parameters.', - 'type' => 'object', - 'properties' => [ - 'displayName' => [ - 'description' => 'Display name, only valid when serviceType=RUM.', - 'type' => 'string', - 'required' => false, - 'example' => 'api-monitor-test', - 'title' => '别名', - ], - 'description' => [ - 'description' => 'Service description, only valid when serviceType=RUM.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'title' => '应用描述信息。', - ], - 'attributes' => [ - 'description' => 'Extended attributes.', - 'type' => 'string', - 'required' => false, - 'example' => '{"language":"java"}', - 'title' => '特征信息，key:value格式', - ], - 'serviceStatus' => [ - 'description' => 'Service status, only valid when serviceType=RUM.', - 'type' => 'string', - 'required' => false, - 'example' => 'Stopped', - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - ], - ], - 'required' => false, - 'title' => '应用服务', - ], + 'name' => 'parentAddonReleaseId', + 'in' => 'query', + 'schema' => ['title' => '父级 AddonReleaseId。', 'description' => 'The parent AddonRelease ID.', 'type' => 'string', 'required' => false, 'example' => 'policy-xxxxxxxxxxxxx'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '123-0F43-23423-AC43-34234', - 'title' => '请求id', - ], - 'serviceId' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'example' => 'em87vd@c2e25bcfe0e21ce0***', - 'title' => '应用服务id', + 'releases' => [ + 'description' => 'The list of add-on releases.', + 'type' => 'array', + 'items' => [ + 'description' => 'An add-on release.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['title' => 'Addon 名称。', 'description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'cs-gpu'], + 'alertRuleCount' => ['title' => '告警规则数量。', 'description' => 'The number of alert rules.', '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' => 'The conditions of the release.', + 'type' => 'array', + 'items' => [ + 'description' => 'A condition of the release.', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['title' => '第一次转换时间。', 'description' => 'The timestamp of the first status transition.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'lastTransitionTime' => ['title' => '最后一次转换时间。', 'description' => 'The timestamp of the last status transition.', 'type' => 'string', 'example' => '2024-11-04T16:10:22+08:00'], + 'message' => ['title' => '详细信息。', 'description' => 'A detailed message about the status.', 'type' => 'string', 'example' => 'The addon loaded successfully'], + 'status' => ['title' => '阶段状态。', 'description' => 'The status of the condition.', 'type' => 'string', 'example' => 'True'], + 'type' => ['title' => '阶段类型。', 'description' => 'The type of the condition.', 'type' => 'string', 'example' => 'Loaded'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'config' => ['title' => '组件配置信息。', 'description' => 'The configuration of the add-on.', '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' => 'The installation time of the add-on.', 'type' => 'string', 'example' => '2024-11-04T16:10:12+08:00'], + 'dashboardCount' => ['title' => '大盘数量。', 'description' => 'The number of dashboards.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'environmentId' => ['title' => '环境 ID。', 'description' => 'The environment ID.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxx'], + 'exporterCount' => ['title' => '插件数量。', 'description' => 'The number of exporters.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'haveConfig' => ['title' => '是否有配置。', 'description' => 'Indicates whether a configuration exists.', 'type' => 'boolean', 'example' => 'true'], + 'installUserId' => ['title' => '接入用户 ID。', 'description' => 'The ID of the user who installed the add-on.', 'type' => 'string', 'example' => '175xxxxxxxxx'], + 'language' => ['title' => '语言。', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], + 'managed' => ['title' => '是否为托管组件。', 'description' => 'Indicates whether the add-on is managed.', 'type' => 'boolean', 'example' => 'true'], + 'parentAddonReleaseId' => ['title' => '父级 AddonReleaseId。', 'description' => 'The ID of the parent release.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxxx'], + 'policyId' => ['title' => '策略 ID。', 'description' => 'The policy ID.', 'type' => 'string', 'example' => 'policy-xxxxxxxxxxxxxx'], + 'regionId' => ['title' => '区域 ID。', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'releaseId' => ['title' => 'Release ID。', 'description' => 'The release ID.', 'type' => 'string', 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx'], + 'releaseName' => ['title' => 'Release 名称。', 'description' => 'The release name.', 'type' => 'string', 'example' => 'test-gpu-integration-name'], + 'scene' => ['title' => '组件场景。', 'description' => 'The usage scenario of the add-on.', 'type' => 'string', 'example' => 'container'], + 'status' => ['title' => '状态。', 'description' => 'The status of the release.', 'type' => 'string', 'example' => 'running'], + 'updateTime' => ['title' => '更新时间。', 'description' => 'The last update time.', 'type' => 'string', 'example' => '2024-11-04T16:10:23+08:00'], + 'userId' => ['title' => '所属用户 ID。', 'description' => 'The ID of the owner.', 'type' => 'string', 'example' => '175xxxxxxxxxxxxx'], + 'version' => ['title' => '组件版本。', 'description' => 'The version of the add-on.', 'type' => 'string', 'example' => '0.0.2'], + 'envType' => ['title' => '环境类型。', 'description' => 'The environment type.', 'type' => 'string', 'example' => 'CS'], + 'workspace' => ['title' => '工作空间。', 'description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'default'], + 'subAddonRelease' => [ + 'title' => '子AddonRelease的统计信息', + 'description' => 'Statistics about sub-releases.', + 'type' => 'object', + 'properties' => [ + 'ready' => ['title' => '已就绪的子Release数量', 'description' => 'The number of ready sub-releases.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'total' => ['title' => '子Release数量', 'description' => 'The total number of sub-releases.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], + 'example' => '', + ], + 'nextVersion' => ['description' => 'The next available version of the add-on.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'entityRules' => ['title' => '实体详情。', 'description' => 'Details of the entity rules.', '$ref' => '#/components/schemas/EntityGroupBase', 'example' => ''], + 'apiVersion' => ['description' => 'The API version.', 'type' => 'string', 'example' => '2023-03-30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '请求 ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'total' => ['title' => '组件数量。', 'description' => 'The total number of add-on releases that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'nextToken' => ['description' => 'A pagination token to retrieve the next page of results. If this field is empty, no more results are available.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'View Add-on Component List', + 'summary' => 'Lists the releases for an add-on.', + 'description' => 'This operation retrieves a list of integration configurations.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddonReleases'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListAddonReleases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"serviceId\\": \\"em87vd@c2e25bcfe0e21ce0***\\"\\n}","type":"json"}]', - 'title' => 'Update Application Observability Service', - 'translator' => 'machine', + '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\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"acs.ecs.instance\\",\\n \\"spl\\": \\".entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')\\"\\n }\\n ],\\n \\"description\\": \\"ECS 实例\\",\\n \\"entityGroupId\\": \\"eg-1234567890\\",\\n \\"entityRules\\": {\\n \\"resourceGroupId\\": \\"rg-acfm2m7atreujs1\\",\\n \\"ipMatchRule\\": {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n },\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"project\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ],\\n \\"entityTypes\\": [\\n \\"acs.ecs.instance\\"\\n ],\\n \\"regionIds\\": [\\n \\"cn-shanghai\\"\\n ],\\n \\"labels\\": [\\n {\\n \\"tagKey\\": \\"project\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"demo\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"tagKey\\": \\"instanceId\\",\\n \\"op\\": \\"in\\",\\n \\"tagValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\\\n\\"\\n ]\\n }\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"instanceId\\",\\n \\"op\\": \\"in\\",\\n \\"fieldValues\\": [\\n \\"i-bp1gj8wyq4fxk28k6iy2\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"ECS 全部实体\\",\\n \\"userId\\": \\"1654218***343050\\"\\n },\\n \\"apiVersion\\": \\"2023-03-30\\"\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"total\\": 1,\\n \\"nextToken\\": \\"\\"\\n}","type":"json"}]', ], - 'GetService' => [ - 'summary' => 'Query Service', - 'path' => '/workspace/{workspace}/service/{serviceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAddons' => [ + 'summary' => 'Lists the products in the new Integration Center by group.', + 'path' => '/addons', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - 'title' => '工作空间', - ], + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Valid values: zh and en. The default value is zh.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'zh'], ], [ - 'name' => 'serviceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - 'title' => '应用服务id', - ], + 'name' => 'category', + 'in' => 'query', + 'schema' => ['description' => 'Tag filtering.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'database'], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The search keyword. You can search for add-ons by name, description, or keyword.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '105095'], + ], + [ + 'name' => 'regexp', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use regular expressions for the search. The default value is false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -15155,431 +13800,412 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', - 'title' => '请求id', - ], - 'service' => [ - 'description' => 'Service object.', - 'type' => 'object', - 'properties' => [ - 'serviceId' => [ - 'description' => 'Service ID.', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'."\n", - 'title' => '应用服务id', - ], - 'serviceName' => [ - 'description' => 'Service name', - 'type' => 'string', - 'example' => 'demo-app', - 'title' => '应用资源名称', - ], - 'createTime' => [ - 'description' => 'Creation time', - 'type' => 'string', - 'example' => '2025-05-13T03:32:55Z', - 'title' => '创建时间', - ], - 'serviceType' => [ - 'description' => 'Service type.', - 'type' => 'string', - 'enumValueTitles' => [ - 'TRACE' => 'TRACE', - 'RUM' => 'RUM', - 'XTRACE' => 'XTRACE', + 'addons' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'alias' => ['description' => 'The alias of the add-on.', 'type' => 'string', 'example' => 'resume_vector_alias', 'title' => ''], + 'categories' => [ + 'type' => 'array', + 'items' => ['description' => 'Tag.', 'type' => 'string', 'example' => 'middleware', 'title' => ''], + 'description' => 'A list of tags for the add-on.', + 'title' => '', + 'example' => '', ], - 'example' => 'TRACE', - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', - ], - 'serviceStatus' => [ - 'description' => 'Service status, only valid when serviceType=RUM.', - 'type' => 'string', - 'example' => 'Running', - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - ], - 'displayName' => [ - 'description' => 'Display name, only valid when serviceType=RUM.', - 'type' => 'string', - 'example' => 'demo应用', - 'title' => '别名', - ], - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-heyuan', - 'title' => '地域 ID。', - ], - 'workspace' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'example' => 'default-cms-1106439496876715-cn-hangzhou', - 'title' => '工作空间', - ], - 'pid' => [ - 'description' => 'Legacy ARMS application ID', - 'type' => 'string', - 'example' => 'by6rjzro2j@0fe8dfa799e5906', - 'title' => '对应ARMS应用pid', - ], - 'description' => [ - 'description' => 'Description, only valid when serviceType=RUM.', - 'type' => 'string', - 'example' => 'test', - 'title' => '应用描述信息。', - ], - 'attributes' => [ - 'description' => 'Extended information.', - 'type' => 'string', - 'example' => '{"language":"java"}', - 'title' => '特征信息，key:value格式', - ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'type' => 'string', - 'example' => 'rg-aekxxzuad5zzzz', - ], - 'tags' => [ - 'title' => '标签数组', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'type' => 'string', - 'example' => 'env', + 'dashboards' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Dashboard description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'name' => ['description' => 'Dashboard name.', 'type' => 'string', 'example' => 'rum_view_link_rum_api', 'title' => ''], + 'url' => ['description' => 'The URL of the dashboard\'s preview image.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], ], - 'value' => [ - 'title' => '标签value', - 'type' => 'string', - 'example' => 'prod', + 'description' => 'Dashboard information.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of dashboards.', + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'Description', 'type' => 'string', 'example' => 'workspace api monitor test', 'title' => ''], + 'environments' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'dependencies' => [ + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'type' => 'array', + 'items' => ['description' => 'Cluster type.', 'type' => 'string', 'example' => 'ManagedKubernetes/Default', 'title' => ''], + 'description' => 'Supported cluster types.', + 'title' => '', + 'example' => '', + ], + 'features' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'Indicates whether the feature is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'description' => 'The probes on which the integration depends.', + 'title' => '', + 'example' => '', + ], + 'services' => [ + 'type' => 'array', + 'items' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'Prometheus', 'title' => ''], + 'description' => 'A list of dependent services.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A list of dependencies for the add-on.', + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The description of the integration policy type.', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan', 'title' => ''], + 'enable' => ['description' => 'Indicates whether the add-on is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'label' => ['description' => 'The label of the integration policy type.', 'type' => 'string', 'example' => '容器环境', 'title' => ''], + 'name' => ['description' => 'The name of the integration policy type.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'policies' => [ + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => ['description' => 'The default status of the alert rule policy.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'defaultInstall' => ['description' => 'Indicates whether the add-on is installed by default.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'enableServiceAccount' => ['description' => 'Indicates whether to assign a Service Account to communicate with the Console API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'metricCheckRule' => [ + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'type' => 'array', + 'items' => ['description' => 'A PromQL statement.', 'type' => 'string', 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', 'title' => ''], + 'description' => 'A list of Prometheus Query Language (PromQL) statements.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Metric check rule.', + 'title' => '', + 'example' => '', + ], + 'needRestartAfterIntegration' => ['description' => 'Indicates whether to guide the user to restart pods after the add-on is installed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'protocols' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Protocol description.', 'type' => 'string', 'example' => 'Support OpenTelemetry Protocal', 'title' => ''], + 'icon' => ['description' => 'Icon URL.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], + 'label' => ['description' => 'Protocol display name.', 'type' => 'string', 'example' => 'OpenTelemetry', 'title' => ''], + 'name' => ['description' => 'Protocol name.', 'type' => 'string', 'example' => 'openTelemetry', 'title' => ''], + ], + 'description' => 'The details of a supported protocol type.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The supported protocol types.', + 'title' => '', + 'example' => '', + ], + 'targetAddonName' => ['description' => 'The name of the target add-on.', 'type' => 'string', 'example' => 'cloud-acs-ecs', 'title' => ''], + ], + 'description' => 'Integration policy configuration.', + 'title' => '', + 'example' => '', + ], + 'policyType' => ['description' => 'Integration Center policy type.', 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'commonSchemaRefs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'group' => ['description' => 'The group name of the Common Schema.', 'type' => 'string', 'example' => 'acs-ecs', 'title' => ''], + 'version' => ['description' => 'The version of the Common Schema.', 'type' => 'string', 'example' => '0.1.4', 'title' => ''], + ], + 'description' => 'The information about an associated Common Schema.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of associated Common Schemas.', + 'title' => '', + 'example' => '', + ], ], + 'description' => 'Integration policy type information.', + 'title' => '', + 'example' => '', ], + 'description' => 'A list of supported integration policy types.', + 'title' => '', + 'example' => '', + ], + 'icon' => ['description' => 'The URL of the icon.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], + 'keywords' => [ + 'type' => 'array', + 'items' => ['description' => 'Keyword.', 'type' => 'string', 'example' => 'Container', 'title' => ''], + 'description' => 'A list of keywords.', + 'title' => '', + 'example' => '', ], + 'language' => ['description' => 'Language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'latestReleaseCreateTime' => ['description' => 'The time when the latest version was created.', 'type' => 'string', 'example' => '2025-09-03T03:15:56Z', 'title' => ''], + 'name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'rum_api_dashboard_explorer_link_metric_set', 'title' => ''], + 'once' => ['description' => 'Indicates whether the add-on can be installed only once.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'scene' => ['description' => 'The scenario of the component.', 'type' => 'string', 'example' => 'middleware', 'title' => ''], + 'version' => ['description' => 'The version of the component.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'weight' => ['description' => 'The display weight of the add-on.', 'type' => 'string', 'example' => '99', 'title' => ''], ], + 'description' => 'The details of the add-on.', + 'title' => '', + 'example' => '', ], - 'title' => '应用服务', + 'description' => 'A list of available add-ons.', + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidService.NotFound', - 'errorMessage' => 'The specified Service does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAddons', + 'description' => 'Creates a site monitoring job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListAddons', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'Query Application Observability Service', - 'translator' => 'machine', + '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"}]', ], - 'CreateService' => [ - 'summary' => 'Create Service', - 'path' => '/workspace/{workspace}/service', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListAggTaskGroups' => [ + 'summary' => 'Queries the list of aggregation task groups.', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request body.', - 'type' => 'object', - 'properties' => [ - 'serviceName' => [ - 'description' => 'Service name', - 'type' => 'string', - 'required' => true, - 'example' => 'mag_test', - 'title' => '应用资源名称', - ], - 'serviceType' => [ - 'description' => 'Service type', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'TRACE' => '应用性能监控', - 'RUM' => '用户体验监控', - 'XTRACE' => 'OpenTelemtry链路追踪', - ], - 'example' => 'TRACE', - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', - ], - 'displayName' => [ - 'description' => 'Display name, only valid when `serviceType=RUM`.', - 'type' => 'string', - 'required' => false, - 'example' => 'mag测试应用', - 'title' => '别名', - ], - 'description' => [ - 'description' => 'Service description, only valid when `serviceType=RUM`.', - 'type' => 'string', - 'required' => false, - 'example' => 'mag测试应用', - 'title' => '应用描述信息。', - ], - 'attributes' => [ - 'description' => 'Extended attributes.', - 'type' => 'string', - 'required' => false, - 'example' => '{"language":"java"}', - 'title' => '特征信息，key:value格式', - ], - 'serviceStatus' => [ - 'description' => 'Service status, not required for service creation.', - 'type' => 'string', - 'required' => false, - 'example' => 'Created', - 'title' => '应用体验监控的服务状态，Running/Stopped/Created/Suspend', - ], - 'pid' => [ - 'description' => 'Application ID, generally not required to be specified.', - 'type' => 'string', - 'required' => false, - 'example' => 'bx3udsi5ie@ed2ba6beebdb6de', - 'title' => '对应ARMS应用pid', - ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'type' => 'string', - 'example' => 'rg-xxekxxzuad5zzzz', - ], - 'tags' => [ - 'title' => '标签数组', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'type' => 'string', - 'example' => 'env', - ], - 'value' => [ - 'title' => '标签value', - 'type' => 'string', - 'example' => 'prod', - ], - ], - ], - ], - ], + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The instance ID of the Managed Service for Prometheus instance to which the aggregation node group belongs. The aggregation node reads data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'filterAggTaskGroupIds', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The list of aggregation task group IDs. The value must be a JSON-parsable string.', 'type' => 'string', 'example' => '["aggTaskGroup-xxx"]', 'required' => false], + ], + [ + 'name' => 'filterAggTaskGroupNames', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The list of aggregation task group names. The value must be a JSON-parsable string.', 'type' => 'string', 'example' => '["apiserver_request_total"]', 'required' => false], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The status of the aggregation task group. Valid values:'."\n" + ."\n" + .'- Running'."\n" + .'- Stopped'."\n" + ."\n" + .'Default value: Running.', + 'enumValueTitles' => ['Stopped' => 'Disabled.', 'Running' => 'Enabled.'], + 'type' => 'string', + 'example' => 'Running', + 'enum' => ['Running', 'Stopped'], 'required' => false, ], ], [ - 'name' => 'workspace', - 'in' => 'path', + 'name' => 'targetPrometheusId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The instance ID of the target Managed Service for Prometheus instance for the aggregation node group.', 'type' => 'string', 'example' => 'rw-pq4apob9jm', 'required' => false], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'default-cms-1793369865235921-cn-shenzhen', - 'title' => '工作空间', + 'title' => '', + 'description' => 'The resource group tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource group tags.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '', 'description' => 'The key of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '', 'description' => 'The value of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '20', 'required' => false], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The query token.', 'type' => 'string', 'maxLength' => 128, 'required' => false, 'example' => '28036394xxx'], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name to search for. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '3A2FA9E9-9CF1-5CB1-A808-52828F14310D', - 'title' => '请求id', - ], - 'serviceId' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', - 'title' => '应用服务id', - ], - 'pid' => [ - 'description' => 'Historical compatible ARMS application ID', - 'type' => 'string', - 'example' => 'cwzxvuc6uo@d60088ad4797d26', - 'title' => '对应ARMS应用pid', + 'aggTaskGroups' => [ + 'title' => '', + 'description' => 'The list of aggregation task groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The aggregation task.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => ['title' => '', 'description' => 'The hash of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136014xxx'], + 'aggTaskGroupId' => ['title' => '', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'example' => 'aggTaskGroup-xxxx'], + 'aggTaskGroupName' => ['title' => '', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'cronExpr' => ['title' => '', 'description' => 'The cron expression of the aggregation task group when the scheduling mode is set to Cron.', 'type' => 'string', 'example' => '0 10 8 1 * ? *'], + 'delay' => ['title' => '', 'description' => 'The fixed scheduling delay, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'description' => ['title' => '', 'description' => 'The description of the aggregation task group.', 'type' => 'string', 'example' => 'workspace api monitor update test'], + 'fromTime' => ['title' => '', 'description' => 'The UNIX timestamp that indicates the scheduling start time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757409499000'], + 'interval' => ['title' => '', 'description' => 'The scheduling interval.', 'type' => 'string', 'example' => '2025-04-24 00:00:00,2025-04-24 00:00:00'], + 'maxRetries' => ['title' => '', 'description' => 'The maximum number of retries for executing the aggregation task.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'maxRunTimeInSeconds' => ['title' => '', 'description' => 'The maximum retry time for executing the aggregation task, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'regionId' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'scheduleMode' => ['title' => '', 'description' => 'The scheduling mode.', 'type' => 'string', 'example' => 'FixedRate'], + 'scheduleTimeExpr' => ['title' => '', 'description' => 'The schedule time expression.', 'type' => 'string', 'example' => '@m'], + 'sourcePrometheusId' => ['title' => '', 'description' => 'The instance ID of the source Managed Service for Prometheus instance for the aggregation node group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '', 'description' => 'The status of the aggregation task group.', 'type' => 'string', 'example' => 'Running'], + 'targetPrometheusId' => ['title' => '', 'description' => 'The instance ID of the target Managed Service for Prometheus instance for the aggregation node group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'toTime' => ['title' => '', 'description' => 'The UNIX timestamp that indicates the scheduling end time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'updateTime' => ['title' => '', 'description' => 'The time when the aggregation task group was last updated, in UNIX timestamp format.', 'type' => 'string', 'example' => '1757409499000'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '0'], + 'nextToken' => ['title' => '', 'description' => 'The token for the next query.', 'type' => 'string', 'maxLength' => 128, 'example' => 'aa9d0e569b880xxx'], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E'], + 'totalCount' => ['title' => '', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], ], + 'example' => '', ], ], ], - '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' => 'Create Application Observability Service', - 'requestParamsDescription' => 'Extended attributes `attributes`,'."\n" - .'when `serviceType=TRACE`, optional attribute `language` with possible values being java/python/golang;'."\n" - .'when `serviceType=XTRACE`, optional attribute `language` with possible values referring to open-source values at https://opentelemetry.io/docs/specs/semconv/registry/attributes/telemetry/.', - 'translator' => 'machine', - ], - 'ListServices' => [ - 'summary' => 'List Resource Services', - 'path' => '/workspace/{workspace}/services', - 'methods' => [ - 'get', + '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"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => 'Query aggregation task groups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAggTaskGroups'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'ListAlertActions' => [ + 'path' => '/alertActions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'Token for the next query, an empty value indicates the last page.', - 'type' => 'string', - 'required' => false, - 'example' => '7-b81a-4bc9-bbfa-a50cc6988667', - 'title' => '翻页的 token，从 NextToken 开始按字典序返回文件信息列表。第一次调用此接口时，设置为空。', - ], - ], - [ - 'name' => 'maxResults', + 'name' => 'alertActionIds', 'in' => 'query', - 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => 'The maximum number of records to return in this request.', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The unique IDs of the alert action integrations.', + 'type' => 'array', + 'items' => ['description' => 'The unique ID of the alert action integration.', 'type' => 'string', 'required' => false, 'example' => 'testId', 'title' => ''], 'required' => false, - 'example' => '10', - 'title' => '查询一页数量，最大500。', - 'maximum' => '500', - 'minimum' => '0', - 'exclusiveMinimum' => false, - ], - ], - [ - 'name' => 'workspace', - 'in' => 'path', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace-test', - 'title' => '工作空间', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'serviceType', + 'name' => 'type', 'in' => 'query', 'schema' => [ - 'description' => 'Service type', + 'description' => 'The type of the alert action integration.', 'type' => 'string', + 'enum' => ['FC', 'MNS', 'OPEN_API', 'SLS', 'ESS', 'PAGER_DUTY', 'WEBHOOK', 'EB', 'FC3'], 'required' => false, - 'example' => 'apm', - 'enum' => [ - 'TRACE', - 'XTRACE', - 'RUM', - ], - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', + 'example' => 'FC', + 'title' => '', ], ], [ - 'name' => 'serviceName', + 'name' => 'alertActionName', 'in' => 'query', - 'schema' => [ - 'title' => '应用服务名称', - 'type' => 'string', - 'example' => 'app-demo', - ], + 'schema' => ['description' => 'The name of the alert action integration.', 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''], ], [ - 'name' => 'resourceGroupId', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '资源组id', - 'type' => 'string', - 'example' => 'rg-aekxxzuad5zzzz', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'tags', + 'name' => 'pageSize', 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'json', - 'schema' => [ - 'title' => '标签数组', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签key', - 'type' => 'string', - 'example' => 'evn', - ], - 'value' => [ - 'title' => '标签value', - 'type' => 'string', - 'example' => 'prod', - ], - ], - ], - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ @@ -15587,2547 +14213,1817 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - 'title' => '请求 ID。', - ], - 'nextToken' => [ - 'description' => 'Pagination token', - 'type' => 'string', - 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', - 'title' => '分页标识。返回值 nextToken 非空代表还有剩余数据。把 nextToken 作为参数继续查询会获得下一页。', - ], - 'totalCount' => [ - 'description' => 'Total count', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - 'title' => '总应用服务数量', - ], - 'maxResults' => [ - 'description' => 'Maximum number of results to return, with a maximum value of 200', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '查询一页数量。', - ], - 'services' => [ - 'description' => 'List of service information.', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], + 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'alertActions' => [ + 'description' => 'The list of alert action integration configurations.', 'type' => 'array', 'items' => [ - 'description' => 'Service information.', + 'description' => 'The list of alert action integration configurations.', 'type' => 'object', 'properties' => [ - 'serviceId' => [ - 'description' => 'Service ID', - 'type' => 'string', - 'example' => 'jm2pl0yoqf@d4905cb11a4f218dfb0a8', - 'title' => '应用服务id', - ], - 'serviceName' => [ - 'description' => 'Service name', - 'type' => 'string', - 'example' => 'demo-app', - 'title' => '应用资源名称', - ], - 'createTime' => [ - 'description' => 'Creation time', - 'type' => 'string', - 'example' => '2025-07-01T02:23:59Z', - 'title' => '创建时间', - ], - 'serviceType' => [ - 'description' => 'Service type', - 'type' => 'string', - 'example' => 'TRACE', - 'title' => '类型：TRACE（应用监控）/ RUM（用户体验监控）/ XTRACE（OT版）', + 'alertActionId' => ['description' => 'The unique ID of the alert action integration.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'mnsParam' => [ + 'description' => 'The parameters of Simple Message Queue (formerly MNS).', + 'type' => 'object', + 'properties' => [ + 'mnsType' => ['description' => 'The resource type of Simple Message Queue (formerly MNS).', 'type' => 'string', 'example' => 'queue', 'title' => ''], + 'name' => ['description' => 'The name of the resource.'."\n" + ."\n" + .'- If the resource type is \\`queue\\`, this parameter specifies the queue name.'."\n" + ."\n" + .'- If the resource type is \\`topic\\`, this parameter specifies the topic name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'serviceStatus' => [ - 'description' => 'Service status, valid only when serviceType=RUM.', - 'type' => 'string', - 'example' => 'Running', - 'title' => '应用体验监控的服务状态，running/stopped/created/suspend', + 'type' => ['description' => 'The type of the alert action integration.', 'type' => 'string', 'example' => 'FC', 'title' => ''], + 'slsParam' => [ + 'description' => 'The parameters of Simple Log Service.', + 'type' => 'object', + 'properties' => [ + 'logstore' => ['description' => 'The name of the Simple Log Service Logstore.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'project' => ['description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'displayName' => [ - 'description' => 'Display name, valid only when serviceType=RUM.', - 'type' => 'string', - 'example' => 'test', - 'title' => '别名', + 'alertActionName' => ['description' => 'The name of the alert action integration.', 'type' => 'string', 'example' => 'testName', 'title' => ''], + 'essParam' => [ + 'description' => 'The parameters of Auto Scaling.', + 'type' => 'object', + 'properties' => [ + 'essGroupId' => ['description' => 'The ID of the Auto Scaling group.', 'type' => 'string', 'example' => 'testId', 'title' => ''], + 'essRuleId' => ['description' => 'The ID of the scaling rule.', 'type' => 'string', 'example' => 'testId', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'pid' => [ - 'description' => 'Historical compatible ARMS application ID', - 'type' => 'string', - 'example' => 'kgcsf@192197e828d51aa', - 'title' => '对应ARMS应用pid', + 'fcParam' => [ + 'description' => 'The parameters of Function Compute.', + 'type' => 'object', + 'properties' => [ + 'function' => ['description' => 'The function name of the Function Compute service.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'service' => ['description' => 'The service name of Function Compute.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'description' => [ - 'description' => 'Service description, valid only when serviceType=RUM.', - 'type' => 'string', - 'example' => 'workspace api monitor test', - 'title' => '应用描述信息。', + 'pagerDutyParam' => [ + 'description' => 'The PagerDuty parameters.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The integration key of PagerDuty.', 'type' => 'string', 'example' => 'fsfer4543t5t65g4t4', 'title' => ''], + 'url' => ['description' => 'The integration webhook of PagerDuty. Versions 1 and 2 are supported.', 'type' => 'string', 'example' => 'https://events.pagerduty.com/v2/enqueue', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'attributes' => [ - 'description' => 'Extended information.', - 'type' => 'string', - 'example' => '{"language":"java"}', - 'title' => '特征信息，key:value格式', + 'webhookParam' => [ + 'description' => 'The webhook parameters.', + 'type' => 'object', + 'properties' => [ + 'method' => ['description' => 'The request method of the webhook.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'url' => ['description' => 'The callback URL for alerts.', 'type' => 'string', 'example' => 'http://www.test.com', 'title' => ''], + 'contentType' => ['description' => 'The data format. This parameter is valid only when the request method is POST.', 'type' => 'string', 'example' => 'JSON', 'title' => ''], + 'headers' => [ + 'description' => 'The request headers.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The request headers.', 'type' => 'string', 'example' => '{\'X-Total-Count\': 0}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'workspace' => [ - 'description' => 'Workspace.', - 'type' => 'string', - 'example' => 'default-cms-1192928460540589-cn-hangzhou', - 'title' => '工作空间', + 'fc3Param' => [ + 'description' => 'The parameters of Function Compute 3.0.', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'function' => ['description' => 'The function name of the Function Compute service.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'qualifier' => ['description' => 'The version or alias of the function.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'resourceGroupId' => [ - 'title' => '资源组id', - 'type' => 'string', - 'example' => 'rg-aekxxzuad5zzzz', + 'ebParam' => [ + 'description' => 'Specifies the event bus.', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'eventBusName' => ['description' => 'The name of the event bus.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'subject' => ['description' => 'The subject.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ebSource' => ['description' => 'The event provider.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'title' => '应用服务', + 'title' => '', + 'example' => '', ], - 'title' => '应用服务列表', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Alert Action Integration', + 'summary' => 'Queries alert action integrations.', + 'changeSet' => [ + ['createdAt' => '2025-07-01T06:49:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-11-04T06:29:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlertActions'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListAlertActions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AlertAction', 'arn' => 'acs:cms:{#regionId}:{#accountId}:alertaction/*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 9,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 100,\\n \\"alertActions\\": [\\n {\\n \\"alertActionId\\": \\"test\\",\\n \\"mnsParam\\": {\\n \\"mnsType\\": \\"queue\\",\\n \\"name\\": \\"test\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"type\\": \\"FC\\",\\n \\"slsParam\\": {\\n \\"logstore\\": \\"test\\",\\n \\"project\\": \\"test\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"alertActionName\\": \\"testName\\",\\n \\"essParam\\": {\\n \\"essGroupId\\": \\"testId\\",\\n \\"essRuleId\\": \\"testId\\",\\n \\"regionId\\": \\"cn-beijing\\"\\n },\\n \\"fcParam\\": {\\n \\"function\\": \\"test\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"service\\": \\"test\\"\\n },\\n \\"pagerDutyParam\\": {\\n \\"key\\": \\"fsfer4543t5t65g4t4\\",\\n \\"url\\": \\"https://events.pagerduty.com/v2/enqueue\\"\\n },\\n \\"webhookParam\\": {\\n \\"method\\": \\"GET\\",\\n \\"url\\": \\"http://www.test.com\\",\\n \\"contentType\\": \\"JSON\\",\\n \\"headers\\": {\\n \\"key\\": \\"{\'X-Total-Count\': 0}\\"\\n }\\n },\\n \\"fc3Param\\": {\\n \\"regionId\\": \\"cn-qingdao\\",\\n \\"function\\": \\"test\\",\\n \\"qualifier\\": \\"test\\"\\n },\\n \\"ebParam\\": {\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"eventBusName\\": \\"test\\",\\n \\"subject\\": \\"test\\",\\n \\"ebSource\\": \\"test\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListAlertRobots' => [ + 'summary' => 'Queries alert chatbots.', + 'path' => '/robots', + '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' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'robotIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The chatbot ID.', + 'type' => 'array', + 'items' => ['description' => 'The chatbot ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - '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' => 'Batch Query Application Observability Services', - 'translator' => 'machine', - ], - 'CreatePrometheusVirtualInstance' => [ - 'summary' => 'Create Prometheus Monitoring Instance', - 'path' => '/virtual-instances', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The chatbot name. Prefix fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], - ], - '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', + 'name' => 'types', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Request body', - 'type' => 'object', - 'properties' => [ - 'namespace' => [ - 'title' => '每个云产品在每个Regin只能创建一个虚拟实例', - 'description' => 'Each cloud product can only create one virtual instance in each region.', - 'type' => 'string', - 'required' => true, - 'example' => 'cms_prometheus', - ], + 'description' => 'The chatbot type.', + 'type' => 'array', + 'items' => [ + 'description' => 'The chatbot type.', + 'type' => 'string', + 'enum' => ['DING', 'WEIXIN', 'FEISHU', 'SLACK'], + 'required' => false, + 'example' => 'DING', + 'title' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response body structure.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-************', - ], - 'instance' => [ - 'title' => '实例ID', - 'description' => 'Instance ID', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'title' => '地域ID', - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'rw-e815960b4c9ebc5c3d89790c7e82', - ], - 'regionId' => [ - 'title' => '用户ID', - 'description' => 'User ID', - 'type' => 'string', - 'example' => 'cn-zhengzhou-jva', - ], - 'userId' => [ - 'title' => '用户ID', - 'description' => 'User ID', - 'type' => 'string', - 'example' => '167212345678', - ], - 'namespace' => [ - 'title' => '云产品', - 'description' => 'Cloud product', - 'type' => 'string', - 'example' => 'ack-csi-fuse', - ], - 'httpApiUrl' => [ - 'title' => 'HTTP API查询地址', - 'description' => 'HTTP API query address', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'createdAt' => [ - 'title' => '创建时间', - 'description' => 'Creation time', - 'type' => 'string', - 'example' => '1751520976660', + 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'robots' => [ + 'description' => 'The chatbot ID.', + 'type' => 'array', + 'items' => [ + 'description' => 'The chatbot ID.', + 'type' => 'object', + 'properties' => [ + 'lang' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh_CN', 'title' => ''], + 'name' => ['description' => 'The chatbot name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'robotId' => ['description' => 'The unique ID of the chatbot.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'type' => ['description' => 'The chatbot type.', 'type' => 'string', 'example' => 'DING', 'title' => ''], + 'url' => ['description' => 'The webhook URL of the chatbot.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=*******', 'title' => ''], + 'workspace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'digitalEmployeeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'robotSignKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - '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' => 'Create Prometheus Monitoring Virtual Instance', - 'description' => 'Create a Prometheus monitoring virtual instance.', - 'translator' => 'machine', - ], - 'ListPrometheusVirtualInstances' => [ - 'summary' => 'Get Prometheus Virtual Instance', - 'path' => '/virtual-instances', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"robots\\": [\\n {\\n \\"lang\\": \\"zh_CN\\",\\n \\"name\\": \\"test\\",\\n \\"robotId\\": \\"test\\",\\n \\"type\\": \\"DING\\",\\n \\"url\\": \\"https://oapi.dingtalk.com/robot/send?access_token=*******\\",\\n \\"workspace\\": \\"\\",\\n \\"digitalEmployeeName\\": \\"\\",\\n \\"robotSignKey\\": \\"\\"\\n }\\n ],\\n \\"total\\": 3\\n}","type":"json"}]', + 'title' => 'Query alert chatbots', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListAlertRobots', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AlertRobot', 'arn' => 'acs:cms:{#regionId}:{#accountId}:robot/{#robotId}'], + ], + ], + ], ], + ], + 'ListAlertWebhooks' => [ + 'path' => '/webhooks', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'namespace', + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'webhookIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '可选云产品', - 'description' => 'Optional cloud product', - 'type' => 'string', + 'description' => 'The unique ID of the webhook.', + 'type' => 'array', + 'items' => ['description' => 'The unique ID of the webhook.', 'type' => 'string', 'required' => false, 'example' => 'wh-def456uvw012', 'title' => ''], 'required' => false, - 'example' => 'ack-csi-fuse', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the webhook.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The structure of the response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'instances' => [ - 'description' => 'Instance information.', + 'pageNumber' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8A33DBEA-*****-*****-*****-*****'], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'webhooks' => [ + 'description' => 'The webhooks.', 'type' => 'array', 'items' => [ - 'description' => 'Instance information.', + 'description' => 'The webhook.', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => 'Applicable data source type: PROMETHEUS_DS'."\n" - ."\n" - .'Prometheus instance ID', - 'type' => 'string', - 'example' => 'rw-b8cfbbe94194ac37fe83f3d2d16a', - ], - 'httpApiUrl' => [ - 'description' => 'HTTP API URL.', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '17073812345', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-shanghai-cloudspe', - ], - 'namespace' => [ - 'description' => 'Applicable query type: CMS_BASIC_QUERY.'."\n" - ."\n" - .'Namespace of the metric', - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'createdAt' => [ - 'description' => 'Creation time', - 'type' => 'string', - 'example' => '1750315319946', - ], + 'contentType' => ['description' => 'The content type of the data. Valid values:'."\n" + ."\n" + .'- JSON'."\n" + ."\n" + .'- FORM', 'type' => 'string', 'example' => 'JSON', 'title' => ''], + 'headers' => ['description' => 'The headers.', 'type' => 'object', 'example' => 'key', 'title' => ''], + 'lang' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'- zh\\_CN'."\n" + ."\n" + .'- en\\_US', 'type' => 'string', 'example' => 'zh_CN', 'title' => ''], + 'method' => ['description' => 'The request method. Valid values:'."\n" + ."\n" + .'- GET'."\n" + ."\n" + .'- POST', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'name' => ['description' => 'The name of the webhook.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'url' => ['description' => 'The URL of the alert callback.', 'type' => 'string', 'example' => 'http://aliyun.com/test', 'title' => ''], + 'webhookId' => ['description' => 'The unique ID of the webhook.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'workspace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - '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' => 'Get Prometheus Virtual Instance List', - 'description' => 'Used for creating a site monitoring task', - 'translator' => 'machine', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAlertWebhooks', + 'summary' => 'Query webhooks', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + '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 \\"workspace\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetAggTaskGroup' => [ - 'summary' => 'Describes the aggregation task group', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListBizTraces' => [ + 'summary' => 'Lists business traces.', + 'path' => '/bizTraces', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxx', - ], + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The name of the workspace.', 'required' => false, 'title' => '', 'example' => 'default-cms-xxxxxx-cn-beijing'], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => 'The ID of the aggregation task group.', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of results to return. The maximum value is 100.', 'required' => false, 'title' => '', 'example' => '20'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The token for the next page of results.', 'required' => false, 'title' => '', 'example' => 'aa9d0e569b88098a0e3155c29b473201a'], ], ], 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure.', - 'type' => 'object', - 'properties' => [ - 'aggTaskGroup' => [ - 'title' => '聚合任务组', - 'description' => 'Aggregation task group.', - 'type' => 'object', - 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置', - 'description' => 'Aggregation task group configuration.', - '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' => 'Summary of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136xxx', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => 'ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'aggTaskGroup-xx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Name of the aggregation task group.', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', - 'description' => 'Scheduling expression for the aggregation task group when the scheduling mode is \'Cron\'.', - 'type' => 'string', - 'example' => '0 1 3 * * ? *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间', - 'description' => 'Fixed delay time (in seconds) for scheduling.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'description' => [ - 'title' => '聚合任务组描述'."\n" - ."\n", - 'description' => 'Description of the aggregation task group.', - 'type' => 'string', - 'example' => 'test', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => 'Second-level timestamp corresponding to the start time of scheduling (not yet effective).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409495', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数', - 'description' => 'Maximum number of retries for executing the aggregation task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间', - 'description' => 'Maximum retry time for executing the aggregation task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'precheckString' => [ - 'title' => '预检测配置', - 'description' => 'Pre-check configuration.', - 'type' => 'string', - 'example' => '{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}', - ], - 'regionId' => [ - 'title' => '地域 id', - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'scheduleMode' => [ - 'title' => '调度模式', - 'description' => 'Scheduling mode.', - 'type' => 'string', - 'example' => 'FixedRate', - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式', - 'description' => 'Scheduling time expression.', - 'type' => 'string', - 'example' => '@m', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'ID of the source Prometheus instance for the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'status' => [ - 'title' => '聚合任务组状态', - 'description' => 'Status of the aggregation task group.', - 'type' => 'string', - 'example' => 'Running', - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => 'Resource group tags', - 'type' => 'array', - 'items' => [ - 'description' => 'Tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => 'Key of the resource group tag.', - 'type' => 'string', - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => 'The value of the resource group tag.', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'The target Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳', - 'description' => 'The second-level timestamp corresponding to the end time of the scheduling.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409495', - ], - 'updateTime' => [ - 'title' => '聚合任务组的更新时间', - 'description' => 'The update time (timestamp) of the aggregation task group.', - 'type' => 'string', - 'example' => '1757409499000', - ], - 'userId' => [ - 'title' => '聚合任务组所属用户', - 'description' => 'The user to whom the aggregation task group belongs.', - 'type' => 'string', - 'example' => '123xxx', - ], - ], - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '68DAF543-35DF-5762-BE90-F5C00B5DC036', - ], - 'success' => [ - 'title' => '请求是否成功', - 'description' => 'Whether the request was successful', - 'type' => 'boolean', - 'example' => 'True', + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-*****'], + 'maxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of results returned. The maximum value is 100.', 'title' => '', 'example' => '20'], + 'nextToken' => ['type' => 'string', 'description' => 'The token to use to retrieve the next page of results.', 'title' => '', 'example' => 'aa9d0e569b88098a0e3155c29b473201a'], + 'totalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The total number of entries.', 'title' => '', 'example' => '66'], + 'items' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/BizTraceConfig', 'description' => 'The business trace.', 'title' => '', 'example' => ''], + 'description' => 'The list of business traces.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListBizTraces', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Query Aggregation Task Group', - 'translator' => 'machine', + 'ramActions' => [], + '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"}]', ], - 'CreateAggTaskGroup' => [ - 'summary' => 'Create Aggregation Task Group', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListContactGroups' => [ + 'summary' => 'Queries contact groups.', + 'path' => '/contactGroups', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page. The default is 100.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default is 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'contactGroupIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'The source Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'required' => true, - 'example' => 'pq4apob9jm', + 'description' => 'The contact group IDs.', + 'type' => 'array', + 'items' => ['description' => 'A contact group ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the contact group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '入参结构体', - 'description' => 'Input parameter structure.', + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', - 'description' => 'Aggregation task group configuration.'."\n" - .'Currently, only the “RecordingRuleYaml” format is supported, which must comply with the format requirements of open-source Prometheus RecordingRules.', - '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' => 'Aggregation task group configuration type, default is “RecordingRuleYaml” (open-source Prometheus RecordingRule format).', - 'type' => 'string', - 'required' => false, - 'example' => 'RecordingRuleYaml', - 'default' => 'RecordingRuleYaml', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', - 'description' => 'When the scheduling mode is selected as “Cron”, this is the specific scheduling expression. For example, “0/1 * * * *” means starting from 0 minutes and scheduling every 1 minute.', - 'type' => 'string', - 'required' => false, - 'example' => '0/1 * * * *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间，单位：秒，默认 30 ', - 'description' => 'Fixed delay time for scheduling, in seconds, default is 30.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '120', - 'minimum' => '0', - 'example' => '30', - 'default' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述', - 'description' => 'Description of the aggregation task group.', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => 'The second-level timestamp corresponding to the start time of the schedule.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1724996015', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数，默认 20', - 'description' => 'Maximum number of retries for executing the aggregation task, default is 20.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '20', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', - 'description' => 'Maximum retry time for executing the aggregation task, in seconds, default is 600.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - 'default' => '600', - ], - 'precheckString' => [ - 'title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', - 'description' => 'Pre-check configuration, no configuration by default. The input string needs to be correctly parsed as 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' => 'Scheduling mode, either “Cron” or “FixedRate”, default is “FixedRate”.', - 'type' => 'string', - 'required' => false, - 'example' => 'FixedRate', - 'default' => 'FixedRate', - 'enum' => [ - 'FixedRate', - 'Cron', - ], - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', - 'description' => 'Scheduling time expression, recommended “@s” or “@m”, indicating the alignment granularity of the scheduling time window, default is “@m”.', - 'type' => 'string', - 'required' => false, - 'example' => '@m', - 'default' => '@m', - ], - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => 'Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'default' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => 'Resource group tags.', + 'contactGroups' => [ + 'description' => 'A list of contact groups.', 'type' => 'array', 'items' => [ - 'description' => 'Value of the resource tag.', + 'description' => 'The details of a contact group.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => 'Key of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => 'Value of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', + 'contactGroupId' => ['description' => 'The contact group ID.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'contactIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A contact ID.', 'type' => 'string', 'example' => '[\\"演示会议\\"]', 'title' => ''], + 'description' => 'The contact IDs in the group.', + 'title' => '', + 'example' => '["Demo meeting"]', ], + 'name' => ['description' => 'The name of the contact group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'workspace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'The target Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', - 'description' => 'The second-level timestamp corresponding to the end time of the schedule, 0 indicates that the scheduling does not stop.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', + 'title' => '', + 'example' => '', ], + 'pageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"contactGroups\\": [\\n {\\n \\"contactGroupId\\": \\"test\\",\\n \\"contactIds\\": [\\n \\"[\\\\\\\\\\\\\\"演示会议\\\\\\\\\\\\\\"]\\"\\n ],\\n \\"name\\": \\"test\\",\\n \\"workspace\\": \\"\\"\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 15\\n}","type":"json"}]', + 'title' => 'ListContactGroups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'overrideIfExists', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListContactGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'ContactGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:contactgroup/{#contactGroupId}'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'ListContacts' => [ + 'summary' => 'Query contacts', + 'path' => '/contact', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcmsOZILZ5'], + ], + 'parameters' => [ + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'pageNumber', 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'contactIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '创建聚合任务组时，存在同名资源是否覆盖更新', - 'description' => 'Whether to overwrite and update if a resource with the same name exists when creating an aggregation task group.', - 'type' => 'boolean', + 'description' => 'The contact IDs.', + 'type' => 'array', + 'items' => ['description' => 'The contact ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The contact name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'phone', + 'in' => 'query', + 'schema' => ['description' => 'The mobile number of the contact.', 'type' => 'string', 'required' => false, 'example' => '15012345678', 'title' => ''], + ], + [ + 'name' => 'email', + 'in' => 'query', + 'schema' => ['description' => 'The email address of the contact.', 'type' => 'string', 'required' => false, 'example' => 'test@aliyun.com', 'title' => ''], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the contact group.', 'type' => 'string', 'required' => false, 'example' => 'group-id-123', 'title' => ''], + ], + [ + 'name' => 'queryUngroupedContacts', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query only ungrouped contacts.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure.', + 'title' => 'Schema of Response', + 'description' => 'The structure of the response body.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => 'Summary of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'example' => 'aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name.', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'Source Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-ecc04af14729b1a16e40a0d10068', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => 'Current status of the aggregation task group.', - 'type' => 'string', - 'example' => 'Pending2Running', + 'contacts' => [ + 'description' => 'The list of contacts.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a contact.', + 'type' => 'object', + 'properties' => [ + 'contactId' => ['description' => 'The ID of the contact.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'email' => ['description' => 'The email address of the contact.', 'type' => 'string', 'example' => 'test@aliyun.com', 'title' => ''], + 'emailVerify' => ['description' => 'Indicates whether the email address is verified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'groupList' => [ + 'description' => 'A list of contact group IDs to which the contact belongs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the contact group.', 'type' => 'string', 'example' => 'groupId', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'lang' => ['description' => 'The language preference for notifications. Valid values: zh-CN and en-US.', 'type' => 'string', 'example' => 'zh_CN', 'title' => ''], + 'name' => ['description' => 'The name of the contact.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'phone' => ['description' => 'The phone number of the contact.', 'type' => 'string', 'example' => '130123456789', 'title' => ''], + 'phoneVerify' => ['description' => 'Indicates whether the phone number is verified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'updateTime' => ['description' => 'The last time the contact was updated.', 'type' => 'string', 'example' => '2024-10-22 02:21:51', 'title' => ''], + 'imUserIds' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The user ID for an instant messaging tool. The key indicates the tool, such as `dingtalk`, and the value is the user ID.', 'type' => 'string', 'example' => '{"dingtalk": "abc123", "wechat": "def456"}', 'title' => ''], + 'description' => 'A map of user IDs for various instant messaging (IM) tools.', + 'title' => '', + 'example' => '', + ], + 'workspace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'pageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'pageSize' => ['description' => 'The number of entries per page. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '56', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'Create Aggregation Task Group', - 'translator' => 'machine', - ], - 'DeleteAggTaskGroup' => [ - 'summary' => 'Delete Aggregation Task Group', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'delete', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListContacts', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"contacts\\": [\\n {\\n \\"contactId\\": \\"test\\",\\n \\"email\\": \\"test@aliyun.com\\",\\n \\"emailVerify\\": true,\\n \\"groupList\\": [\\n \\"groupId\\"\\n ],\\n \\"lang\\": \\"zh_CN\\",\\n \\"name\\": \\"test\\",\\n \\"phone\\": \\"130123456789\\",\\n \\"phoneVerify\\": true,\\n \\"updateTime\\": \\"2024-10-22 02:21:51\\",\\n \\"imUserIds\\": {\\n \\"key\\": \\"{\\\\\\"dingtalk\\\\\\": \\\\\\"abc123\\\\\\", \\\\\\"wechat\\\\\\": \\\\\\"def456\\\\\\"}\\"\\n },\\n \\"workspace\\": \\"\\"\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 56\\n}","type":"json"}]', + ], + 'ListContextStoreAPIKeys' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/apikey', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation tasks read data from this instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'groupId', + 'name' => 'contextStoreName', 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', - ], + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => false, 'example' => 'test-context-Store', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token used to retrieve the next page of results. Leave this parameter empty to retrieve the first page.', 'type' => 'string', 'required' => false, 'example' => '615dfe7fd00f699ea94d5e63ba564aaf22450858c58f1387cc78f883b2254ab47232ce40fa95d9cb', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return in a single request. If this parameter is not specified, the service returns a default number of entries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'nextToken' => ['description' => 'A pagination token. To retrieve the next page of results, include this value in the `nextToken` parameter of your next request. If this parameter is not returned, there are no more results.', 'type' => 'string', 'example' => 'xCs4wJD41qEejNkappMSJ1OL2Ky2GeKLqmBLJrC61WrgUOj9F-31jHbo5Kgqzifv', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'total' => ['description' => 'The total count of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '454', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The display name of the API key. This name helps you identify the purpose of the key.', 'type' => 'string', 'example' => 'Production Service Key', 'title' => ''], + 'apiKey' => ['description' => 'The complete API key value.', 'type' => 'string', 'example' => 'sk-3ac8d45d741e4f31b81aa6ee984ce9fd', 'title' => ''], + 'createTime' => ['description' => 'The time when the API key was created, represented as a Unix timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1778205145', 'title' => ''], + 'workspace' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''], + 'contextStoreName' => ['description' => 'The name of the context store.', 'type' => 'string', 'example' => 'test-context-Store', 'title' => ''], + ], + 'description' => 'An object containing the details of an API key.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of API keys.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListContextStoreAPIKeys', + 'summary' => 'Lists API keys.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Delete Aggregation Task Group', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"nextToken\\": \\"xCs4wJD41qEejNkappMSJ1OL2Ky2GeKLqmBLJrC61WrgUOj9F-31jHbo5Kgqzifv\\",\\n \\"maxResults\\": 100,\\n \\"total\\": 454,\\n \\"results\\": [\\n {\\n \\"name\\": \\"Production Service Key\\",\\n \\"apiKey\\": \\"sk-3ac8d45d741e4f31b81aa6ee984ce9fd\\",\\n \\"createTime\\": \\"1778205145\\",\\n \\"workspace\\": \\"test-workspace\\",\\n \\"contextStoreName\\": \\"test-context-Store\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateAggTaskGroupStatus' => [ - 'summary' => 'Update Aggregation Task Group Status', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}/status', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ListContextStores' => [ + 'summary' => 'Retrieves a list of context stores.', + 'path' => '/workspace/{workspace}/contextstore', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation tasks read data from this instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxx', - ], + 'name' => 'contextStoreName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => false, 'example' => 'test-context-store', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '入参结构体', - 'description' => 'Input parameter structure.', - 'type' => 'object', - 'properties' => [ - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => 'Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.', - 'type' => 'string', - 'required' => true, - 'example' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], - ], - 'required' => false, - ], + 'name' => 'contextType', + 'in' => 'query', + 'schema' => ['description' => 'The context type.', 'type' => 'string', 'required' => false, 'example' => 'memory', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'OCAQV0pBqldexv7EidbIZw==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => 'Summary of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'example' => 'aggTaskGroup-xxx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name.', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'Source Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => 'The current status of the aggregated task group.', - 'type' => 'string', - 'example' => 'Running', + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. If this field is empty, all results have been returned.', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'total' => ['description' => 'The total number of context stores.', 'type' => 'integer', 'format' => 'int32', 'example' => '56', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'contextStoreName' => ['description' => 'The name of the context store.', 'type' => 'string', 'example' => 'test-context-store', 'title' => ''], + 'workspace' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'contextType' => ['description' => 'The context type.', 'type' => 'string', 'example' => 'memory', 'title' => ''], + 'description' => ['description' => 'The description of the context store.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'status' => ['description' => 'The status of the context store.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'createTime' => ['description' => 'The creation time of the context store. The value is a Unix timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '173847364841938', 'title' => ''], + 'updateTime' => ['description' => 'The last update time of the context store. The value is a Unix timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '173847364841938', 'title' => ''], + ], + 'description' => 'The details of a context store.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of context stores.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListContextStores', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Update Aggregation Task Group Status', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"maxResults\\": 100,\\n \\"total\\": 56,\\n \\"results\\": [\\n {\\n \\"contextStoreName\\": \\"test-context-store\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"contextType\\": \\"memory\\",\\n \\"description\\": \\"test\\",\\n \\"status\\": \\"active\\",\\n \\"createTime\\": \\"173847364841938\\",\\n \\"updateTime\\": \\"173847364841938\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateAggTaskGroup' => [ - 'summary' => 'Apply Aggregation Task Group', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ListDatasets' => [ + 'summary' => 'Retrieves a list of datasets in a specified workspace.', + 'path' => '/workspace/{workspace}/dataset', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'instanceId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation tasks read data from this instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'aggTaskGroup-xxxx', - ], + 'name' => 'datasetName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test_dataset', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token for retrieving the next page of results. A `nextToken` is included in the response when the result set is truncated. To continue pagination, provide the `nextToken` from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'd9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '入参结构体', - 'description' => 'Input parameter structure.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfig' => [ - 'title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', - 'description' => 'Aggregation task group configuration. Currently, only the “RecordingRuleYaml” format is supported, and it must comply with the format requirements of open-source Prometheus RecordingRules.', - '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' => 'Aggregation task group configuration type, default is “RecordingRuleYaml” (open-source Prometheus RecordingRule format).', - 'type' => 'string', - 'required' => false, - 'example' => 'RecordingRuleYaml', - 'default' => 'RecordingRuleYaml', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', - 'description' => 'When the scheduling mode is set to “Cron”, this is the specific scheduling expression. For example, “0/1 * * * *” means starting from 0 minutes, schedule every 1 minute.', - 'type' => 'string', - 'required' => false, - 'example' => '0/1 * * * *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间，单位：秒，默认 30', - 'description' => 'Fixed delay time for scheduling, in seconds, default is 30.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '120', - 'minimum' => '0', - 'example' => '30', - 'default' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述', - 'description' => 'Description of the aggregation task group.', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => 'The second-level timestamp corresponding to the start time of the scheduling.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1724996015', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数，默认 20', - 'description' => 'Maximum number of retries for executing the aggregation task, default is 20.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '20', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', - 'description' => 'Maximum retry time for executing the aggregation task, in seconds, default is 600.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - 'default' => '600', - ], - 'precheckString' => [ - 'title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', - 'description' => 'Pre-check configuration, no configuration by default. The input string needs to be correctly parsed as 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' => 'Scheduling mode, either “Cron” or “FixedRate”, default is “FixedRate”.', - 'type' => 'string', - 'required' => false, - 'example' => 'FixedRate', - 'default' => 'FixedRate', - 'enum' => [ - 'FixedRate', - 'Cron', - ], - ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', - 'description' => 'Scheduling time expression, recommended values are “@s” or “@m”, indicating the granularity of the scheduling time window alignment, default is “@m”.', - 'type' => 'string', - 'required' => false, - 'example' => '@m', - 'default' => '@m', - ], - 'status' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => 'Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'default' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], - 'tags' => [ - 'title' => '资源组标签', - 'description' => 'Resource group tags.', + 'nextToken' => ['description' => 'A token to retrieve the next page of results. This element is returned only when the result set is truncated.', 'type' => 'string', 'example' => 'd9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], + 'total' => ['description' => 'The total number of datasets that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '96', 'title' => ''], + 'datasets' => [ 'type' => 'array', 'items' => [ - 'description' => 'Tags.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键', - 'description' => 'Key of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值', - 'description' => 'Value of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, + 'description' => ['description' => 'The description of the dataset.', 'type' => 'string', 'example' => 'test dataset', 'title' => ''], + 'createTime' => ['description' => 'The time the dataset was created, as a UNIX timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'updateTime' => ['description' => 'The time the dataset was last updated, as a UNIX timestamp.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1695090077', 'title' => ''], + 'datasetName' => ['description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'test_dataset', 'title' => ''], + 'workspace' => ['description' => 'The ID of the workspace that contains the dataset.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], + 'regionId' => ['description' => 'The ID of the region where the dataset resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => 'An object that represents a dataset.', + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'Target Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', - 'description' => 'The second-level timestamp corresponding to the end time of the scheduling, 0 indicates that the scheduling does not stop.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output parameter structure.', - 'type' => 'object', - 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要', - 'description' => 'Summary of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136014dc386a92c83a6ef1e97ff22', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id', - 'description' => 'Aggregation task group ID', - 'type' => 'string', - 'example' => 'aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称', - 'description' => 'Aggregation task group name', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'requestId' => [ - 'title' => '请求 id', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'Source Prometheus instance ID of the aggregation task group', - 'type' => 'string', - 'example' => 'rw-083e17834e279f8c627fe91a2d72', - ], - 'status' => [ - 'title' => '聚合任务组的当前状态', - 'description' => 'Current status of the aggregation task group', - 'type' => 'string', - 'example' => 'Running', + 'description' => 'A list of dataset objects.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The object containing the response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDatasets', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'Update Aggregation Task Group', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"d9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************\\",\\n \\"maxResults\\": 100,\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 96,\\n \\"datasets\\": [\\n {\\n \\"description\\": \\"test dataset\\",\\n \\"createTime\\": \\"1695090077\\",\\n \\"updateTime\\": \\"1695090077\\",\\n \\"datasetName\\": \\"test_dataset\\",\\n \\"workspace\\": \\"workspace-test\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListAggTaskGroups' => [ - 'summary' => 'List Aggregation Task Groups', - 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListDeliveryTasks' => [ + 'summary' => 'Retrieves the list of data delivery tasks.', + 'path' => '/delivery-tasks', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', - 'description' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation tasks read data from this instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-pq4apob9jm', - ], - ], - [ - 'name' => 'filterAggTaskGroupIds', + 'name' => 'keyWords', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组的 id 列表，需要能被 JSON 解析', - 'description' => 'List of IDs for the aggregation task groups, which must be JSON parseable.', - 'type' => 'string', - 'required' => false, - 'example' => '["aggTaskGroup-xxx"]', - ], + 'schema' => ['description' => 'Fuzzy search by task name or task ID (LIKE semantics).', 'type' => 'string', 'required' => false, 'example' => 'test-task', 'title' => ''], ], [ - 'name' => 'filterAggTaskGroupNames', + 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组名称列表，需要能被 JSON 解析', - 'description' => 'List of names for the aggregation task groups, which must be JSON parseable.', - 'type' => 'string', - 'required' => false, - 'example' => '["apiserver_request_total"]', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], ], [ - 'name' => 'status', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', - 'description' => 'Status of the aggregation task group, either \'Running\' or \'Stopped\'. Default is Running.', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'enum' => [ - 'Running', - 'Stopped', - ], - ], + 'schema' => ['description' => 'The pagination token. Leave this parameter empty for the first request. For subsequent requests, pass the nextToken value returned in the previous response.', 'type' => 'string', 'required' => false, 'example' => 'sjC5rekx93Ew7K7VcmI3wkBZBYQ-GphB2ilQu3zJCGxoZuicwyJznfo2riTjr-lq', 'title' => ''], ], [ - 'name' => 'targetPrometheusId', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'The target Prometheus instance ID for the aggregation task group.', - 'type' => 'string', - 'required' => false, - 'example' => 'rw-pq4apob9jm', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'tags', + 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '资源组标签'."\n" - ."\n", - 'description' => 'Resource group tags.', + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => 'Resource group tags.', + 'description' => 'The list of tags.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '资源组标签的键'."\n" - ."\n", - 'description' => 'Key of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '资源组标签的值'."\n" - ."\n", - 'description' => 'Value of the resource group tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'testKey', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - ], - ], - [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '返回的最多记录数', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '20', - 'default' => '20', - ], - ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '查询令牌', - 'description' => 'Query token.', - 'type' => 'string', - 'required' => false, - 'example' => '28036394xxx', - 'maxLength' => 128, - ], - ], - [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'title' => '名称搜索，支持模糊匹配', - 'description' => 'Name search, supports fuzzy matching.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '出参结构体', - 'description' => 'Output structure.', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'aggTaskGroups' => [ - 'title' => '聚合任务组列表', - 'description' => 'List of aggregation task groups.', + 'maxResults' => ['description' => 'The maximum number of entries returned. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'nextToken' => ['description' => 'The pagination token for the next page.', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'title' => ''], + 'totalCount' => ['description' => 'The total number of tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'deliveryTasks' => [ + 'description' => 'The list of delivery tasks.', 'type' => 'array', 'items' => [ - 'description' => 'Aggregation task.', + 'description' => 'The delivery task.', 'type' => 'object', 'properties' => [ - 'aggTaskGroupConfigHash' => [ - 'title' => '聚合任务组配置的摘要'."\n" - ."\n", - 'description' => 'Hash of the aggregation task group configuration.', - 'type' => 'string', - 'example' => 'a54136014xxx', - ], - 'aggTaskGroupId' => [ - 'title' => '聚合任务组 id'."\n" - ."\n", - 'description' => 'ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'aggTaskGroup-xxxx', - ], - 'aggTaskGroupName' => [ - 'title' => '聚合任务组名称'."\n" - ."\n", - 'description' => 'Name of the aggregation task group.', - 'type' => 'string', - 'example' => 'pipeline-aggtask-group', - ], - 'cronExpr' => [ - 'title' => '调度模式选择“Cron”情况下，聚合任务组的调度表达式', - 'description' => 'Cron expression for the aggregation task group when the scheduling mode is set to \'Cron\'.', - 'type' => 'string', - 'example' => '0 10 8 1 * ? *', - ], - 'delay' => [ - 'title' => '调度的固定延迟时间'."\n" - ."\n", - 'description' => 'Fixed delay time (in seconds) for scheduling.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'description' => [ - 'title' => '聚合任务组描述'."\n" - ."\n", - 'description' => 'Description of the aggregation task group.', + 'labelFiltersType' => [ + 'description' => 'The metric filtering mode.', + 'enumValueTitles' => ['Deny' => 'Deny', 'Allow' => 'Allow'], 'type' => 'string', - 'example' => 'workspace api monitor update test', - ], - 'fromTime' => [ - 'title' => '调度开始时间对应的的秒级时间戳', - 'description' => 'Start time of the schedule in seconds since epoch.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757409499000', - ], - 'interval' => [ - 'title' => '调度间隔', - 'description' => 'Scheduling interval.', - 'type' => 'string', - 'example' => '2025-04-24 00:00:00,2025-04-24 00:00:00', - ], - 'maxRetries' => [ - 'title' => '执行聚合任务的最大重试次数'."\n" - ."\n", - 'description' => 'Maximum number of retries for the aggregation task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'maxRunTimeInSeconds' => [ - 'title' => '执行聚合任务的最大重试时间'."\n" - ."\n", - 'description' => 'Maximum retry time (in seconds) for the aggregation task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'example' => 'Allow', + 'title' => '', ], - 'regionId' => [ - 'title' => '地域 id'."\n" - ."\n", - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'externalLabels' => [ + 'description' => 'The additional labels attached to all delivered metrics. The key is the label name and the value is the label value.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'externalLabelsKey → externalLabelsValue. Example: region → ap-southeast-1.', 'type' => 'string', 'example' => 'region: cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'scheduleMode' => [ - 'title' => '调度模式'."\n" - ."\n", - 'description' => 'Scheduling mode.', - 'type' => 'string', - 'example' => 'FixedRate', + 'sinkList' => [ + 'description' => 'The list of delivery targets. Multiple sinks can be configured.', + 'type' => 'array', + 'items' => [ + 'description' => 'The delivery target configuration.', + 'type' => 'object', + 'properties' => [ + 'sinkConfigs' => [ + 'description' => 'The detailed configuration of the delivery target. The meanings of key/value pairs vary depending on the sinkType.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The configuration items supported by each sinkType.', 'type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'sinkType' => [ + 'description' => 'The type of the delivery target.', + 'enumValueTitles' => ['AcsKafka' => 'AcsKafka', 'Prometheus' => 'Prometheus', 'AcsMaxcompute' => 'AcsMaxcompute'], + 'type' => 'string', + 'example' => 'Prometheus', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'scheduleTimeExpr' => [ - 'title' => '调度时间表达式'."\n" - ."\n", - 'description' => 'Scheduling time expression.', - 'type' => 'string', - 'example' => '@m', + 'taskDescription' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'my delivery task', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T09:02:01Z', 'title' => ''], + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.', + 'type' => 'object', + 'properties' => [ + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'sourcePrometheusId' => [ - 'title' => '聚合任务组的源 Prometheus 实例 id', - 'description' => 'The source Prometheus instance ID of the aggregation task group.', - 'type' => 'string', - 'example' => 'rw-xxx', + 'dataSourceId' => ['description' => 'The data source ID (Prometheus instance ID).', 'type' => 'string', 'example' => 'rw-5f2b4c7e66342s', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-01-22T09:02:01Z', 'title' => ''], + 'labelFilters' => [ + 'description' => 'The metric filter conditions. Used together with labelFiltersType. The key is the metric label name and the value is the match value.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'filterKey → filterValue. Example: __name__ → up, job → my_job.', 'type' => 'string', 'example' => '__name__: up', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'taskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'test-task', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'db21f8a126d96953', 'title' => ''], 'status' => [ - 'title' => '聚合任务组状态'."\n" - ."\n", - 'description' => 'Status of the aggregation task group.', - 'type' => 'string', - 'example' => 'Running', - ], - 'targetPrometheusId' => [ - 'title' => '聚合任务组的目标 Prometheus 实例 id', - 'description' => 'The target Prometheus instance ID of the aggregation task group.', + 'description' => 'The current status of the task.', + 'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'], 'type' => 'string', - 'example' => 'rw-xxx', - ], - 'toTime' => [ - 'title' => '调度结束时间对应的秒级时间戳'."\n" - ."\n", - 'description' => 'The second-level timestamp corresponding to the end time of scheduling.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'example' => 'Enable', + 'title' => '', ], - 'updateTime' => [ - 'title' => '聚合任务组的更新时间'."\n" - ."\n", - 'description' => 'Update time of the aggregation task group.', - 'type' => 'string', - 'example' => '1757409499000', + 'extraInfo' => [ + 'description' => 'The extended information.', + 'type' => 'object', + 'properties' => [ + 'taskNameList' => [ + 'description' => 'The list of EventBridge tasks.', + 'type' => 'array', + 'items' => ['description' => 'The EventBridge task.', 'type' => 'string', 'example' => 'prometheus-deliver-98e367d8fb8cc83b-0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'maxResults' => [ - 'title' => '返回的最多记录数', - 'description' => 'The maximum number of records returned.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '0', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌', - 'description' => 'Token for the next query.', - 'type' => 'string', - 'example' => 'aa9d0e569b880xxx', - 'maxLength' => 128, - ], - 'requestId' => [ - 'title' => '请求 id'."\n" - ."\n", - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => 'Total number of instances.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7D7DF334-B2F2-5453-AD51-A27B337E3191', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'List Aggregation Task Groups', - 'translator' => 'machine', - ], - 'DeletePrometheusInstance' => [ - 'summary' => 'Delete prom instance', - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve data delivery task list', + 'description' => 'Deletes a specified site monitoring task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'prometheusInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-abc123', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response Schema', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListDeliveryTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'DeliveryTask', 'arn' => 'acs:cms:{#regionId}:{#accountId}:deliverytask/*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => 'Delete Prometheus Instance', - 'description' => 'Delete a Prometheus instance.', - 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 100,\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"totalCount\\": 100,\\n \\"deliveryTasks\\": [\\n {\\n \\"labelFiltersType\\": \\"Allow\\",\\n \\"externalLabels\\": {\\n \\"key\\": \\"region: cn-hangzhou\\"\\n },\\n \\"sinkList\\": [\\n {\\n \\"sinkConfigs\\": {\\n \\"key\\": \\"Url: http://xxxx/api/v1/write\\"\\n },\\n \\"sinkType\\": \\"Prometheus\\"\\n }\\n ],\\n \\"taskDescription\\": \\"my delivery task\\",\\n \\"updateTime\\": \\"2026-01-22T09:02:01Z\\",\\n \\"tags\\": [\\n {\\n \\"value\\": \\"value\\",\\n \\"key\\": \\"key\\"\\n }\\n ],\\n \\"dataSourceId\\": \\"rw-5f2b4c7e66342s\\",\\n \\"createTime\\": \\"2026-01-22T09:02:01Z\\",\\n \\"labelFilters\\": {\\n \\"key\\": \\"__name__: up\\"\\n },\\n \\"taskName\\": \\"test-task\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\",\\n \\"taskId\\": \\"db21f8a126d96953\\",\\n \\"status\\": \\"Enable\\",\\n \\"extraInfo\\": {\\n \\"taskNameList\\": [\\n \\"prometheus-deliver-98e367d8fb8cc83b-0\\"\\n ]\\n }\\n }\\n ],\\n \\"requestId\\": \\"7D7DF334-B2F2-5453-AD51-A27B337E3191\\"\\n}","type":"json"}]', ], - 'DeletePrometheusView' => [ - 'summary' => 'Delete prometheus view instance', - 'path' => '/prometheus-views/{prometheusViewId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListIntegrationPolicies' => [ + 'path' => '/integration-policies', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'prometheusViewId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Prometheus view ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-xxxxxx', - ], + 'name' => 'policyId', + 'in' => 'query', + 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'example' => 'policy-93817a401f78435596d745a97d2e85a1', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'policyName', + 'in' => 'query', + 'schema' => ['description' => 'The rule name.', 'type' => 'string', 'required' => false, 'example' => 'prod-database', 'title' => ''], + ], + [ + 'name' => 'policyType', + 'in' => 'query', + 'schema' => ['description' => 'The policy type.', 'type' => 'string', 'required' => false, 'example' => 'CS', 'title' => ''], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => ['description' => 'The addon name.', 'type' => 'string', 'required' => false, 'example' => 'cs-default', 'title' => ''], + ], + [ + 'name' => 'filterRegionIds', + 'in' => 'query', + 'schema' => ['description' => 'The region IDs used for filtering, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing,cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxx', 'title' => ''], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags in JSON format.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', - 'title' => 'Delete prometheus view instance.', - 'description' => 'Delete prometheus view instance.', - 'translator' => 'machine', - ], - 'GetPrometheusInstance' => [ - 'summary' => 'Query the instance in a specified environment', - 'path' => '/prometheus-instances/{prometheusInstanceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token used to retrieve more results. You do not need to specify this parameter for the first request. Use the token returned from the previous query for subsequent requests.', 'type' => 'string', 'required' => false, 'example' => 'mvnX6zqg3P', 'title' => ''], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcmsCP2WWY', + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return. Default value: 30. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'prometheusInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-abc123', - ], + 'name' => 'entityGroupIds', + 'in' => 'query', + 'schema' => ['description' => 'The entity IDs used for filtering, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'eg-1,eg-2,eg-3', 'title' => ''], ], [ - 'name' => 'resourceGroupId', + 'name' => 'workspace', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], + 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => false, 'example' => 'demo', 'title' => ''], ], [ - 'name' => 'aliyunLang', + 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'Language setting, default is Chinese zh | en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['description' => 'The keyword used for general queries.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'prometheusInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'cmee-622d27c2e87d49debceeebc7c642610e', 'title' => ''], + ], + [ + 'name' => 'bindResourceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the bound resource.', 'type' => 'string', 'required' => false, 'example' => '622d27c2e87d49debceeebc7c642610e'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusInstance' => [ - 'description' => 'Details of the Prometheus instance.', - 'type' => 'object', - 'properties' => [ - 'accessType' => [ - 'title' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'description' => 'Access type:'."\n" - .'readWrite, readOnly, httpReadOnly', - 'type' => 'string', - 'example' => 'readOnly', - ], - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存，3650表示永久保存。', - 'description' => 'Number of days to automatically archive and save after storage expiration. 0 means no archiving, 3650 means permanent saving.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'authFreeReadPolicy' => [ - 'title' => '读免密地址白名单策略。', - 'description' => 'Password-free read policy (supports IP segments and 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' => 'Password-free write policy (supports IP segments and 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 string.', - 'type' => 'string', - 'example' => 'eJwixxxxx', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => 'Instance creation time, using UTC+0, formatted as yyyy-MM-ddTHH:mmZ.', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否开启读免密。', - 'description' => 'Whether to enable password-free reading.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'title' => '是否开启写免密。', - 'description' => 'Whether to enable password-free writing.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'description' => 'Whether to enable authentication token.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'extraInfo' => [ - 'title' => '扩展信息（仅控制台请求才返回）', - 'description' => 'Additional information.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Other additional information.', - 'example' => 'value', - ], - ], - 'httpApiInterUrl' => [ - 'description' => 'HTTP public network address.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'httpApiIntraUrl' => [ - 'description' => 'HTTP intranet address.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'instanceType' => [ - 'title' => 'remote-write（Prometheus for Remote Write）', - 'description' => 'Prometheus instance type.', - 'type' => 'string', - 'example' => 'remote-write', - ], - 'paymentType' => [ - 'title' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。', - 'description' => 'Billing method:'."\n" - .'POSTPAY: Pay-as-you-go based on metric reporting volume.'."\n" - .'POSTPAY_GB: Pay-as-you-go based on metric write volume.', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'The product to which the Prometheus instance belongs (arms or cms).', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rw-524ada714221af267c73122af2e1', - ], - 'prometheusInstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'example' => 'test-prom-name', - ], - 'pushGatewayInterUrl' => [ - 'description' => 'Public network address of PushGateway.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'pushGatewayIntraUrl' => [ - 'description' => 'Intranet address of PushGateway.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx'."\n", - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'remoteReadInterUrl' => [ - 'description' => 'Public network read address.', - 'type' => 'string', - 'example' => ' http://workspace-default-cms-xxxxxxx', - ], - 'remoteReadIntraUrl' => [ - 'description' => 'Intranet read address.', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-1xxxxxxxxxx', - ], - 'remoteWriteInterUrl' => [ - 'description' => 'Public network write address.', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-xxxxxxxxxx', - ], - 'remoteWriteIntraUrl' => [ - 'description' => 'Intranet write address.', - 'type' => 'string', - 'example' => 'https://workspace-default-cms-xxxxxxxxxx', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusInstance', - 'description' => 'Fixed value: PrometheusInstance.', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => 'Instance status.', - 'type' => 'string', - 'example' => 'Running', - ], - 'storageDuration' => [ - 'title' => '存储时长（天）。', - 'description' => 'Storage duration (in days).', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'supportAuthTypes' => [ - 'title' => '支持的认证鉴权类型。', - 'description' => 'Supported authentication types.', - 'type' => 'array', - 'items' => [ - 'description' => 'Authentication type.', - 'type' => 'string', - 'example' => 'BasicAuth', - 'enum' => [ - 'BasicAuth', - 'AuthFree', - 'AuthToken', + 'maxResults' => ['description' => 'The page size.'."\n" + .'Default value:'."\n" + .' 50'."\n" + .'Maximum value:'."\n" + .' 50.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'nextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', 'title' => ''], + 'policies' => [ + 'description' => 'The list of access policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'The access policy.', + 'type' => 'object', + 'properties' => [ + 'bindResource' => [ + 'description' => 'The bound resource information.', + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cv68tt87d78vyc89zy9v', 'title' => ''], + 'clusterType' => ['description' => 'The cluster type.', 'type' => 'string', 'example' => 'ManagedKubernetes', 'title' => ''], + 'vpcCidr' => ['description' => 'The VPC CIDR block.', 'type' => 'string', 'example' => '100.100.0.1/16', 'title' => ''], + 'vpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-uf664nyle5khp5d4d7hdo', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'tags' => [ - 'description' => 'List of tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag.', + 'entityGroup' => [ + 'description' => 'The entity group.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'example' => 'openStorage', - ], - 'value' => [ - 'description' => 'Matched value.', - 'type' => 'string', - 'example' => '130303196111114281', + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'entityGroupId' => ['description' => 'The entity group ID.', 'type' => 'string', 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', 'title' => ''], + 'entityGroupName' => ['description' => 'The entity group name.', 'type' => 'string', 'example' => 'test-eg', 'title' => ''], + 'entityRules' => [ + 'description' => 'The entity group.', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => 'The annotations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The annotations.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'tagValues' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag values.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'entityTypes' => [ + 'description' => 'The list of entity types.', + 'type' => 'array', + 'items' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'fieldRules' => [ + 'description' => 'The field rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The field rules.', + 'type' => 'object', + 'properties' => [ + 'fieldKey' => ['description' => 'The unique identifier of the field.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'fieldValues' => [ + 'description' => 'The field values. Multiple values are separated by commas.', + 'type' => 'array', + 'items' => ['description' => 'The field values. Multiple values are separated by commas.', 'type' => 'string', 'example' => 'field1,fieled2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'instanceIds' => [ + 'description' => 'The instance IDs.', + 'type' => 'array', + 'items' => ['description' => 'The instance IDs.', 'type' => 'string', 'example' => '6fq8fvvcb,owqeq789r', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ipMatchRule' => [ + 'description' => 'The IP match rule.', + 'type' => 'object', + 'properties' => [ + 'ipCidr' => ['description' => 'The IP CIDR block.', 'type' => 'string', 'example' => '100.100.1.0/16', 'title' => ''], + 'ipFieldKey' => ['description' => 'The key of the IP field.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'labels' => [ + 'description' => 'The labels.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label value.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'tagValues' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag values.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'regionIds' => [ + 'description' => 'The list of region IDs.', + 'type' => 'array', + 'items' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing,cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-5i6dbwxfxuqihk7k', 'title' => ''], + 'tags' => [ + 'description' => 'The tag information of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag value.', + 'type' => 'object', + 'properties' => [ + 'op' => ['description' => 'The operation to perform.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'tagValues' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag values.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'query' => ['description' => 'The search keyword. Document library names and descriptions are supported.', 'type' => 'string', 'example' => 'Haval', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1236812738', 'title' => ''], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-api', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'managedInfo' => [ + 'description' => 'The policy network management information.', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-xxxxx', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxxxxx', 'title' => ''], + 'eniId' => ['title' => '', 'description' => 'The ENI ID of the managed probe. Example: eni-xxxx.', 'type' => 'string', 'example' => 'eni-12345678'], + ], + 'title' => '', + 'example' => '', + ], + 'policyId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', 'title' => ''], + 'policyName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => '6f5HSsg3AP', 'title' => ''], + 'policyType' => ['description' => 'The access center policy type.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxx', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '128470923', 'title' => ''], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-api', 'title' => ''], + 'feePackage' => [ + 'description' => 'The billing type.', + 'enumValueTitles' => ['CS_Pro' => 'CS_Pro', 'CS_Basic' => 'CS_Basic'], + 'type' => 'string', + 'example' => 'CS_Pro', + 'title' => '', + ], + 'subAddonRelease' => [ + 'description' => 'The number of sub-releases.', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '278', 'title' => ''], + 'ready' => ['description' => 'The number of ready sub-releases.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'csUmodelStatus' => ['description' => 'The umodel installation status in the container environment.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '170731234567', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'Version.', - 'type' => 'string', - 'example' => 'V1', - ], - 'workspace' => [ - 'title' => 'prom实例归属的工作空间', - 'description' => 'The workspace to which the Prometheus instance belongs.', - 'type' => 'string', - 'example' => 'ws1', - ], - 'folderUrl' => [ - 'title' => '可视化大盘Url', - 'description' => 'URL of the visualization dashboard directory.', - 'type' => 'string', - 'example' => 'https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx', - ], - 'grafanaInstanceId' => [ - 'title' => '绑定的托管grafana实例Id', - 'description' => 'ID of the managed Grafana instance that is bound.', - 'type' => 'string', - 'example' => 'SHARED', - ], - 'grafanaInstanceName' => [ - 'title' => '绑定的托管grafana实例名称', - 'description' => 'Name of the managed Grafana instance that is bound.', - 'type' => 'string', - 'example' => '共享版', - ], - 'paymentTypeUpdateTime' => [ - 'title' => '实例计费方式修改时间', - 'description' => 'Time when the billing method of the instance was updated.', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Unique identifier for the request.', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query access center policy list', + 'summary' => 'Queries the list of access center policies.', + 'description' => 'Queries the integration list.', + 'changeSet' => [ + ['createdAt' => '2025-10-30T12:36:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-30T11:46:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-15T12:10:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-14T08:04:01.000Z', 'description' => 'Response parameters changed'], ], - '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' => 'Get Prometheus Instance Details', - 'description' => 'Retrieve details of a Prometheus instance.', - 'translator' => 'machine', - ], - 'GetPrometheusView' => [ - 'summary' => 'Query a specified Prometheus view instance', - 'path' => '/prometheus-views/{prometheusViewId}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicies'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"Haval\\",\\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"}]', + ], + 'ListIntegrationPolicyAddons' => [ + 'summary' => 'Lists the add-ons that are installed for a specified policy.', + 'path' => '/integration-policies/{policyId}/addons', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcmsCP2WWY', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusViewId', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rw-xxxxxx', - ], - ], - [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], - ], - [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'Language environment, default is Chinese zh | en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['description' => 'The ID of the environment.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'policy-3563e6bf338141b3b92c118e2c318c37'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusView' => [ - 'description' => 'View instance.', - 'type' => 'object', - 'properties' => [ - 'authFreeReadPolicy' => [ - 'title' => '读免密地址白名单策略。', - 'description' => 'Password-free read policy (supports IP segments and 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 string.', - 'type' => 'string', - 'example' => 'eJxxxxxx', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => 'Instance creation time, using UTC+0 time, format is yyyy-MM-ddTHH:mmZ.', - 'type' => 'string', - 'example' => '2025-08-10T02:07:53Z', - ], - 'enableAuthFreeRead' => [ - 'title' => '是否开启读免密。', - 'description' => 'Whether to enable password-free read.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否开启authToken。', - 'description' => 'Whether to enable authToken.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'httpApiInterUrl' => [ - 'description' => 'Public HTTP address.', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'httpApiIntraUrl' => [ - 'description' => 'Private HTTP address.', - 'type' => 'string', - 'example' => 'http://xxxxxxxx', - ], - 'instanceType' => [ - 'title' => '实例类型：'."\n" - .'prom-view：新版本聚合视图'."\n" - .'global-view：老版本聚合视图', - 'description' => 'Instance type, fixed value prom-view.', - 'type' => 'string', - 'example' => 'prom-view', - ], - 'paymentType' => [ - 'title' => '付费类型。目前固定值FREE（免费）。', - 'description' => 'Payment type. Currently, the fixed value is FREE (free).', - 'type' => 'string', - 'example' => 'FREE', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'Product that the prom instance belongs to.', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstances' => [ - 'description' => 'Prometheus instance list.', - 'type' => 'array', - 'items' => [ - 'description' => 'Prometheus instance list.', - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rw-63549e054ff596a4149927961dff', - ], - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-north-2-gov-1', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '122xxxxx', + 'addons' => [ + 'description' => 'A list of add-ons.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the add-on.', + 'type' => 'object', + 'properties' => [ + 'alias' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], + 'categories' => [ + 'description' => 'The categories.', + 'type' => 'array', + 'items' => ['description' => 'A category.', 'type' => 'string', 'example' => 'database', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'dashboards' => [ + 'description' => 'A list of dashboards.', + 'type' => 'array', + 'items' => [ + 'description' => 'A dashboard.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '用于mysql的监控大盘', 'title' => ''], + 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'MySQL Overview', 'title' => ''], + 'url' => ['description' => 'The URL of the dashboard.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - 'prometheusViewId' => [ - 'description' => 'Prometheus view ID.', - 'type' => 'string', - 'example' => 'view-xxx', - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'example' => 'view1', - ], - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'remoteReadInterUrl' => [ - 'description' => 'Remote read public 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 intranet 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' => 'Resource group ID.', - 'type' => 'string', - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusView', - 'description' => 'Fixed value: PrometheusView', - 'type' => 'string', - 'example' => 'RegistryModule', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => 'Backend data storage status', - 'type' => 'string', - 'example' => 'Pending2Running', - ], - 'supportAuthTypes' => [ - 'description' => 'Supported authentication types.', - 'type' => 'array', - 'items' => [ - 'description' => 'Supported authentication types.', - 'type' => 'string', - 'example' => 'BasicAuth', - ], - ], - 'tags' => [ - 'description' => 'Instance tag keys.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'PagerDuty integration key.', - 'type' => 'string', - 'example' => 'global_score_series', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'example' => '371293199010092839', + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Observability integration.', 'title' => ''], + 'environments' => [ + 'description' => 'A list of supported environments.', + 'type' => 'array', + 'items' => [ + 'description' => 'The environment context.', + 'type' => 'object', + 'properties' => [ + 'dependencies' => [ + 'description' => 'The dependencies.', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => 'The dependencies on cluster types.', + 'type' => 'array', + 'items' => ['description' => 'The cluster type.', 'type' => 'string', 'example' => 'ACK', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'features' => [ + 'description' => 'The dependencies on probes.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The metric agent.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'services' => [ + 'description' => 'The dependencies on product codes.', + 'type' => 'array', + 'items' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'Prometheus', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'o11y-demo-cn-heyuan', 'title' => ''], + 'enable' => ['description' => 'Indicates whether the feature is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'label' => ['description' => 'The display name of the environment.', 'type' => 'string', 'example' => 'Cloud', 'title' => ''], + 'name' => ['description' => 'The name of the environment.', 'type' => 'string', 'example' => 'Cloud', 'title' => ''], + 'policies' => [ + 'description' => 'The policy.', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => ['description' => 'The default status of the alert rule policy.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'defaultInstall' => ['description' => 'Indicates whether the add-on is installed by default.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'enableServiceAccount' => ['description' => 'Indicates whether to assign a Service Account for communication with the console API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'metricCheckRule' => [ + 'description' => 'The metric check rule.', + 'type' => 'object', + 'properties' => [ + 'promQl' => [ + 'description' => 'The PromQL search statements.', + 'type' => 'array', + 'items' => ['description' => 'A PromQL search statement.', 'type' => 'string', 'example' => 'up{job="mysql"} > 0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'needRestartAfterIntegration' => ['description' => 'Indicates whether a pod restart is required after the add-on is installed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'protocols' => [ + 'description' => 'The protocols.', + 'type' => 'array', + 'items' => [ + 'description' => 'A protocol.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'icon' => ['description' => 'The icon.', 'type' => 'string', 'example' => ' https://img.alixxxx', 'title' => ''], + 'label' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'Golang', 'title' => ''], + 'name' => ['description' => 'The protocol name.', 'type' => 'string', 'example' => 'golang', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'targetAddonName' => ['description' => 'The name of the target add-on.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'icon' => ['description' => 'The icon of the add-on.', 'type' => 'string', 'example' => 'asert/mysql.svg', 'title' => ''], + 'keywords' => [ + 'description' => 'The keywords.', + 'type' => 'array', + 'items' => ['description' => 'A keyword.', 'type' => 'string', 'example' => 'container', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'language' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'latestReleaseCreateTime' => ['description' => 'The time when the latest version was created.', 'type' => 'string', 'example' => '2025-09-03T03:15:56Z', 'title' => ''], + 'name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'once' => ['description' => 'Indicates whether the add-on can be installed only once.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'scene' => ['description' => 'The scenario of the add-on.', 'type' => 'string', 'example' => 'container', 'title' => ''], + 'version' => ['description' => 'The version of the add-on.', 'type' => 'string', 'example' => '0.1.1', 'title' => ''], + 'weight' => ['description' => 'The weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '99', 'title' => ''], ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '11222', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'Version.', - 'type' => 'string', - 'example' => 'V1', - ], - 'workspace' => [ - 'title' => '环境归属的工作空间', - 'description' => 'Workspace to which the environment belongs', - 'type' => 'string', - 'example' => 'cms-monitor-test-aysls-pub-cn-fuzhou-monitor', - ], - 'folderUrl' => [ - 'title' => '可观测大盘Url', - 'description' => 'Observability dashboard URL.', - 'type' => 'string', - 'example' => 'https://xxxx', - ], - 'grafanaInstanceId' => [ - 'title' => '绑定的托管grafana实例Id', - 'description' => 'Bound managed Grafana instance ID.', - 'type' => 'string', - 'example' => 'g-xxx ', - ], - 'grafanaInstanceName' => [ - 'title' => '绑定的托管grafana实例名称', - 'description' => 'Bound managed Grafana instance name.', - 'type' => 'string', - 'example' => 'gxxx', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7E00EF90-CEF9-57C9-9AE9-5AA937D37C03'], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Query details of a specified Prometheus view instance.', - 'description' => 'Query a specified Prometheus view instance.', - 'translator' => 'machine', - ], - 'ListPrometheusDashboards' => [ - 'summary' => 'Get Prometheus Instance Dashboard List', - 'path' => '/prometheus-instances/{prometheusInstanceId}/dashboards', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListIntegrationPolicyAddons', + 'description' => 'Lists the add-ons that are installed for a specified policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyAddons', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'integrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + '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"}]', + ], + 'ListIntegrationPolicyCollectors' => [ + 'summary' => 'Returns information about collectors for an Integration Center policy.', + 'path' => '/integration-policies/{policyId}/collectors', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusInstanceId', + 'name' => 'policyId', 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '实例id', - 'description' => 'Instance ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'rw-abc123', - ], + 'schema' => ['description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'env-d95435164593aece55f9999ce45c'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'addonReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource Group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], + 'schema' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'release-1234567'], ], [ - 'name' => 'aliyunLang', + 'name' => 'collectorType', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'Language environment, default is Chinese zh | en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['description' => 'The collector type.', 'type' => 'string', 'required' => true, 'example' => 'Exporter', 'title' => ''], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => ['description' => 'The language.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -18137,412 +16033,280 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusDashboards' => [ - 'description' => 'List of Prometheus instance dashboards.', + 'collectors' => [ + 'description' => 'The list of collectors.', 'type' => 'array', 'items' => [ + 'description' => 'The collector information.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '', - 'description' => 'Dashboard ID.', - 'type' => 'string', - 'example' => '1', - ], - 'uid' => [ - 'title' => '', - 'description' => 'Dashboard UID.', - 'type' => 'string', - 'example' => '1987395500251724', - ], - 'name' => [ - 'title' => '', - 'description' => 'Dashboard name.', - 'type' => 'string', - 'example' => 'pod', - ], - 'title' => [ - 'title' => '', - 'description' => 'Dashboard title.', - 'type' => 'string', - 'example' => 'ceshi', - ], - 'url' => [ + 'collectorName' => ['description' => 'The collector name.', 'type' => 'string', 'example' => 'collector-kkxx', 'title' => ''], + 'collectorType' => ['description' => 'The collector type.', 'type' => 'string', 'example' => 'Exporter', 'title' => ''], + 'conditions' => [ + 'description' => 'The phase status.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details.', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => ['description' => 'The time of the first transition.', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00', 'title' => ''], + 'lastTransitionTime' => ['description' => 'The time of the last transition.', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00', 'title' => ''], + 'message' => ['description' => 'The details.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'reason' => ['description' => 'The reason for the failure.', 'type' => 'string', 'example' => 'Probe', 'title' => ''], + 'status' => ['description' => 'The phase status.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'type' => ['description' => 'The phase type.', 'type' => 'string', 'example' => 'Ready', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', - 'description' => 'Dashboard URL address.', - 'type' => 'string', - 'example' => 'https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application', + 'example' => '', ], - 'tags' => [ - 'description' => 'Tags.', + 'managed' => ['description' => 'Indicates whether the component is a managed component.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'state' => ['description' => 'The collector status.', 'type' => 'string', 'example' => 'xx', 'title' => ''], + 'version' => ['description' => 'The component version.', 'type' => 'string', 'example' => '2.6.2', 'title' => ''], + 'workloads' => [ + 'description' => 'The list of workloads.', 'type' => 'array', 'items' => [ - 'description' => 'Tag values.', - 'type' => 'string', - 'example' => '[{\\"tagName\\":\\"key1\\",\\"tagDefinePrompt\\":\\"value1\\"}]', + 'description' => 'The workload details.', + 'type' => 'object', + 'properties' => [ + 'hostIp' => ['description' => 'The host IP address.', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'ip' => ['description' => 'The IP address of the workload.', 'type' => 'string', 'example' => '11.193.82.198', 'title' => ''], + 'managed' => ['description' => 'Indicates whether the component is a managed component.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'managedInfo' => [ + 'description' => 'The policy management information.', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-xxxxx', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'message' => ['description' => 'The details.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'name' => ['description' => 'The workload name.', 'type' => 'string', 'example' => 'exporter-xxx', 'title' => ''], + 'namespace' => ['description' => 'The workload namespace.', 'type' => 'string', 'example' => 'prod-db', 'title' => ''], + 'ownerReferenceKind' => ['description' => 'The kind of the parent reference.', 'type' => 'string', 'example' => 'Deployment', 'title' => ''], + 'ownerReferenceName' => ['description' => 'The name of the parent reference.', 'type' => 'string', 'example' => 'exporter', 'title' => ''], + 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-08-27T13:59:23+08:00', 'title' => ''], + 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'version' => ['description' => 'The workload version.', 'type' => 'string', 'example' => 'v2.4.4', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'releaseName' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'example' => 'ecs-loong-collector-i-f8z1176fg57rlwmc1rfi', 'title' => ''], + 'addonMeta' => ['description' => 'The add-on details.', '$ref' => '#/components/schemas/AddonMeta', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => 'Total number of instances', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'Get Prometheus Instance Dashboard List', - 'description' => 'Get the list of Prometheus instance dashboards.', - 'translator' => 'machine', - ], - 'UpdatePrometheusView' => [ - 'summary' => 'Update Prometheus view instance information', - 'path' => '/prometheus-views/{prometheusViewId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListIntegrationPolicyCollectors', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyCollectors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + '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\\": \\"cloud-acs-ecs\\",\\n \\"version\\": \\"0.0.1\\",\\n \\"language\\": \\"zh\\",\\n \\"description\\": \\"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.\\",\\n \\"scene\\": \\"feature\\",\\n \\"alias\\": \\"ECS 监控\\",\\n \\"icon\\": \\"assets/logos/ecs.svg\\",\\n \\"keywords\\": [\\n \\"Monitor\\"\\n ],\\n \\"once\\": true,\\n \\"environments\\": [\\n {\\n \\"name\\": \\"CS/ECS/Cloud/Client\\",\\n \\"enable\\": true,\\n \\"label\\": \\"容器环境\\",\\n \\"description\\": \\"支持容器集群的工作覆盖监控\\",\\n \\"policies\\": {\\n \\"defaultInstall\\": true,\\n \\"targetAddonName\\": \\"cloud-acs-ecs\\",\\n \\"alertDefaultStatus\\": \\"RUNNING\\",\\n \\"protocols\\": [\\n {\\n \\"name\\": \\"Prometheus\\",\\n \\"label\\": \\"Prometheus 协议\\",\\n \\"description\\": \\"使用 Prometheus 协议写入指标数据\\",\\n \\"icon\\": \\"assets/logos/ecs.svg\\\\n\\"\\n }\\n ],\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"up{job=\\\\\\"acs-ecs\\\\\\"}==1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"bindEntity\\": {\\n \\"entityGroupMode\\": true,\\n \\"singleEntityMode\\": true,\\n \\"entityType\\": \\"acs.ecs.instance\\",\\n \\"vpcIdFieldKey\\": \\"vpcId\\"\\n },\\n \\"bindDefaultPolicy\\": true\\n },\\n \\"dependencies\\": {\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"cmee\\"\\n ],\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ]\\n },\\n \\"policyType\\": \\"ECS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n }\\n ],\\n \\"categories\\": [\\n \\"infrastructure\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"name\\": \\"ECS 监控概览大盘\\",\\n \\"url\\": \\"assets/dashboards/ecs.png\\\\n\\",\\n \\"description\\": \\"描述信息\\"\\n }\\n ],\\n \\"weight\\": 1000,\\n \\"latestReleaseCreateTime\\": \\"2025-10-25 09:12:12\\"\\n }\\n }\\n ],\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + ], + 'ListIntegrationPolicyCustomScrapeJobRules' => [ + 'summary' => 'Lists the custom service discovery rules for an Integration Center policy.', + 'path' => '/integration-policies/{policyId}/custom-scrape-job-rules', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusViewId', + 'name' => 'policyId', 'in' => 'path', - 'schema' => [ - 'description' => 'Prometheus view instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxxxxxxx', - ], + 'schema' => ['title' => '接入中心策略ID。', 'description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-d95435164593aece55f9999ce45c'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['title' => 'Addon Release名称。', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => false, 'example' => 'release12345678'], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => ['title' => '是否加密Yaml。', 'description' => 'Specifies whether to encrypt the YAML file.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => ['title' => '命名空间。', 'description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'arms-prom'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Request body.', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'authFreeReadPolicy' => [ - 'description' => 'Password-free read policy (supports IP segments and 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' => 'Whether to support password-free read.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否支持authToken', - 'description' => 'Whether to support authToken.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'prometheusInstances' => [ - 'description' => 'List of Prometheus instances.', + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'et15prod-et15storage'], + 'customScrapeJobRules' => [ + 'description' => 'The custom scrape job rules.', 'type' => 'array', 'items' => [ - 'description' => 'List of Prometheus instances.', + 'description' => 'The custom service discovery rules.', 'type' => 'object', 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'c7ba84651c71e442c8d0653085d862164', - ], - 'regionId' => [ - 'description' => 'Region.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-north-2-gov-1', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'required' => false, - 'example' => '16727123456789', + 'addonName' => ['description' => 'The add-on name.', 'type' => 'string', 'title' => '', 'example' => 'cloud-ecs'], + 'addonReleaseName' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'title' => '', 'example' => 'release-12345678'], + 'addonVersion' => ['description' => 'The add-on version.', 'type' => 'string', 'title' => '', 'example' => '0.0.1'], + 'configYaml' => ['description' => 'The configuration YAML file.', 'type' => 'string', 'title' => '', 'example' => 'scrape_cofnigs:'."\n" + .'- jobxxxxxx'], + 'enableStatus' => ['description' => 'The enabled status.', 'type' => 'string', 'title' => '', 'example' => 'mini'], + 'encryptYaml' => ['description' => 'Indicates whether the YAML file is encrypted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'matchedPodCount' => ['description' => 'The number of matched pods.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'message' => ['description' => 'The details.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'name' => ['description' => 'The service name.', 'type' => 'string', 'title' => '', 'example' => 'dlab1'], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => 'prod-data'], + 'scrapeConfigs' => [ + 'description' => 'The custom configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom configuration.', + 'type' => 'object', + 'properties' => [ + 'jobName' => ['description' => 'The scrape job name.', 'type' => 'string', 'title' => '', 'example' => 'mysql-exporter'], + 'message' => ['description' => 'The details.', 'type' => 'string', 'title' => '', 'example' => 'successful'], + 'metricsPath' => ['description' => 'The scrape path.', 'type' => 'string', 'title' => '', 'example' => '/metrics'], + 'scheme' => ['description' => 'The invocation method.', 'type' => 'string', 'title' => '', 'example' => 'http'], + 'scrapeInterval' => ['description' => 'The scrape interval.', 'type' => 'string', 'title' => '', 'example' => '30s'], + 'scrapeTimeout' => ['description' => 'The scrape timeout period.', 'type' => 'string', 'title' => '', 'example' => '60s'], + 'serviceDiscoveryConfigs' => [ + 'description' => 'The service discovery configurations.', + 'type' => 'array', + 'items' => ['description' => 'The service discovery configuration.', 'type' => 'string', 'title' => '', 'example' => '{}'], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-prom-view-name', - ], - 'status' => [ - 'description' => 'Running status.', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], - 'workspace' => [ - 'title' => '归属的工作空间。', - 'description' => 'Belonging workspace.', - '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 view instance 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', + 'title' => '', + 'example' => '', ], + 'policyId' => ['description' => 'The policy ID.', 'type' => 'string', 'title' => '', 'example' => 'policy-15abcc24c06f4797832b5954198e1ed1'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"rw-xxxxxx\\",\\n \\"requestId\\": \\"64D964F5-76C7-19A2-9399-457744AB3619\\"\\n}","type":"json"}]', - 'title' => 'Update Prometheus View Instance Information', - 'description' => 'Update Prometheus view instance information.', - 'translator' => 'machine', - ], - 'UpdatePrometheusInstance' => [ - 'summary' => 'Update Prometheus instance information', - 'path' => '/prometheus-instances/{prometheusInstanceId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + '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' => 'Get Custom Service Discovery Rules for Access Center Policy', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyCustomScrapeJobRules'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'prometheusInstanceId', - 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => 'prometheus实例ID', - 'description' => 'Prometheus instance ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rw-xxxxxxx', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyCustomScrapeJobRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'Request body.', - 'type' => 'object', - 'properties' => [ - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：1~365天。仅按指标写入量支持。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'description' => 'The number of days to automatically archive and save after the storage expires, 0 means no archiving. The range of archiving days:'."\n" - .'V1: 1~365 days. Only supported for metric write volume.'."\n" - .'V2: 1~3650 days (3650 indicates permanent storage).', - 'type' => 'integer', - 'required' => false, - 'example' => '365', - 'enum' => [], - ], - 'authFreeReadPolicy' => [ - 'title' => '是否开启免密读的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', - 'description' => 'Password-free read policy (supports IP segments and 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' => 'Password-free write policy (supports IP segments and 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' => 'Whether to enable password-free read.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'title' => '是否开启免密写', - 'description' => 'Whether to enable password-free write.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否开启访问Token鉴权', - 'description' => 'Whether to enable access token authentication.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-prom-name', - ], - 'status' => [ - 'title' => '实例存储db状态（仅支持RUNNING）。为空时，不改变存储db状态。', - 'description' => 'Instance storage DB status (only supports RUNNING). If empty, the storage DB status will not be changed.', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'storageDuration' => [ - 'title' => '存储时长（天）：'."\n" - .'按写入量：90、180'."\n" - .'按指标上报量：15、30、60、90、180', - 'description' => 'Storage duration (days):'."\n" - .'By write volume: 90, 180.'."\n" - .'By metric reporting volume: 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' => 'Billing method (can only be modified once during the instance\'s lifecycle):'."\n" - .'POSTPAY: Postpaid by metric reporting volume.'."\n" - .'POSTPAY_GB: Postpaid by metric write volume.', - 'type' => 'string', - 'required' => false, - 'example' => 'POSTPAY_GB', - 'enum' => [ - 'POSTPAY_GB', - 'POSTPAY', - ], - ], - 'workspace' => [ - 'title' => '归属的工作空间。', - 'description' => 'Belonging workspace.', - 'type' => 'string', - 'required' => false, - 'example' => 'default-cms-1500199863951574-cn-shanghai', - ], - ], + ], + ], + 'ListIntegrationPolicyDashboards' => [ + 'summary' => 'Queries a list of integration policy dashboards.', + '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' => 'The policy ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => ['description' => 'The add-on name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cs-default'], + ], + [ + 'name' => 'scene', + 'in' => 'query', + 'schema' => ['description' => 'The component scenario.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'databse'], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The query language.', + 'type' => 'string', 'required' => false, + 'default' => 'zh', + 'enum' => ['zh', 'en'], + 'example' => 'zh', ], ], ], @@ -18553,2522 +16317,2333 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => 'Instance 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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], + 'total' => ['description' => 'The number of components.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'dashboards' => [ + 'description' => 'The list of dashboards.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of dashboards.', + 'type' => 'object', + 'properties' => [ + 'uid' => ['description' => 'The ID of the current Alibaba Cloud account. This parameter is read-only.', 'type' => 'string', 'title' => '', 'example' => '1258199346721590'], + 'engine' => ['title' => '大盘引擎：'."\n" + .'grafana：共享grafana。'."\n" + .'cms：cms自研大盘引擎。', 'description' => 'The dashboard engine. Valid values:'."\n" + .'grafana: shared Grafana.'."\n" + .'cms: the self-developed dashboard engine of CloudMonitor.', 'type' => 'string', 'example' => 'grafana'], + 'title' => ['description' => 'The title of the UI module. This is different from the name parameter.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'name' => ['title' => '大盘名称', 'description' => 'The dashboard name.', 'type' => 'string', 'example' => 'k8s-pod'], + 'url' => ['description' => 'The webhook URL for PagerDuty integration. V1 and V2 are supported.', 'type' => 'string', 'title' => '', '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' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hongkong'], + 'folderUid' => ['description' => 'The UID of the dashboard folder.', 'type' => 'string', 'title' => '', 'example' => 'Env-AAA'], + 'tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => ['description' => 'A tag.', 'type' => 'string', 'title' => '', 'example' => 'tag1'], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query Dashboard List', + 'description' => 'This topic provides an example of how to query a list of integration policy dashboards.', + 'changeSet' => [ + ['createdAt' => '2025-10-20T14:07:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-16T08:11:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-15T12:10:46.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"1E92F783-E057-58F1-BD5C-92DED088E7A5\\"\\n}","type":"json"}]', - 'title' => 'Update Prometheus Instance Information', - 'description' => 'Update Prometheus instance information.', - 'translator' => 'machine', - ], - 'ListPrometheusViews' => [ - 'summary' => 'Retrieve a list of Prometheus view instance information', - 'path' => '/prometheus-views', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyDashboards'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyDashboards', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'integrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + ], + 'ListIntegrationPolicyPodMonitors' => [ + 'summary' => 'Lists the PodMonitor resources for an Integration Center policy.', + 'path' => '/integration-policies/{policyId}/pod-monitors', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusViewIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'List of Prometheus view instance IDs.', - 'type' => 'string', - 'required' => false, - 'example' => 'view-xxx', - ], + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '接入中心策略ID。', 'description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-1d4634924c8ba599822c601fcee3'], ], [ - 'name' => 'prometheusViewName', + 'name' => 'addonReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'required' => false, - 'example' => 'view1', - ], + 'schema' => ['title' => 'Addon Release名称。', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => false, 'example' => 'release-123456789'], ], [ - 'name' => 'workspace', + 'name' => 'namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Workspace name', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - ], + 'schema' => ['title' => '命名空间。', 'description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ - 'name' => 'version', + 'name' => 'encryptYaml', 'in' => 'query', + 'schema' => ['title' => '是否加密Yaml。', 'description' => 'Specifies whether to encrypt the YAML file.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例版本：V1或V2', - 'description' => 'Instance version: V1 or V2', - 'type' => 'string', - 'required' => false, - 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'et15prod-et15storage'], + 'podMonitors' => [ + 'description' => 'The list of PodMonitors.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of PodMonitors.', + 'type' => 'object', + 'properties' => [ + 'addonName' => ['description' => 'The name of the add-on.', 'type' => 'string', 'title' => '', 'example' => 'cloud-ecs'], + 'addonReleaseName' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'title' => '', 'example' => 'release-2345678'], + 'addonVersion' => ['description' => 'The version of the add-on.', 'type' => 'string', 'title' => '', 'example' => '0.0.1'], + 'configYaml' => ['description' => 'The YAML configuration.', 'type' => 'string', 'title' => '', 'example' => 'apiVersion: xxxxx'], + 'enableStatus' => ['description' => 'The status.', 'type' => 'string', 'title' => '', 'example' => 'run'], + 'encryptYaml' => ['description' => 'Indicates whether the YAML file is encrypted.', 'type' => 'boolean', 'title' => '', 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK'], + 'endpoints' => [ + 'description' => 'The endpoints of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the endpoint.', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The collection interval.', 'type' => 'string', 'title' => '', 'example' => '30s'], + 'matchedTargetCount' => ['description' => 'The number of matched targets.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'path' => ['description' => 'The metric collection path.', 'type' => 'string', 'title' => '', 'example' => '/metrics'], + 'port' => ['description' => 'The port number.', 'type' => 'string', 'title' => '', 'example' => '9100'], + 'targetPort' => ['description' => 'The target port.', 'type' => 'string', 'title' => '', 'example' => 'https'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'matchedPodCount' => ['description' => 'The number of matched pods.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '3'], + 'name' => ['description' => 'The collection name.', 'type' => 'string', 'title' => '', 'example' => 'znzmo_entity_test'], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => 'sla-ns-d5aeb2b4f91b47'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'policyId' => ['description' => 'The policy ID.', 'type' => 'string', 'title' => '', 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], + 'example' => '', ], ], + ], + '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' => 'Query PodMonitor Resources of Access Center Policy', + 'description' => 'This topic provides an example of how to list the PodMonitor resources for an Integration Center policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyPodMonitors'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'resourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型：PrometheusView', - 'description' => 'Resource type.', - 'type' => 'string', - 'required' => false, - 'example' => 'PROMETHEUSVIEW', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyPodMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], ], ], + ], + ], + 'ListIntegrationPolicyServiceMonitors' => [ + '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' => 'filterRegionIds', + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], + ], + [ + 'name' => 'addonReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'Filter by RegionID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjiakou,cn-beijing', - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - ], + 'schema' => ['title' => '', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => false, 'example' => 'release-12345678'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], + 'schema' => ['title' => '', 'description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'arms-prom'], ], [ - 'name' => 'tag', + 'name' => 'encryptYaml', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'Specifies whether to encrypt the YAML file.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'List of tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'List of tags.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag key', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'description' => 'Match value.', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'ea119prod-ea119blinkcptssd1'], + 'policyId' => ['description' => 'The policy ID.', 'type' => 'string', 'title' => '', 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], + 'serviceMonitors' => [ + 'description' => 'The list of ServiceMonitors.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'addonName' => ['description' => 'The add-on name.', 'type' => 'string', 'title' => '', 'example' => 'cloud-acs-ecs'], + 'addonReleaseName' => ['description' => 'The name of the add-on release.', 'type' => 'string', 'title' => '', 'example' => 'release-1234567'], + 'addonVersion' => ['description' => 'The add-on version.', 'type' => 'string', 'title' => '', 'example' => '0.0.1'], + 'configYaml' => ['description' => 'The configuration YAML file.', 'type' => 'string', 'title' => '', 'example' => 'apiVersion: xxxxx'], + 'enableStatus' => ['description' => 'The status.', 'type' => 'string', 'title' => '', 'example' => 'run'], + 'encryptYaml' => ['description' => 'Indicates whether the YAML file is encrypted.', 'type' => 'boolean', 'title' => '', 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK'], + 'endpoints' => [ + 'description' => 'The list of Endpoints.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of Endpoints.', + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The collection interval.', 'type' => 'string', 'title' => '', 'example' => '30s'], + 'matchedTargetCount' => ['description' => 'The number of matched targets.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '65'], + 'path' => ['description' => 'The collection path.', 'type' => 'string', 'title' => '', 'example' => '/metrics'], + 'port' => ['description' => 'The collection port.', 'type' => 'string', 'title' => '', 'example' => '9100'], + 'targetPort' => ['description' => 'The target port.', 'type' => 'string', 'title' => '', 'example' => 'http'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'matchedServiceCount' => ['description' => 'The number of matched services.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '50'], + 'name' => ['description' => 'The name of the ServiceMonitor.', 'type' => 'string', 'title' => '', 'example' => '62a526c5-f6ca-4cfb-b5a4-b76974cffe51'], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => 'arms-prom'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5'], ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListIntegrationPolicyServiceMonitors', + 'summary' => 'Retrieves the ServiceMonitor information for an Integration Center policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + '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"}]', + ], + 'ListIntegrationPolicyStorageRequirements' => [ + 'summary' => 'Lists the storage requirements for an Integration Center policy.', + 'path' => '/integration-policies/{policyId}/storage-requirements', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'maxResults', + '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' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e'], + ], + [ + 'name' => 'addonName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '返回的最多记录数。', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '100', - ], + 'schema' => ['title' => 'Addon名称，如mysql。', 'description' => 'The name of the add-on release.', 'type' => 'string', 'required' => false, 'example' => 'release-1234357'], ], [ - 'name' => 'nextToken', + 'name' => 'storageType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '查询令牌。', - 'description' => 'Query token.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', - 'maxLength' => 128, - ], + 'schema' => ['title' => '存储类型', 'description' => 'The storage type. Valid values: LogStore, Prometheus, TraceStore, EventStore, and EntityStore.', 'type' => 'string', 'required' => false, 'example' => 'LogStore'], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => ['title' => 'AddonRelease的名称。', 'description' => 'The name of the AddonRelease.', 'type' => 'string', 'required' => false, 'example' => 'kafka-17201012937917'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Response schema', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'maxResults' => [ - 'title' => '返回的最多记录数。', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌。', - 'description' => 'Token for the next query.', - 'type' => 'string', - 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', - 'maxLength' => 128, - ], - 'prometheusViews' => [ - 'description' => 'List of Prometheus view instances.', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + 'storageRequirements' => [ + 'description' => 'The list of storage requirements.', 'type' => 'array', 'items' => [ - 'description' => 'Prometheus view instance.', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => 'Instance creation time, using UTC+0 time, formatted as yyyy-MM-ddTHH:mmZ', - 'type' => 'string', - 'example' => '2025-07-12T02:18:36Z', - ], - 'instanceType' => [ - 'title' => '实例类型：'."\n" - .'prom-view：新版本聚合视图'."\n" - .'global-view：老版本聚合视图', - 'description' => 'Instance type:'."\n" - .'prom-view: new version aggregated view'."\n" - .'global-view: old version aggregated view', - 'type' => 'string', - 'example' => 'prom-view', - ], - 'paymentType' => [ - 'title' => '付费类型。目前固定值FREE（免费）。', - 'description' => 'Payment type. Currently, the fixed value is FREE (free).', - 'type' => 'string', - 'example' => 'FREE', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'Product that the prom instance belongs to (arms or cms).', - 'type' => 'string', - 'example' => 'cms', - ], - 'prometheusInstanceCount' => [ - 'title' => '视图包含的prometheus实例的数量。', - 'description' => 'Number of Prometheus instances in the view.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'prometheusViewId' => [ - 'description' => 'Prometheus view ID.', - 'type' => 'string', - 'example' => 'view-xxx', - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'example' => 'view1', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-zhangjiakou', + 'apiVersion' => ['description' => 'The version number.', 'type' => 'string', 'title' => '', 'example' => 'v1'], + 'kind' => ['description' => 'The kind of the resource.', 'type' => 'string', 'title' => '', 'example' => 'Pod'], + 'metadata' => [ + 'description' => 'The metadata.', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => 'The annotations.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The annotations.', 'title' => '', 'example' => 'prometheus.io/path'], + 'title' => '', + 'example' => '', + ], + 'labels' => [ + 'description' => 'The resource labels.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The resource labels.', 'title' => '', 'example' => 'key=value'], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The resource name.', 'type' => 'string', 'title' => '', 'example' => 'pod-1234567'], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => 'arms-prom'], + ], + 'title' => '', + 'example' => '', ], - 'resourceType' => [ - 'title' => '固定值：PrometheusView', - 'description' => 'Fixed value: PrometheusView.', - 'type' => 'string', - 'example' => 'PrometheusView', + 'spec' => [ + 'description' => 'The spec of the resource.', + 'type' => 'object', + 'properties' => [ + 'entityId' => ['description' => 'The instance ID. Specify this parameter to query data at the instance level. This parameter depends on data in EntityStore.', 'type' => 'string', 'title' => '', 'example' => 'es-xxxxx'], + 'instance' => ['description' => 'The ID of the Prometheus instance.', 'type' => 'string', 'title' => '', 'example' => 'i-bp122p85gthbniw8rsu9'], + 'instanceName' => ['description' => 'The name of the Prometheus instance.', 'type' => 'string', 'title' => '', 'example' => 'category_predict'], + 'project' => ['description' => 'Optional. The project is determined based on the current environment type.', 'type' => 'string', 'title' => '', 'example' => 'datagrid_cdm'], + 'region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-shenzhen'], + 'shareScope' => ['description' => 'The scope of storage sharing. Valid values: Environment, Region, Workspace, and Custom.', 'type' => 'string', 'title' => '', 'example' => 'Region'], + 'storageType' => ['description' => 'The storage type of the instance.', 'type' => 'string', 'title' => '', 'example' => 'Prometheus'], + 'systemTags' => [ + 'description' => 'The tags that need to be added to the destination storage. The tags are injected as system tags.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The tags that need to be added to the destination storage. The tags are injected as system tags.', 'title' => '', 'example' => 'system-key=value'], + 'title' => '', + 'example' => '', + ], + 'tags' => [ + 'description' => 'The tags that need to be added to the destination storage. The tags are injected as common tags.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The tags that need to be added to the destination storage. The tags are injected as common tags.', 'title' => '', 'example' => 'key=value'], + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '12345678'], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'title' => '', 'example' => 'test-api'], + ], + 'title' => '', + 'example' => '', ], 'status' => [ - 'title' => '后端数据存储状态', - 'description' => 'Backend data storage status.', - 'type' => 'string', - 'example' => 'Running', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '123xxx', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'Version.', - 'type' => 'string', - 'example' => 'V2', + 'description' => 'The status of the storage requirement.', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'rmq-cn-uqm3ket1t0u'], + 'interUrl' => ['description' => 'The internal URL.', 'type' => 'string', 'title' => '', 'example' => 'http://192.168.xxxxxx'], + 'intraUrl' => ['description' => 'The internal URL.', 'type' => 'string', 'title' => '', 'example' => 'http://100.100.xxxxxx'], + 'name' => ['description' => 'The name of the storage requirement.', 'type' => 'string', 'title' => '', 'example' => 'sr-xxxx'], + 'project' => ['description' => 'The project for the storage requirement.', 'type' => 'string', 'title' => '', 'example' => 'jiuwu_algo'], + 'promMetricStore' => ['description' => 'The metric store of Prometheus.', 'type' => 'string', 'title' => '', 'example' => 'xxxx'], + 'region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'storageType' => ['description' => 'The storage type of the instance.', 'type' => 'string', 'title' => '', 'example' => 'Prometheus'], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'title' => '', 'example' => 'default'], + ], + 'title' => '', + 'example' => '', ], - 'workspace' => [ - 'title' => 'prom实例归属工作空间', - 'description' => 'Workspace that the prom instance belongs to.', - 'type' => 'string', - 'example' => 'default-cms-1490404746278495-cn-hangzhou', + 'addonReleaseNames' => [ + 'description' => 'A collection of AddonRelease names.', + 'type' => 'array', + 'items' => ['description' => 'The name of the AddonRelease.', 'type' => 'string', 'title' => '', 'example' => 'kafka-17201238912'], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => 'Total number of instances', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'Get Prometheus View Instance List', - 'description' => 'Retrieve a list of Prometheus view instance information.', - 'translator' => 'machine', - ], - 'ListPrometheusInstances' => [ - 'summary' => 'Get the list of Prometheus instance information', - 'path' => '/prometheus-instances', - 'methods' => [ - 'get', + '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' => 'Get Storage Requirements Information for Access Center Policy', + 'description' => 'When a policy is active, alert notifications are not sent for alerts that occur in the application group.'."\n" + ."\n" + .'This topic provides an example of creating a policy named `PauseNotify`. This policy pauses alert notifications for application group `7301****` from `1622949300000` to `1623208500000` (from `2021-06-06 11:15:00` to `2021-06-09 11:15:00` UTC+8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyStorageRequirements'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListIntegrationPolicyStorageRequirements', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + ], + 'ListMemoryStores' => [ + 'path' => '/workspace/{workspace}/memorystore', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'prometheusInstanceIds', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例id列表（以英文逗号分隔）', - 'description' => 'List of instance IDs (comma-separated)', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'rw-00001,rw-00002,rw-00003', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'prometheusInstanceName', + 'name' => 'memoryStoreName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例名称（支持部分匹配）', - 'description' => 'Instance name (partial match supported)', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the memory store.', 'type' => 'string', 'required' => false, 'example' => 'qianyi_test_1', 'title' => ''], ], [ - 'name' => 'workspace', + 'name' => 'maxResults', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例归属的工作空间', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The maximum number of results to return. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'version', + 'name' => 'nextToken', 'in' => 'query', - 'allowEmptyValue' => true, + 'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例版本：V1或V2', - 'description' => 'Instance version: V1 or V2', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', + 'type' => 'object', + 'properties' => [ + 'maxResults' => ['description' => 'The maximum number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'nextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'xxxxxxxxxx', 'title' => ''], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7', 'title' => ''], + 'total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'memoryStores' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => 'The time when the memory store was created.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850', 'title' => ''], + 'description' => ['description' => 'The description of the memory store.', 'type' => 'string', 'example' => 'Created by taishan-module-recovery', 'title' => ''], + 'memoryStoreName' => ['description' => 'The name of the memory store.', 'type' => 'string', 'example' => 'qianyi_test_1', 'title' => ''], + 'updateTime' => ['description' => 'The time when the memory store was last updated.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '1764556182850', 'title' => ''], + 'workspace' => ['description' => 'Workspace', 'type' => 'string', 'example' => 'default-cms-1646467597142798-cn-shenzhen', 'title' => ''], + 'regionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => 'The data of the memory store.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of memory stores.', + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMemoryStores', + 'summary' => 'Retrieves a list of memory stores.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'resourceType', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '实例的资源类型：PrometheusInstance', - 'description' => 'Resource type of the instance.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Prometheus', - 'enum' => [], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListMemoryStores', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 1,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"requestId\\": \\"16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7\\",\\n \\"total\\": 0,\\n \\"memoryStores\\": [\\n {\\n \\"createTime\\": \\"1764556182850\\",\\n \\"description\\": \\"Created by taishan-module-recovery\\",\\n \\"memoryStoreName\\": \\"qianyi_test_1\\",\\n \\"updateTime\\": \\"1764556182850\\",\\n \\"workspace\\": \\"default-cms-1646467597142798-cn-shenzhen\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListPipelines' => [ + 'path' => '/workspace/{workspace}/pipeline', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'filterRegionIds', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '指定筛选的regionId（目前仅支持单regioinId，暂不支持多值）。', - 'description' => 'Specified list of regionIds to filter (comma-separated).', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-shenzhen', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2bhocin5e2na', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'tag', + 'name' => 'pipelineName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'List of tags.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag key', - 'type' => 'string', - 'required' => false, - 'example' => 'testKey', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'required' => false, - 'example' => 'testValue', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], ], [ - 'name' => 'maxResults', + 'name' => 'nextToken', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '返回的最多记录数。', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'fff3442dac1de7950f44d5afc0c735ebd12e27f603b21d17ec30cb1d5c735b1ba7c4fb3a1c124bce', 'title' => ''], ], [ - 'name' => 'nextToken', + 'name' => 'maxResults', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '查询令牌。', - 'description' => 'Query token.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'xxxxxxxxxx', - 'maxLength' => 128, - ], + 'schema' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'maxResults' => [ - 'title' => '返回的最多记录数。', - 'description' => 'Maximum number of records to return.', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], - 'nextToken' => [ - 'title' => '下一次查询的令牌。', - 'description' => 'Token for the next query.', - 'type' => 'string', - 'example' => 'xxxxxxxxxx', - 'maxLength' => 128, - ], - 'prometheusInstances' => [ - 'description' => 'List of Prometheus instances.', - 'type' => 'array', - 'items' => [ - 'description' => 'Prometheus instance.', - 'type' => 'object', - 'properties' => [ - 'accessType' => [ - 'title' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'description' => 'Access type:'."\n" - .'readWrite, readOnly, httpReadOnly', - 'type' => 'string', - 'example' => 'readWrite', - ], - 'createTime' => [ - 'title' => '实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ', - 'description' => 'Instance creation time, using UTC+0 time, formatted as 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' => 'Instance type.', - 'type' => 'string', - 'example' => 'remote-write', - ], - 'paymentType' => [ - 'title' => 'POSTPAY：按指标量后付费。'."\n" - .'POSTPAY_GB：按写入量后付费。'."\n" - .'PREPAY：预付费。'."\n" - .'FREE：免费。', - 'description' => 'POSTPAY: Postpaid by metric.'."\n" - .'POSTPAY_GB: Postpaid by write volume.'."\n" - .'PREPAY: Prepaid.'."\n" - .'FREE: Free.', - 'type' => 'string', - 'example' => 'POSTPAY_GB', - ], - 'product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'Product to which the prom instance belongs', - 'type' => 'string', - 'example' => 'arms', - ], - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'rw-63549e054ff596a4149927961dff', - ], - 'prometheusInstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'example' => 'test-prom-name', - ], - 'regionId' => [ - 'description' => 'Region ID', - 'type' => 'string', - 'example' => 'cn-nanjing', - ], - 'resourceType' => [ - 'title' => '固定值：PrometheusInstance', - 'description' => 'Resource type.', - 'type' => 'string', - 'example' => 'Prometheus', - ], - 'status' => [ - 'title' => '后端数据存储状态', - 'description' => 'Backend data storage status', - 'type' => 'string', - 'example' => 'Pending2Running', - ], - 'supportAuthTypes' => [ - 'description' => 'Supported authentication types.', - 'type' => 'array', - 'items' => [ - 'description' => 'Authentication type.', - 'type' => 'string', - 'example' => 'BasicAuth', - ], - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'example' => '17073812345', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'Version', - 'type' => 'string', - 'example' => '*', - ], - 'workspace' => [ - 'title' => 'prom实例归属工作空间', - 'description' => 'Workspace to which the Prometheus instance belongs', - 'type' => 'string', - 'example' => 'default-cms-115214006-cn-hangzhou', - ], + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], + 'nextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => '3f0d6785770d5fb308f0605d718d422a227c38f96117633678f029842acd19039329e8281583b3da7bc598dfc4c1973e', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'pipelines' => [ + 'description' => 'The pipelines.', + 'type' => 'array', + 'items' => [ + 'description' => 'The pipeline.', + 'type' => 'object', + 'properties' => [ + 'pipelineName' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'example' => 'pipeline-name-1', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test pipeline', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-02-28T07:14:17Z', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2026-03-24T06:58:22Z', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'workspace-test', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'totalCount' => [ - 'title' => '总实例数', - 'description' => 'Total number of instances', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'Query Prometheus Instance List', - 'description' => 'Get the list of Prometheus instances.', - 'translator' => 'machine', - ], - 'CreatePrometheusInstance' => [ - 'summary' => 'Create a Prometheus monitoring instance', - 'path' => '/prometheus-instances', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Lists pipelines.', + 'summary' => 'Lists pipelines.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListPipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Pipeline', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/pipeline/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\",\\n \\"nextToken\\": \\"3f0d6785770d5fb308f0605d718d422a227c38f96117633678f029842acd19039329e8281583b3da7bc598dfc4c1973e\\",\\n \\"maxResults\\": 100,\\n \\"pipelines\\": [\\n {\\n \\"pipelineName\\": \\"pipeline-name-1\\",\\n \\"description\\": \\"test pipeline\\",\\n \\"createTime\\": \\"2026-02-28T07:14:17Z\\",\\n \\"updateTime\\": \\"2026-03-24T06:58:22Z\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"workspace\\": \\"workspace-test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListPrometheusDashboards' => [ + 'summary' => 'Retrieves a list of dashboards for a Prometheus instance.', + 'path' => '/prometheus-instances/{prometheusInstanceId}/dashboards', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => ['title' => '实例id', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'rw-abc123'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-acfm3gn5i6bigbi'], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => ['title' => '语言环境, 默认为中文 zh | en', 'description' => 'The language of the response. Valid values: zh and en. The default value is zh.', 'type' => 'string', 'required' => false, 'default' => 'zh', 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Request structure.', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'archiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：1~365天。仅按指标写入量支持。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'description' => 'The number of days to automatically archive and save after the storage expires, 0 means no archiving. The range of archiving days is as follows:'."\n" - .'* V1: 60~365 days.'."\n" - .'* V2: 60~3650 days (3650 indicates permanent storage).', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - 'enum' => [], - ], - 'authFreeReadPolicy' => [ - 'description' => 'Password-free read policy (supports IP segments and 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' => 'Password-free write policy.', - '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' => 'Whether to enable password-free read (only supported in V2 version).', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthFreeWrite' => [ - 'description' => 'Whether to enable password-free write (only supported in V2 version).', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'description' => 'Whether to enable authorization Token (only supported in V1 version).', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstanceName' => [ - 'description' => 'Instance name.', - 'type' => 'string', - 'required' => true, - 'example' => 'name1', - ], - 'status' => [ - 'description' => 'Instance status.', - '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' => 'Storage duration (days):'."\n" - .'* By write volume: 90, 180.'."\n" - .'* By metric reporting volume: 15, 30, 60, 90, 180.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - 'enum' => [ - '15', - '30', - '60', - '90', - '180', - ], - ], - 'tags' => [ - 'description' => 'Tag values.', + 'prometheusDashboards' => [ + 'description' => 'A list of dashboards for the Prometheus instance.', 'type' => 'array', 'items' => [ - 'description' => 'Tag values.', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'required' => false, - 'example' => '110109200001214284', + 'id' => ['title' => '', 'description' => 'The dashboard ID.', 'type' => 'string', 'example' => '1'], + 'uid' => ['title' => '', 'description' => 'The dashboard UID.', 'type' => 'string', 'example' => '1987395500251724'], + 'name' => ['title' => '', 'description' => 'The dashboard name.', 'type' => 'string', 'example' => 'pod'], + 'title' => ['title' => '', 'description' => 'The dashboard title.', 'type' => 'string', 'example' => 'ceshi'], + 'url' => ['title' => '', 'description' => 'The URL of the dashboard.', 'type' => 'string', 'example' => 'https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application'], + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => '[{\\"tagName\\":\\"key1\\",\\"tagDefinePrompt\\":\\"value1\\"}]'], + 'title' => '', + 'example' => '', ], ], - 'required' => false, - ], - 'required' => false, - ], - 'workspace' => [ - 'title' => '默认值：default-cms-{userId}-{regionId}', - 'description' => 'Belonging workspace, default value: default-cms-{userId}-{regionId}.', - 'type' => 'string', - 'required' => false, - 'example' => 'wokspace1', - ], - 'paymentType' => [ - 'title' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。'."\n" - .'空：则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', - 'description' => 'Billing method:'."\n" - .'* POSTPAY: Postpaid by metric reporting volume.'."\n" - .'* POSTPAY_GB: Postpaid by metric write volume.'."\n" - .'Note, if left blank, the user\'s default billing method configuration will be used. If the user has not configured a default, the system defaults to billing by metric reporting volume.', - 'type' => 'string', - 'required' => false, - 'example' => 'POSTPAY', - 'enum' => [ - 'POSTPAY', - 'POSTPAY_GB', + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'totalCount' => ['title' => '总实例数', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], - 'required' => false, + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'title' => '集群id', - 'description' => 'Instance 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 \\"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' => 'Get Prometheus Instance Dashboard List', + 'description' => 'Retrieves a list of dashboards for a Prometheus instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusDashboards'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListPrometheusDashboards', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusInstance', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#prometheusInstanceId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', - 'title' => 'Create Prometheus Instance', - 'translator' => 'machine', ], - 'CreatePrometheusView' => [ - 'summary' => 'Create Prometheus View', - 'path' => '/prometheus-views', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListPrometheusInstances' => [ + 'summary' => 'Retrieves a list of Managed Service for Prometheus instances.', + 'path' => '/prometheus-instances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'prometheusInstanceIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The instance IDs, separated by commas.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rw-00001,rw-00002,rw-00003'], + ], + [ + 'name' => 'prometheusInstanceName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The instance name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The workspace to which the instance belongs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'workspace-test'], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Request Body', - 'type' => 'object', - 'properties' => [ - 'authFreeReadPolicy' => [ - 'description' => 'Not enabled yet', - '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' => 'Whether to support password-free read', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enableAuthToken' => [ - 'title' => '是否支持authToken', - 'description' => 'Whether to support authToken', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'prometheusInstances' => [ - 'description' => 'List of Prometheus instances.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'prometheusInstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-1d581fac20a462dcde743d9628', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-wulanchabu', - ], - 'userId' => [ - 'description' => 'User ID.', - 'type' => 'string', - 'required' => false, - 'example' => '167271234567890', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'prometheusViewName' => [ - 'description' => 'Prometheus view name.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-prom-view-name', - ], - 'resourceGroupId' => [ - 'description' => 'Resource group ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3gn5i6bigbi', - ], - 'status' => [ - 'description' => 'Not enabled yet.', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - 'default' => 'Running', - 'enum' => [ - 'Running', - ], - ], - 'tags' => [ - 'description' => 'The operation to be performed.', - 'type' => 'array', - 'items' => [ - 'description' => 'Tag key.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-key', - ], - 'value' => [ - 'description' => 'Tag value.', - 'type' => 'string', - 'required' => false, - 'example' => 'test-value', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'version' => [ - 'title' => 'V1：老版本(global-view)'."\n" - .'V2：新版本(prom-view)', - 'description' => '- V1: Old version'."\n" - .'- V2: New version', - 'type' => 'string', - 'required' => true, - 'example' => 'V2', - 'enum' => [ - 'V1', - 'V2', - ], - ], - 'workspace' => [ - 'title' => '默认值：default-cms-{userId}-{regionId}', - 'description' => 'Default value: default-cms-{userId}-{regionId}', - 'type' => 'string', - 'required' => false, - 'example' => 'cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor', + 'title' => '', + 'description' => 'The instance version. Valid values:'."\n" + .'- V1: V1 version.'."\n" + .'- V2: V2 version.', + 'enumValueTitles' => ['V1' => 'V1 version.', 'V2' => 'V2 version.'], + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enum' => ['V1', 'V2'], + 'example' => 'V2', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '', + 'description' => 'The resource type of the instance.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enum' => [], + 'example' => 'Prometheus', + ], + ], + [ + 'name' => 'filterRegionIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The region IDs for filtering, separated by commas.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-shenzhen'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'testKey', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'testValue', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The query token.', 'type' => 'string', 'docRequired' => false, 'maxLength' => 128, 'required' => false, 'example' => 'xxxxxxxxxx'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'prometheusViewId' => [ - 'description' => 'Prometheus view ID.', - 'type' => 'string', - 'example' => 'cd5237f7dbd574cf9bbd648ff9efb16cd', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '10'], + 'nextToken' => ['title' => '', 'description' => 'The token for the next query.', 'type' => 'string', 'maxLength' => 128, 'example' => 'xxxxxxxxxx'], + 'prometheusInstances' => [ + 'description' => 'The list of Prometheus instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Prometheus instance.', + 'type' => 'object', + 'properties' => [ + 'accessType' => ['title' => '', 'description' => 'The access type. Valid values:'."\n" + .'- readWrite'."\n" + .'- readOnly'."\n" + .'- httpReadOnly', 'type' => 'string', 'example' => 'readWrite'], + 'createTime' => ['title' => '', 'description' => 'The instance creation time in UTC+0, in the format of yyyy-MM-ddTHH:mmZ.', 'type' => 'string', 'example' => '2025-08-10T02:07:53Z'], + 'instanceType' => ['title' => '', 'description' => 'The instance type.', 'type' => 'string', 'example' => 'remote-write'], + 'paymentType' => ['title' => '', 'description' => 'The billing method. Valid values:'."\n" + .'- POSTPAY: pay-as-you-go by metric volume.'."\n" + .'- POSTPAY_GB: pay-as-you-go by write volume.'."\n" + .'- PREPAY: subscription.'."\n" + .'- FREE: free.', 'type' => 'string', 'example' => 'POSTPAY_GB'], + 'product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'arms'], + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-63549e054ff596a4149927961dff', 'title' => ''], + 'prometheusInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test-prom-name', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-nanjing', 'title' => ''], + 'resourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'example' => 'Prometheus'], + 'status' => ['title' => '', 'description' => 'The backend data storage status.', 'type' => 'string', 'example' => 'Pending2Running'], + 'supportAuthTypes' => [ + 'description' => 'The supported authentication types.', + 'type' => 'array', + 'items' => ['description' => 'The authentication type.', 'type' => 'string', 'example' => 'BasicAuth', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '17073812345', 'title' => ''], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => '*'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'default-cms-115214006-cn-hangzhou'], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aek2bhocin5e2na', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'totalCount' => ['title' => '', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"cd5237f7dbd574cf9bbd648ff9efb16cd\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => 'Create Prometheus View', - 'description' => 'Used to create a site monitoring task', - 'translator' => 'machine', - ], - 'ListAlertActions' => [ - 'summary' => 'Query Alert Actions', - 'path' => '/alertActions', - 'methods' => [ - 'get', + '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 \\"resourceGroupId\\": \\"rg-aek2bhocin5e2na\\"\\n }\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => 'Query prometheus instance list', + 'description' => 'Retrieves a list of Managed Service for Prometheus instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'ListPrometheusViews' => [ + 'summary' => 'Queries the list of Prometheus view instances.', + 'path' => '/prometheus-views', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'alertActionIds', + 'name' => 'prometheusViewIds', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Unique identifier for the action integration.', - 'type' => 'array', - 'items' => [ - 'description' => 'Unique identifier for the action integration.', - 'type' => 'string', - 'required' => false, - 'example' => 'testId', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The list of Prometheus view instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'view-xxx', 'title' => ''], ], [ - 'name' => 'type', + 'name' => 'prometheusViewName', 'in' => 'query', - 'schema' => [ - 'description' => 'Type of the action integration.', - 'type' => 'string', - 'required' => false, - 'example' => 'FC', - 'enum' => [ - 'FC', - 'MNS', - 'OPEN_API', - 'SLS', - 'ESS', - 'PAGER_DUTY', - 'WEBHOOK', - 'EB', - 'FC3', - ], - ], + 'schema' => ['description' => 'The Prometheus view name.', 'type' => 'string', 'required' => false, 'example' => 'view1', 'title' => ''], ], [ - 'name' => 'alertActionName', + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'version', 'in' => 'query', 'schema' => [ - 'description' => 'Name of the action integration.', + 'title' => '', + 'description' => 'The instance version: V1 or V2.', + 'enumValueTitles' => ['V1' => 'V1 version.', 'V2' => 'V2 version.'], 'type' => 'string', + 'enum' => ['V1', 'V2'], 'required' => false, - 'example' => 'testName', + 'example' => 'V2', ], ], [ - 'name' => 'pageNumber', + 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number. Default is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'PROMETHEUSVIEW'], ], [ - 'name' => 'pageSize', + 'name' => 'filterRegionIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size. Default is 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['title' => '', 'description' => 'Filters by region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou,cn-beijing'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3gn5i6bigbi', 'title' => ''], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'total' => [ - 'description' => 'Total number of items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'pageNumber' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], - 'alertActions' => [ - 'description' => 'List of alert action configurations.', - 'type' => 'array', - 'items' => [ - 'description' => 'List of alert action configurations.', - 'type' => 'object', - 'properties' => [ - 'fcParam' => [ - 'description' => 'Function Compute parameters.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'service' => [ - 'description' => 'Function Compute service name.', - 'type' => 'string', - 'example' => 'test', - ], - 'function' => [ - 'description' => 'Function name in the Function Compute service.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'ebParam' => [ - 'description' => 'Event Bridge parameters.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'subject' => [ - 'description' => 'Subject.', - 'type' => 'string', - 'example' => 'test', - ], - 'ebSource' => [ - 'description' => 'Event source.', - 'type' => 'string', - 'example' => 'test', - ], - 'eventBusName' => [ - 'description' => 'Event bus name.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'alertActionId' => [ - 'description' => 'Unique identifier for the action integration.', - 'type' => 'string', - 'example' => 'test', - ], - 'slsParam' => [ - 'description' => 'Log Service parameters.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'project' => [ - 'description' => 'Log Service project name.', - 'type' => 'string', - 'example' => 'test', - ], - 'logstore' => [ - 'description' => 'Logstore name of the Log Service.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'fc3Param' => [ - 'description' => 'Function Compute 3.0 parameters.', - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'function' => [ - 'description' => 'Function name of the Function Compute service.', - 'type' => 'string', - 'example' => 'test', - ], - 'qualifier' => [ - 'description' => 'Version or alias of the function.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'mnsParam' => [ - 'description' => 'Lightweight Message Queue (formerly MNS) parameters.', - 'type' => 'object', - 'properties' => [ - 'mnsType' => [ - 'description' => 'Resource type of the Lightweight Message Queue (formerly MNS).', - 'type' => 'string', - 'example' => 'queue', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'name' => [ - 'description' => 'Resource name.'."\n" - ."\n" - .'- If the resource type is queue, the resource name is the queue name.'."\n" - .'- If the resource type is topic, the resource name is the topic name.', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'pagerDutyParam' => [ - 'description' => 'PagerDuty parameters', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'Integration key for PagerDuty.', - 'type' => 'string', - 'example' => 'fsfer4543t5t65g4t4', - ], - 'url' => [ - 'description' => 'Integration webhook for PagerDuty. Supports V1 and V2 versions.', - 'type' => 'string', - 'example' => 'https://events.pagerduty.com/v2/enqueue', - ], - ], - ], - 'type' => [ - 'description' => 'Action integration type.', - 'type' => 'string', - 'example' => 'FC', - ], - 'webhookParam' => [ - 'description' => 'Webhook parameters', - 'type' => 'object', - 'properties' => [ - 'headers' => [ - 'description' => 'Request headers.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{\'X-Total-Count\': 0}', - 'description' => 'Request headers.', - ], - ], - 'method' => [ - 'description' => 'Webhook request method.', - 'type' => 'string', - 'example' => 'GET', - ], - 'contentType' => [ - 'description' => 'Data format, effective when the request method is POST.', - 'type' => 'string', - 'example' => 'JSON', - ], - 'url' => [ - 'description' => 'The URL address for the alarm callback.', - 'type' => 'string', - 'example' => 'http://www.test.com', - ], - ], - ], - 'essParam' => [ - 'description' => 'Elastic scaling parameters.', - 'type' => 'object', - 'properties' => [ - 'essGroupId' => [ - 'description' => 'Elastic scaling group ID.', - 'type' => 'string', - 'example' => 'testId', - ], - 'regionId' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'essRuleId' => [ - 'description' => 'Elastic scaling rule ID.', - 'type' => 'string', - 'example' => 'testId', - ], - ], - ], - 'alertActionName' => [ - 'description' => 'Alert action name.', - 'type' => 'string', - 'example' => 'testName', - ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The query token.', 'type' => 'string', 'docRequired' => false, 'maxLength' => 128, 'required' => false, 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '10'], + 'nextToken' => ['title' => '', 'description' => 'The token for the next query.', 'type' => 'string', 'maxLength' => 128, 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c'], + 'prometheusViews' => [ + 'description' => 'The list of Prometheus view instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Prometheus view instance.', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['title' => '', 'description' => 'The instance creation time in UTC+0, in the format of yyyy-MM-ddTHH:mmZ.', 'type' => 'string', 'example' => '2025-07-12T02:18:36Z'], + 'instanceType' => ['title' => '', 'description' => 'The instance type:'."\n" + .'prom-view: aggregated view of the new version.'."\n" + .'global-view: aggregated view of the legacy version.', 'type' => 'string', 'example' => 'prom-view'], + 'paymentType' => ['title' => '', 'description' => 'The billing type. Currently, the fixed value is FREE.', 'type' => 'string', 'example' => 'FREE'], + 'product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs (arms or cms).', 'type' => 'string', 'example' => 'cms'], + 'prometheusInstanceCount' => ['title' => '', 'description' => 'The number of Prometheus instances included in the view.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'prometheusViewId' => ['description' => 'The Prometheus view ID.', 'type' => 'string', 'example' => 'view-xxx', 'title' => ''], + 'prometheusViewName' => ['description' => 'The Prometheus view name.', 'type' => 'string', 'example' => 'view1', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-zhangjiakou', 'title' => ''], + 'resourceType' => ['title' => '', 'description' => 'The fixed value: PrometheusView.', 'type' => 'string', 'example' => 'PrometheusView'], + 'status' => ['title' => '', 'description' => 'The backend data storage status.', 'type' => 'string', 'example' => 'Running'], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '123xxx', 'title' => ''], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => 'V2'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'default-cms-1490404746278495-cn-hangzhou'], + 'resourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm3gn5i6bigbi'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + 'totalCount' => ['title' => '', 'description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '66'], ], + 'example' => '', ], ], ], - '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' => 'Query Alert Action Integration', - 'translator' => 'machine', - ], - 'UpdateSubscription' => [ - 'summary' => '更新一个已存在的订阅配置', - 'path' => '/subscriptions/{subscriptionId}', - 'methods' => [ - 'put', + '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 \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => 'List prometheus view instances', + 'description' => 'Queries the list of Prometheus view instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusViews'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'ListPrometheusVirtualInstances' => [ + 'path' => '/virtual-instances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'workspace', + 'name' => 'namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - ], + 'schema' => ['title' => '可选云产品', 'description' => 'The namespace of the cloud product. This parameter is optional.', 'type' => 'string', 'required' => false, 'example' => 'ack-csi-fuse'], ], [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/SubscriptionForModify', - ], + 'name' => 'tenantId', + 'in' => 'query', + 'schema' => ['description' => 'The tenant ID.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'subscriptionId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123123123123', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-******', - ], - 'subscriptionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123123123123', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'instances' => [ + 'description' => 'A list of instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an instance.', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'Returned for the `PROMETHEUS_DS` data source type.'."\n" + ."\n" + .'The Prometheus instance ID.', 'type' => 'string', 'example' => 'rw-b8cfbbe94194ac37fe83f3d2d16a', 'title' => ''], + 'httpApiUrl' => ['description' => 'The HTTP API URL.', 'type' => 'string', 'example' => 'http://xxxxxxxx', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '17073812345', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai-cloudspe', 'title' => ''], + 'namespace' => ['description' => 'Returned for the `CMS_BASIC_QUERY` query type.'."\n" + ."\n" + .'The namespace of the metric.', 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1750315319946', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'title' => '', 'example' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned on each page.', 'type' => 'string', 'title' => '', 'example' => ''], + 'nextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. If all results are returned, this parameter is left empty.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Prometheus Virtual Instance List', + 'summary' => 'Retrieves Prometheus virtual instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusVirtualInstances'], ], - 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:ListPrometheusVirtualInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + '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 \\"totalCount\\": \\"\\",\\n \\"maxResults\\": \\"\\",\\n \\"nextToken\\": \\"\\"\\n}","type":"json"}]', + ], + 'ListServiceRecords' => [ + 'summary' => 'Lists service-linked entries.', + 'path' => '/workspace/{workspace}/service-records', + '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' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', + 'name' => 'recordType', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The type of the linked entry. Currently supported:'."\n" + .'logCorrelation, which indicates application log association.', + 'type' => 'string', + 'required' => true, + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', ], ], - 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => ['description' => 'The filter information for service-linked entries.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "serviceName": "my-service",'."\n" + .' "storeName": "my-logstore"'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0'], + 'nextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'title' => ''], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'records' => [ + 'description' => 'The list of ticket operation records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The record information.', + 'type' => 'object', + 'properties' => [ + 'serviceId' => ['title' => '', 'description' => 'The unique identifier of the service.', 'type' => 'string', 'example' => 'gaddp9ap8q@f8ca37734da3eda787dbb'], + 'recordType' => ['title' => '', 'description' => 'The type of the linked entry. Currently supported:'."\n" + .'logCorrelation, which indicates application log association.', 'type' => 'string', 'example' => 'logCorrelation'], + 'recordContent' => ['title' => '', 'description' => 'The entry content in JSON string format. The format varies depending on the recordType.', 'type' => 'string', 'example' => '{'."\n" + .' "project": "proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou",'."\n" + .' "storeName": "app-biz-log",'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "bindType": "logstore",'."\n" + .' "traceIdRelateField": ""'."\n" + .'}'], + 'workspace' => ['title' => '', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'workspace-test'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List service-linked entries', + 'description' => 'Queries a paginated list of service-linked entries.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-******\\",\\n \\"subscriptionId\\": \\"123123123123\\"\\n}","type":"json"}]', - 'title' => 'UpdateSubscription', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0\\",\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"totalCount\\": 100,\\n \\"maxResults\\": 100,\\n \\"records\\": [\\n {\\n \\"serviceId\\": \\"gaddp9ap8q@f8ca37734da3eda787dbb\\",\\n \\"recordType\\": \\"logCorrelation\\",\\n \\"recordContent\\": \\"{\\\\n \\\\\\"project\\\\\\": \\\\\\"proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou\\\\\\",\\\\n \\\\\\"storeName\\\\\\": \\\\\\"app-biz-log\\\\\\",\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"bindType\\\\\\": \\\\\\"logstore\\\\\\",\\\\n \\\\\\"traceIdRelateField\\\\\\": \\\\\\"\\\\\\"\\\\n}\\",\\n \\"workspace\\": \\"workspace-test\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateAlertWebhook' => [ - 'summary' => '创建Webhook', - 'path' => '/webhook', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListServices' => [ + 'summary' => 'Queries a list of application observability services.', + 'path' => '/workspace/{workspace}/services', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results. If this parameter is empty, it means you have reached the last page.', 'type' => 'string', 'example' => '7-b81a-4bc9-bbfa-a50cc6988667', 'title' => '', 'required' => false], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The maximum number of records to return for this request.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '500', 'minimum' => '0', 'exclusiveMinimum' => false, 'example' => '10', 'title' => '', 'required' => false], + ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'serviceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service type.', + 'type' => 'string', + 'required' => false, + 'example' => 'TRACE', + 'enum' => ['TRACE', 'XTRACE', 'RUM'], + 'title' => '', + ], + ], + [ + 'name' => 'serviceName', + 'in' => 'query', + 'schema' => ['description' => 'The application service name.', 'type' => 'string', 'example' => 'app-demo', 'title' => '', 'required' => false], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz', 'title' => '', 'required' => false], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'contentType' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh_CN', - 'enum' => [ - 'zh_CN', - 'en_US', - ], - ], - 'method' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - 'default' => 'POST', - 'enum' => [ - 'GET', - 'POST', - ], - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'url' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://aliyun.com/test', - ], - 'webhookId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'evn', 'title' => '', 'required' => false], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'prod', 'title' => '', 'required' => false], ], + 'title' => '', + 'description' => 'The tag.', + 'required' => false, + 'example' => '', ], + 'title' => '', + 'description' => 'An array of tags.', 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'alertWebhookId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', 'title' => ''], + 'nextToken' => ['description' => 'The paging token.', 'type' => 'string', 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', 'title' => ''], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '66', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results returned. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'services' => [ + 'description' => 'A list of service information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The service information.', + 'type' => 'object', + 'properties' => [ + 'serviceId' => ['description' => 'The service ID.', 'type' => 'string', 'example' => 'jm2pl0yoqf@d4905cb11a4f218dfb0a8', 'title' => ''], + 'serviceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'demo-app', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-07-01T02:23:59Z', 'title' => ''], + 'serviceType' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'TRACE', 'title' => ''], + 'serviceStatus' => ['description' => 'The service status. This parameter is valid only when serviceType is RUM.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'displayName' => ['description' => 'The display name. This parameter is valid only when serviceType is RUM.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'pid' => ['description' => 'The ID of the ARMS application for backward compatibility.', 'type' => 'string', 'example' => 'kgcsf@192197e828d51aa', 'title' => ''], + 'description' => ['description' => 'The service description. This parameter is valid only when serviceType is RUM.', 'type' => 'string', 'example' => 'workspace api monitor test', 'title' => ''], + 'attributes' => ['description' => 'Additional information.', 'type' => 'string', 'example' => '{"language":"java"}', 'title' => ''], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'default-cms-1192928460540589-cn-hangzhou', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekxxzuad5zzzz', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resource already exist .', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + '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' => 'Batch Query Application Observability Services', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServices'], ], - 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"alertWebhookId\\": \\"test\\"\\n}","type":"json"}]', - 'title' => 'CreateAlertWebhook', ], - 'DeleteAlertWebhooks' => [ - 'summary' => '删除Webhook', - 'path' => '/webhooks', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags attached to resources.', + 'path' => '/tags', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'webhookIds', + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Service'], + ], + [ + 'name' => 'resourceId', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'required' => true, + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'required' => false, + 'title' => '', + 'description' => 'A list of resource IDs.', + 'example' => '', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => ['description' => 'The tags. These are used as filter conditions for the query.'."\n" + ."\n" + .'You can specify up to 20 tags.', '$ref' => '#/components/schemas/Tag', 'required' => false, 'title' => '', 'example' => ''], + 'title' => '', + 'description' => 'The tags. These are used as filter conditions for the query.'."\n" + ."\n" + .'You can specify up to 20 tags.', + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxxxxxxxx'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-***'], + 'maxResults' => ['description' => 'The maximum number of results to return. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'nextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'title' => '', 'example' => 'xxxxxxxxxx'], + 'tagResources' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'env'], + 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'resourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'resourceType' => ['description' => 'The resource type.', 'type' => 'string', 'title' => '', 'example' => 'Service'], + ], + 'description' => 'A list of tags.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'description' => 'A list of tags.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceIdsOrTags', 'errorMessage' => 'You must specify ResourceId.N or Tags.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => ''], + ['errorCode' => 'MissingParameter.TagKey', 'errorMessage' => 'You must specify Tag.N.Key.', 'description' => ''], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', 'description' => ''], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => ''], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => ''], + ['errorCode' => 'InvalidParameter.NextToken', 'errorMessage' => 'The NextToken parameter is invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListTagResources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', - 'title' => 'DeleteAlertWebhooks', + 'ramActions' => [], + '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"}]', ], - 'ListAlertWebhooks' => [ - 'summary' => '查询Webhook', - 'path' => '/webhooks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkspaces' => [ + 'summary' => 'Retrieves a list of workspaces.', + 'path' => '/workspace', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcms5OJOSH'], ], 'parameters' => [ [ - 'name' => 'pageSize', + 'name' => 'workspaceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'The name of the workspace. This parameter supports fuzzy search.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace-test-001'], ], [ - 'name' => 'pageNumber', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'xxxxxxxxxx'], ], [ - 'name' => 'webhookIds', + 'name' => 'maxResults', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 50. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '0', 'default' => '100', 'title' => '', 'example' => '10'], + ], + [ + 'name' => 'workspaceNameList', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', + 'description' => 'The names of the workspaces. This parameter supports exact search.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'items' => ['description' => 'The name of a workspace. This parameter supports exact search.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace-test-001'], 'required' => false, + 'example' => 'workspace-test-001', + 'title' => '', ], ], [ - 'name' => 'name', + 'name' => 'region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-heyuan'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'pageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8A33DBEA-*****-*****-*****-*****', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'webhooks' => [ - 'description' => 'webhooks', + 'maxResults' => ['description' => 'The number of entries returned per page. Default value: 50. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'nextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'xxxxxxxxxx'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'total' => ['title' => '当总结果个数大于MaxResults时，用于翻页的token。', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'workspaces' => [ + 'title' => '数组，返回示例目录。', + 'description' => 'The list of workspaces.', 'type' => 'array', 'items' => [ - 'description' => 'webhook', + 'title' => 'WorkspaceItemType', + 'description' => 'WorkspaceItemType', 'type' => 'object', 'properties' => [ - 'contentType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'JSON', - ], - 'headers' => [ - 'description' => 'headers', - 'type' => 'object', - 'example' => 'key', - ], - 'lang' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zh_CN', - ], - 'method' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'GET', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://aliyun.com/test', - ], - 'webhookId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], + 'createTime' => ['description' => 'The time when the workspace was created.', 'type' => 'string', 'format' => 'iso8601_normal', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'displayName' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], + 'description' => ['title' => '工作空间描述', 'description' => 'The description of the workspace.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'workspace test'], + 'lastModifyTime' => ['description' => 'The time when the workspace was last modified.', 'type' => 'string', 'format' => 'iso8601_normal', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'regionId' => ['title' => '地域ID', 'description' => 'The ID of the region.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'cn-heyuan'], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'pattern' => '', 'default' => '', 'example' => 'sls-project-test-001'], + 'workspaceName' => ['title' => '工作空间名称', 'description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'pattern' => '', 'default' => '', 'example' => 'workspace-test-001'], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Workspace List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:ListWorkspaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms::{#accountId}:workspace/*'], + ], ], ], ], + '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"}]', + ], + 'ManageAlertRules' => [ + 'summary' => 'Manages alert rules.', + 'path' => '/manageAlertRules', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The request body for managing alert rules. This body is shared by CREATE, UPDATE, PATCH, and BATCH_DELETE operations. Specify fields based on the action.', '$ref' => '#/components/schemas/ManageAlertRulesUnifiedActionInput', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The response for managing alert rules.', '$ref' => '#/components/schemas/ServerResponseManageAlertRulesResult', 'title' => '', 'example' => ''], + ], + ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => 'The parameter is invalid.'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'A service runtime error occurred.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Manage alert rules', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"alertRule\\": {\\n \\"uuid\\": \\"\\",\\n \\"createdAt\\": \\"\\",\\n \\"updatedAt\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"contentTemplate\\": \\"\\",\\n \\"enabled\\": false,\\n \\"datasourceConfig\\": {\\n \\"type\\": \\"\\",\\n \\"instanceId\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"productCategory\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"queryConfig\\": {\\n \\"type\\": \\"\\",\\n \\"expr\\": \\"\\",\\n \\"promQl\\": \\"\\",\\n \\"enableDataCompleteCheck\\": false,\\n \\"metricSet\\": \\"\\",\\n \\"metric\\": \\"\\",\\n \\"queries\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"metricSet\\": \\"\\",\\n \\"metric\\": \\"\\",\\n \\"labelFilters\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\",\\n \\"operator\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"logSet\\": \\"\\",\\n \\"windowSecs\\": 0,\\n \\"offsetSecs\\": 0,\\n \\"aggregate\\": \\"\\",\\n \\"entityDomain\\": \\"\\",\\n \\"entityType\\": \\"\\",\\n \\"entityFilters\\": [\\n {\\n \\"field\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"labelFilters\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\",\\n \\"operator\\": \\"\\"\\n }\\n ],\\n \\"entityFields\\": [\\n {\\n \\"field\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"serviceIdList\\": [\\n \\"\\"\\n ],\\n \\"filterList\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"measureList\\": [\\n {\\n \\"measureCode\\": \\"\\",\\n \\"windowSecs\\": 0,\\n \\"groupBy\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"namespace\\": \\"\\",\\n \\"relationType\\": \\"\\",\\n \\"dimensions\\": [\\n {\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"groupId\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"conditionConfig\\": {\\n \\"type\\": \\"\\",\\n \\"durationSecs\\": 0,\\n \\"severity\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0,\\n \\"aggregate\\": \\"\\",\\n \\"matchField\\": \\"\\",\\n \\"matchOperator\\": \\"\\",\\n \\"matchValue\\": \\"\\",\\n \\"countOperator\\": \\"\\",\\n \\"countThreshold\\": 0,\\n \\"thresholdList\\": [\\n {\\n \\"severity\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0\\n }\\n ],\\n \\"compareList\\": [\\n {\\n \\"aggregate\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"yoyTimeUnit\\": \\"\\",\\n \\"yoyTimeValue\\": 0\\n }\\n ],\\n \\"relation\\": \\"\\",\\n \\"escalationType\\": \\"\\",\\n \\"simpleEscalation\\": {\\n \\"metricName\\": \\"\\",\\n \\"period\\": 0,\\n \\"escalations\\": [\\n {\\n \\"comparisonOperator\\": \\"\\",\\n \\"statistics\\": \\"\\",\\n \\"threshold\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"times\\": 0,\\n \\"preCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"compositeEscalation\\": {\\n \\"relation\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"times\\": 0,\\n \\"escalations\\": [\\n {\\n \\"comparisonOperator\\": \\"\\",\\n \\"metricName\\": \\"\\",\\n \\"period\\": 0,\\n \\"statistics\\": \\"\\",\\n \\"threshold\\": \\"\\",\\n \\"preCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"expressEscalation\\": {\\n \\"times\\": 0,\\n \\"severity\\": \\"\\",\\n \\"rawExpression\\": \\"\\"\\n },\\n \\"prometheus\\": {\\n \\"severity\\": \\"\\",\\n \\"promQl\\": \\"\\",\\n \\"times\\": 0\\n },\\n \\"noDataPolicy\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"yoyTimeUnit\\": \\"\\",\\n \\"yoyTimeValue\\": 0,\\n \\"triggers\\": [\\n {\\n \\"severity\\": \\"\\",\\n \\"durationSecs\\": 0,\\n \\"expressionType\\": \\"\\",\\n \\"queryName\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0,\\n \\"logicOperator\\": \\"\\",\\n \\"conditions\\": [\\n {\\n \\"expressionType\\": \\"\\",\\n \\"queryName\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0\\n }\\n ]\\n }\\n ],\\n \\"enableSeveritySuppression\\": false,\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"scheduleConfig\\": {\\n \\"type\\": \\"\\",\\n \\"intervalSecs\\": 0\\n },\\n \\"notifyConfig\\": {\\n \\"type\\": \\"\\",\\n \\"channels\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"identifiers\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"silenceTimeSecs\\": 0,\\n \\"activeDays\\": [\\n 0\\n ],\\n \\"activeStartTime\\": \\"\\",\\n \\"activeEndTime\\": \\"\\",\\n \\"utcOffset\\": \\"\\",\\n \\"notifyStrategies\\": [\\n \\"\\"\\n ]\\n },\\n \\"actionIntegrationConfig\\": {\\n \\"enabled\\": false,\\n \\"actions\\": [\\n \\"\\"\\n ]\\n },\\n \\"armsIntegrationConfig\\": {\\n \\"enabled\\": false\\n },\\n \\"labels\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"annotations\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"datasourceType\\": \\"\\",\\n \\"observeResourceType\\": \\"\\",\\n \\"observeResourceGlobalScope\\": false,\\n \\"observeResourceList\\": [\\n \\"\\"\\n ],\\n \\"severityLevels\\": \\"\\",\\n \\"notifyStrategyId\\": \\"\\",\\n \\"partitionKey\\": \\"\\"\\n },\\n \\"deletedCount\\": 0,\\n \\"deletedUuidList\\": [\\n \\"\\"\\n ],\\n \\"updatedCount\\": 0,\\n \\"updatedUuidList\\": [\\n \\"\\"\\n ]\\n },\\n \\"code\\": \\"\\",\\n \\"success\\": false,\\n \\"requestId\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"total\\": 0,\\n \\"pageSize\\": 0,\\n \\"pageNumber\\": 0,\\n \\"nextToken\\": \\"\\"\\n}","type":"json"}]', + ], + 'OpenCmsService' => [ + 'summary' => 'Activates CloudMonitor services, including Hybrid Cloud Monitoring, Managed Service for Prometheus, and Simple Log Service (SLS).', + 'path' => '/cmsservice', + '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' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'enabled' => ['description' => 'Indicates whether the service or commodity is activated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Activate cloudMonitor services', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:OpenCmsService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'CmsService', 'arn' => 'acs:cms:*:{#accountId}:cmsservice/*'], + ], ], - ], - 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'additionalActions' => [ + ['action' => 'log:EnableService', 'validationType' => 'always'], + ['action' => 'arms:OpenArmsService', 'validationType' => 'always'], ], ], ], - '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' => 'ListAlertWebhooks', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"enabled\\": true\\n}","type":"json"}]', ], - 'UpdateAlertWebhook' => [ - 'summary' => '修改已存在的告警 Webhook 通知配置。', - 'path' => '/webhook/{webhookId}', - 'methods' => [ - 'patch', - ], - 'schemes' => [ - 'https', - ], + 'PutWorkspace' => [ + 'path' => '/workspace/{workspaceName}', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ - [ - 'name' => 'webhookId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => 'body参数', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'contentType' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh_CN', - 'enum' => [ - 'zh_CN', - 'en_US', - ], - ], - 'method' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - 'enum' => [ - 'GET', - 'POST', - ], - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'url' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://aliyun.com/test', - ], + 'displayName' => ['title' => '', 'description' => 'The display name of the workspace.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'example' => 'workspace-test'], + 'description' => ['title' => '工作空间描述', 'description' => 'The description of the workspace.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'pattern' => '', 'default' => '', 'example' => 'workspace test'], + 'slsProject' => ['title' => '日志服务项目名称', 'description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'default' => '', 'example' => 'sls-project-test-001'], ], 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 56, 'minLength' => 1, 'title' => '', 'example' => 'workspace-test-001'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8A33DBEA-*****-*****-*****-*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'workspaceName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test-001'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create or Modify Workspace', + 'summary' => 'Creates a workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutWorkspace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Workspace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspaceName}'], ], ], + 'additionalActions' => [], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', + ], + 'QueryAlertRules' => [ + 'path' => '/queryAlertRules', + 'methods' => ['post'], + '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' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The token that marks the position from which you want to start reading data. If you leave this parameter empty, data is read from the beginning.', 'type' => 'string', 'required' => false, 'example' => '123456'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The maximum number of data records to read in this request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The idempotency token.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx-xxxx-xxxx'], + ], + [ + 'name' => 'body', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The request body for querying alert rules.', '$ref' => '#/components/schemas/QueryAlertRulesInput', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The response for querying alert rules.', '$ref' => '#/components/schemas/ServerResponseQueryAlertRulesResult', 'title' => '', 'example' => ''], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s is missing or invalid.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => 'The request parameters are invalid or required parameters are missing (such as GroupName, WorkspaceId, GroupId, or region being empty).'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => 'The parameter is invalid.'], ], - 404 => [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource %s is not found.', - ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => 'A service runtime error occurred.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query alert rules', + 'summary' => 'Queries alert rules.', + 'description' => 'This topic provides an example on how to query a list of alert templates. The response shows that the alert template list contains two alert templates: `ECS_Template1` and `ECS_Template2`.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\"\\n}","type":"json"}]', - 'title' => 'UpdateAlertWebhook', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"totalCount\\": 0,\\n \\"alertRules\\": [\\n {\\n \\"uuid\\": \\"\\",\\n \\"createdAt\\": \\"\\",\\n \\"updatedAt\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"displayName\\": \\"\\",\\n \\"contentTemplate\\": \\"\\",\\n \\"enabled\\": false,\\n \\"datasourceConfig\\": {\\n \\"type\\": \\"\\",\\n \\"instanceId\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"productCategory\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"queryConfig\\": {\\n \\"type\\": \\"\\",\\n \\"expr\\": \\"\\",\\n \\"promQl\\": \\"\\",\\n \\"enableDataCompleteCheck\\": false,\\n \\"metricSet\\": \\"\\",\\n \\"metric\\": \\"\\",\\n \\"queries\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"metricSet\\": \\"\\",\\n \\"metric\\": \\"\\",\\n \\"labelFilters\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\",\\n \\"operator\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"logSet\\": \\"\\",\\n \\"windowSecs\\": 0,\\n \\"offsetSecs\\": 0,\\n \\"aggregate\\": \\"\\",\\n \\"entityDomain\\": \\"\\",\\n \\"entityType\\": \\"\\",\\n \\"entityFilters\\": [\\n {\\n \\"field\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"labelFilters\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\",\\n \\"operator\\": \\"\\"\\n }\\n ],\\n \\"entityFields\\": [\\n {\\n \\"field\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"serviceIdList\\": [\\n \\"\\"\\n ],\\n \\"filterList\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"measureList\\": [\\n {\\n \\"measureCode\\": \\"\\",\\n \\"windowSecs\\": 0,\\n \\"groupBy\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"namespace\\": \\"\\",\\n \\"relationType\\": \\"\\",\\n \\"dimensions\\": [\\n {\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"groupId\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"conditionConfig\\": {\\n \\"type\\": \\"\\",\\n \\"durationSecs\\": 0,\\n \\"severity\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0,\\n \\"aggregate\\": \\"\\",\\n \\"matchField\\": \\"\\",\\n \\"matchOperator\\": \\"\\",\\n \\"matchValue\\": \\"\\",\\n \\"countOperator\\": \\"\\",\\n \\"countThreshold\\": 0,\\n \\"thresholdList\\": [\\n {\\n \\"severity\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0\\n }\\n ],\\n \\"compareList\\": [\\n {\\n \\"aggregate\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"yoyTimeUnit\\": \\"\\",\\n \\"yoyTimeValue\\": 0\\n }\\n ],\\n \\"relation\\": \\"\\",\\n \\"escalationType\\": \\"\\",\\n \\"simpleEscalation\\": {\\n \\"metricName\\": \\"\\",\\n \\"period\\": 0,\\n \\"escalations\\": [\\n {\\n \\"comparisonOperator\\": \\"\\",\\n \\"statistics\\": \\"\\",\\n \\"threshold\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"times\\": 0,\\n \\"preCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"compositeEscalation\\": {\\n \\"relation\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"times\\": 0,\\n \\"escalations\\": [\\n {\\n \\"comparisonOperator\\": \\"\\",\\n \\"metricName\\": \\"\\",\\n \\"period\\": 0,\\n \\"statistics\\": \\"\\",\\n \\"threshold\\": \\"\\",\\n \\"preCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"expressEscalation\\": {\\n \\"times\\": 0,\\n \\"severity\\": \\"\\",\\n \\"rawExpression\\": \\"\\"\\n },\\n \\"prometheus\\": {\\n \\"severity\\": \\"\\",\\n \\"promQl\\": \\"\\",\\n \\"times\\": 0\\n },\\n \\"noDataPolicy\\": \\"\\",\\n \\"legacyType\\": \\"\\",\\n \\"yoyTimeUnit\\": \\"\\",\\n \\"yoyTimeValue\\": 0,\\n \\"triggers\\": [\\n {\\n \\"severity\\": \\"\\",\\n \\"durationSecs\\": 0,\\n \\"expressionType\\": \\"\\",\\n \\"queryName\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0,\\n \\"logicOperator\\": \\"\\",\\n \\"conditions\\": [\\n {\\n \\"expressionType\\": \\"\\",\\n \\"queryName\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"threshold\\": 0,\\n \\"min\\": 0,\\n \\"max\\": 0\\n }\\n ]\\n }\\n ],\\n \\"enableSeveritySuppression\\": false,\\n \\"legacyRaw\\": \\"\\"\\n },\\n \\"scheduleConfig\\": {\\n \\"type\\": \\"\\",\\n \\"intervalSecs\\": 0\\n },\\n \\"notifyConfig\\": {\\n \\"type\\": \\"\\",\\n \\"channels\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"identifiers\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"silenceTimeSecs\\": 0,\\n \\"activeDays\\": [\\n 0\\n ],\\n \\"activeStartTime\\": \\"\\",\\n \\"activeEndTime\\": \\"\\",\\n \\"utcOffset\\": \\"\\",\\n \\"notifyStrategies\\": [\\n \\"\\"\\n ]\\n },\\n \\"actionIntegrationConfig\\": {\\n \\"enabled\\": false,\\n \\"actions\\": [\\n \\"\\"\\n ]\\n },\\n \\"armsIntegrationConfig\\": {\\n \\"enabled\\": false\\n },\\n \\"labels\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"annotations\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"datasourceType\\": \\"\\",\\n \\"observeResourceType\\": \\"\\",\\n \\"observeResourceGlobalScope\\": false,\\n \\"observeResourceList\\": [\\n \\"\\"\\n ],\\n \\"severityLevels\\": \\"\\",\\n \\"notifyStrategyId\\": \\"\\",\\n \\"partitionKey\\": \\"\\"\\n }\\n ]\\n },\\n \\"code\\": \\"\\",\\n \\"success\\": false,\\n \\"requestId\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"total\\": 0,\\n \\"pageSize\\": 0,\\n \\"pageNumber\\": 0,\\n \\"nextToken\\": \\"\\"\\n}","type":"json"}]', ], - 'UpdateNotifyStrategy' => [ - 'summary' => '修改已存在的告警通知策略', - 'path' => '/notifyStrategies/{notifyStrategyId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'SearchContext' => [ + 'summary' => 'Search context.', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context/search', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-test', - 'title' => '工作空间', - ], + 'in' => 'path', + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'Context store name', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'query' => ['description' => 'Query content', 'type' => 'string', 'required' => true, 'example' => 'How is the cost for consuming SLS logs in Flink calculated?', 'title' => ''], + 'formatted' => ['description' => 'Whether to format', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'filter' => [ + 'description' => 'Filter conditions', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'Filter conditions', 'type' => 'any', 'example' => '{'."\n" + .' "metadata.serviceName": "sls-sop-daily",'."\n" + .' "metadata.taskType": {'."\n" + .' "in": ["troubleshooting", "knowledge_retrieval"]'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'limit' => ['description' => 'Limit the number of items returned', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'threshold' => ['description' => 'Similarity threshold', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.3', 'title' => ''], + 'retrievalOption' => ['description' => 'Retrieval option', 'type' => 'string', 'required' => false, 'example' => 'reranker,llm_rank', 'title' => ''], + ], 'required' => false, - '$ref' => '#/components/schemas/NotifyStrategyForModify', - ], - ], - [ - 'name' => 'notifyStrategyId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12312-31-23-123-1-23123', - 'title' => '通知策略ID', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response data', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'notifyStrategyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12312-31-23-123-1-23123', - 'title' => '通知策略ID', + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '123-0F43-23423-AC43-34234', 'title' => ''], + 'results' => [ + 'description' => 'Return value', + 'type' => 'array', + 'items' => [ + 'description' => 'Return value', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Return value', 'type' => 'any', 'example' => '{}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Search context', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:SearchContext', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'ContextStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/contextstore/{#contextStoreName}'], + ], ], ], ], - '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' => 'UpdateNotifyStrategy', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"results\\": [\\n {\\n \\"key\\": \\"{}\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateTicket' => [ - 'summary' => 'Create Ticket', - 'path' => '/tickets', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SearchMemories' => [ + 'summary' => 'Searches for memories based on query conditions and filters.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/search', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'expirationTime', - 'in' => 'query', - 'schema' => [ - 'description' => '- Expiration time (in seconds), which is the expiration time for the embedded page URL. The default value is 86400 seconds (one day), and the range of values is from 0 to 2592000 seconds (30 days).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'accessTokenExpirationTime', - 'in' => 'query', + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'qianyi_test_1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '- Access token expiration time (in seconds), which is the expiration time for the user to access the page interface. The default value is 86400 seconds (one day), and the range of values is from 0 to 86400 seconds (one day).'."\n" - .'- The access token expiration time is the minimum value between `accessTokenExpirationTime` and `expirationTime`.'."\n" - .'- If called through STS, the access token expiration time (i.e., the time during which the user can access the page interface) is the minimum value among `accessTokenExpirationTime`, `expirationTime`, and the STS expiration time.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'query' => ['description' => 'The query content.', 'type' => 'string', 'required' => false, 'example' => 'What I like', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'test_session_001', 'title' => ''], + 'topK' => ['description' => 'The top-K entries to return in the results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'agentId' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'example' => '972772996913709056', 'title' => ''], + 'appId' => ['description' => 'The app key of the project assigned by the merchant.', 'type' => 'string', 'required' => false, 'example' => 'mm_480d961a1b5e4efe84603f4cbc0f', 'title' => ''], + 'runId' => ['description' => 'The run ID.', 'type' => 'string', 'required' => false, 'example' => 'test_session_001', 'title' => ''], + 'rerank' => ['description' => 'Specifies whether to enable reranking.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'filters' => [ + 'title' => '', + 'description' => 'The filter conditions.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['title' => '', 'description' => 'The filter conditions.', 'type' => 'any', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '', + ], + 'threshold' => ['title' => '', 'description' => 'The similarity threshold.', 'type' => 'number', 'format' => 'double', 'example' => '0.3', 'required' => false], + 'retrievalOption' => ['title' => '', 'description' => 'The retrieval option.', 'type' => 'string', 'example' => 'reranker,llm_rank', 'required' => false], + 'searchType' => ['title' => '', 'description' => 'The search type.', 'type' => 'string', 'example' => 'experience', 'required' => false], + ], 'required' => false, - 'example' => '600', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returned structure.', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'ticket' => [ - 'title' => 'Id of the request', - 'description' => '免登录票据。', - 'type' => 'string', - 'example' => 'eyJ***************.eyJ******************.KUT****************', + 'results' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'actorId' => ['description' => 'The actor ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'agentId' => ['description' => 'The agent ID of the application.', 'type' => 'string', 'example' => '972772996913709056', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1762773128968', 'title' => ''], + 'hash' => ['description' => 'The memory hash value.', 'type' => 'string', 'example' => 'd791bf27236c5532056a13279baad3517042bb8d5b1bdb02e7871fa632debffe', 'title' => ''], + 'id' => ['description' => 'The memory ID.', 'type' => 'string', 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], + 'memory' => ['description' => 'The memory content.', 'type' => 'string', 'example' => 'My name is Zhang San and I live in Hangzhou.', 'title' => ''], + 'metadata' => [ + 'title' => '', + 'description' => 'The metadata.', + 'type' => 'object', + 'additionalProperties' => ['title' => '', 'description' => 'The metadata.', 'type' => 'any', 'example' => '{"__strategy_type__":"Fact"}'], + 'example' => '{"__strategy_type__":"Fact"}', + ], + 'role' => ['description' => 'The role that initiated the message.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'runId' => ['description' => 'The run ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + 'score' => ['description' => 'The similarity score.', 'type' => 'number', 'format' => 'double', 'example' => '13.21', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'string', 'example' => '1764902557784', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'test_session_001', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'relations' => [ + 'description' => 'The relations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The relations.', + 'type' => 'object', + 'properties' => [ + 'destination' => ['description' => 'The destination.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'relationship' => ['description' => 'The relations.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'source' => ['description' => 'The source.', 'type' => 'string', 'example' => 'todo_open_dingoj06pvqfeayy3lkr', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Search memories', + 'description' => 'This topic provides an example on how to create a threshold alert rule for the cpu_total metric of the Elastic Computing Service `acs_ecs_dashboard` instance `i-uf6j91r34rnwawoo****`. The alert contact group of the alert rule is `ECS_Group`, the alert rule name is `test123`, the alert rule ID is `a151cd6023eacee2f0978e03863cc1697c89508****`, the statistical method for the Critical level is `Average`, the comparison operator for the Critical level is `GreaterThanOrEqualToThreshold`, the threshold for the Critical level is `90`, and the retry count for the Critical level is `3`.'."\n" + .'> 2024-08-15: Statistics validation is added. Only the Statistics value that corresponds to the metric can be specified. For information about how to obtain the value of this parameter, see [Cloud service monitoring metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', - 'title' => 'Create Login-free Ticket', - 'translator' => 'machine', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"results\\": [\\n {\\n \\"actorId\\": \\"test_session_001\\",\\n \\"agentId\\": \\"972772996913709056\\",\\n \\"createdAt\\": \\"1762773128968\\",\\n \\"hash\\": \\"d791bf27236c5532056a13279baad3517042bb8d5b1bdb02e7871fa632debffe\\",\\n \\"id\\": \\"019ca1e5-7307-7d50-b943-5e628326a8ed\\",\\n \\"memory\\": \\"My name is Zhang San and I live in Hangzhou.\\",\\n \\"metadata\\": {\\n \\"key\\": \\"{\\\\\\"__strategy_type__\\\\\\":\\\\\\"Fact\\\\\\"}\\"\\n },\\n \\"role\\": \\"user\\",\\n \\"runId\\": \\"test_session_001\\",\\n \\"score\\": 13.21,\\n \\"updatedAt\\": \\"1764902557784\\",\\n \\"userId\\": \\"test_session_001\\"\\n }\\n ],\\n \\"relations\\": [\\n {\\n \\"destination\\": \\"test\\",\\n \\"relationship\\": \\"test\\",\\n \\"source\\": \\"todo_open_dingoj06pvqfeayy3lkr\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], 'TagResources' => [ - 'summary' => '打标签接口', 'path' => '/tags', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + 'resourceType' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Service'], 'resourceId' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['description' => 'A resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => true, 'maxItems' => 50, 'minItems' => 1, + 'title' => '', + 'description' => 'A list of resource IDs.', + 'example' => '', ], 'tag' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Tag', - ], + 'items' => ['description' => 'A tag.', '$ref' => '#/components/schemas/Tag', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'maxItems' => 20, + 'title' => '', + 'description' => 'The tags.'."\n" + ."\n" + .'You can attach a maximum of 20 tags.', + 'example' => '', ], ], 'required' => false, + 'description' => 'The request body.', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The ResourceId parameter is invalid.', 'description' => ''], + ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds are not found in our records.', 'description' => ''], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', 'description' => ''], + ['errorCode' => 'InvalidParameter.RegionId', 'errorMessage' => 'The RegionId parameter is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'You must specify ResourceId.N.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => ''], + ['errorCode' => 'MissingParameter.Tags', 'errorMessage' => 'You must specify Tags.', 'description' => ''], + ['errorCode' => 'MissingParameter.TagKey', 'errorMessage' => 'You must specify Tag.N.Key.', 'description' => ''], + ['errorCode' => 'MissingParameter.TagValue', 'errorMessage' => 'You must specify Tag.N.Value.', 'description' => ''], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => ''], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => ''], + ['errorCode' => 'QuotaExceed.TagsPerResource', 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', 'description' => ''], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'The operator is not permission for this operate', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InvalidOperation.ConcurrentModification', - 'errorMessage' => 'The resource is modified concurrently.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InvalidOperation.ConcurrentModification', 'errorMessage' => 'The resource is modified concurrently.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'TagResources', + 'summary' => 'Adds tags to one or more resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\"\\n}","type":"json"}]', ], 'UntagResources' => [ - 'summary' => '删标签接口', 'path' => '/tags', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Service', - ], + 'schema' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Service'], ], [ 'name' => 'resourceId', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => true, 'maxItems' => 50, 'minItems' => 1, + 'title' => '', + 'description' => 'A list of resource IDs.', + 'example' => '', ], ], [ @@ -21076,374 +18651,476 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '对应标签键列表，最多包含20个子项', - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], + 'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'title' => '', + 'description' => 'The tag key.'."\n" + ."\n" + .'You can detach tags with up to 20 tag keys.', 'required' => false, + 'example' => '', ], ], [ 'name' => 'all', 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to remove all tags from the specified resources. Valid values:'."\n" + ."\n" + .'false (default): No'."\n" + .'true: Yes', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], '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' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'You must specify ResourceId.N.', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'You must specify ResourceType.', 'description' => ''], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter.TagKeysOrDeleteAll', 'errorMessage' => 'The TagKeys or DeleteAll parameter is invalid.', 'description' => ''], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', 'description' => ''], + ['errorCode' => 'NumberExceed.TagKeys', 'errorMessage' => 'The maximum number of TagKeys is exceeded.', 'description' => ''], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => ''], + ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds are not found in our records.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'The operator is not permission for this operate ', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UntagResources', + 'summary' => 'Deletes a tag', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'UpdateAddonRelease' => [ + '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' => 'The name of the release.', 'type' => 'string', 'required' => true, 'example' => 'test-gpu-integration-name'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'addonVersion' => ['title' => 'Addon 的版本信息。', 'description' => 'The version of the add-on.', 'type' => 'string', 'required' => false, 'example' => '0.0.2'], + 'dryRun' => [ + 'title' => '是否预检本次请求。', + 'description' => 'Specifies whether to perform a dry run for the request.', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => 'Performs a dry run.', 'false' => 'Performs the actual request.'], + 'example' => 'true', + ], + 'values' => ['title' => '元数据信息。', 'description' => 'The metadata.', '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' => 'The entity discovery rules.', 'required' => false, '$ref' => '#/components/schemas/EntityDiscoverRule', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - [ - 'errorCode' => 'NumberExceed.TagKeys', - 'errorMessage' => 'The maximum number of TagKeys is exceeded.', + ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => ['title' => '策略环境 ID。', 'description' => 'The ID of the policy environment.', 'type' => 'string', 'required' => true, 'example' => 'policy-xxxxxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9F00A7AF-2728-5424-B321-79D39C00A1EC'], + ], + 'example' => '', ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Access Component Configuration', + 'summary' => 'Upgrades an add-on component.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddonRelease'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AddonRelease', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#PolicyId}/addonrelease/{#ReleaseName}'], + ], ], - [ - 'errorCode' => 'InvalidResourceId.NotFound', - 'errorMessage' => 'The specified ResourceIds are not found in our records.', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F00A7AF-2728-5424-B321-79D39C00A1EC\\"\\n}","type":"json"}]', + ], + 'UpdateAggTaskGroup' => [ + 'summary' => 'Updates an aggregation task group.', + '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' => 'The ID of the Prometheus instance to which the aggregation task group belongs. The aggregation task reads data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxxx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '入参结构体', + 'description' => 'The request parameters.', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfig' => ['title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求', 'description' => 'The configuration of the aggregation task group. Currently, only the RecordingRuleYaml format is supported. The configuration must comply with the RecordingRule format of open source Prometheus.', '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' => 'The type of the aggregation task group configuration. The default value is RecordingRuleYaml, which is the RecordingRule format of open source Prometheus.', 'type' => 'string', 'required' => false, 'default' => 'RecordingRuleYaml', 'example' => 'RecordingRuleYaml'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'required' => false, 'example' => 'test-group'], + 'cronExpr' => ['title' => '调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次', 'description' => 'The cron expression for scheduling when the scheduling mode is set to Cron. For example, \\`0/1 \\* \\* \\* \\*\\` indicates that the task is scheduled every 1 minute, starting from the 0th minute.', 'type' => 'string', 'required' => false, 'example' => '0/1 * * * *'], + 'delay' => ['title' => '调度的固定延迟时间，单位：秒，默认 30', 'description' => 'The fixed delay for scheduling. Unit: seconds. The default value is 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '0', 'default' => '30', 'example' => '30'], + 'description' => ['title' => '聚合任务组描述', 'description' => 'The description of the aggregation task group.', 'type' => 'string', 'required' => false, 'example' => 'desc'], + 'fromTime' => ['title' => '调度开始时间对应的的秒级时间戳', 'description' => 'The UNIX timestamp in seconds that indicates the start time of the scheduling.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1724996015'], + 'maxRetries' => ['title' => '执行聚合任务的最大重试次数，默认 20', 'description' => 'The maximum number of retries to execute the aggregation task. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '20'], + 'maxRunTimeInSeconds' => ['title' => '执行聚合任务的最大重试时间，单位：秒，默认 600', 'description' => 'The maximum retry time to execute the aggregation task. Unit: seconds. The default value is 600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '600', 'example' => '600'], + 'precheckString' => ['title' => '预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析', 'description' => 'The dry run configuration. This parameter is not configured by default. The input string must be a valid JSON string.', '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' => 'The scheduling mode. Valid values: Cron and FixedRate. The default value is FixedRate.', + 'type' => 'string', + 'required' => false, + 'default' => 'FixedRate', + 'enum' => ['FixedRate', 'Cron'], + 'example' => 'FixedRate', + ], + 'scheduleTimeExpr' => ['title' => '调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”', 'description' => 'The scheduling time expression. Recommended values are \\`@s\\` and \\`@m\\`. This expression indicates the granularity at which the scheduling time window is snapped. The default value is \\`@m\\`.', 'type' => 'string', 'required' => false, 'default' => '@m', 'example' => '@m'], + 'status' => [ + 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', + 'description' => 'The status of the aggregation task group. Valid values: Running and Stopped. The default value is Running.', + 'type' => 'string', + 'required' => false, + 'default' => 'Running', + 'enum' => ['Running', 'Stopped'], + 'example' => 'Running', + ], + 'tags' => [ + 'title' => '资源组标签', + 'description' => 'The tags of the resource group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '资源组标签的键', 'description' => 'The key of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['title' => '资源组标签的值', 'description' => 'The value of the resource group tag.', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'targetPrometheusId' => ['title' => '聚合任务组的目标 Prometheus 实例 id', 'description' => 'The ID of the target Prometheus instance for the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], + 'toTime' => ['title' => '调度结束时间对应的秒级时间戳，0 表示不停止调度', 'description' => 'The UNIX timestamp in seconds that indicates the end time of the scheduling. A value of 0 indicates that the scheduling does not stop.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + 'required' => false, + 'example' => '', ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'The operator is not permission for this operate ', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求 id', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要', 'description' => 'The summary of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'example' => 'aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => 'The ID of the source Prometheus instance for the aggregation task group.', 'type' => 'string', 'example' => 'rw-083e17834e279f8c627fe91a2d72'], + 'status' => ['title' => '聚合任务组的当前状态', 'description' => 'The current status of the aggregation task group.', 'type' => 'string', 'example' => 'Running'], + ], + 'example' => '', ], ], - 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 \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"sourcePrometheusId\\": \\"rw-083e17834e279f8c627fe91a2d72\\",\\n \\"status\\": \\"Running\\"\\n}","type":"json"}]', + 'title' => 'Update Aggregation Task Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAggTaskGroup'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateAggTaskGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'ListTagResources' => [ - 'summary' => '查标签接口', - 'path' => '/tags', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateAggTaskGroupStatus' => [ + 'summary' => 'Updates the status of an aggregation task group.', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}/status', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'resourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Service', - ], + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组所属的 Prometheus 实例的 id，聚合任务从这个实例中读取数据', 'description' => 'The ID of the Prometheus instance. The aggregation task reads data from this instance.', 'type' => 'string', 'required' => true, 'example' => 'rw-pq4apob9jm'], ], [ - 'name' => 'resourceId', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'required' => false, - ], + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'required' => true, 'example' => 'aggTaskGroup-xxx'], ], [ - 'name' => 'tag', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Tag', + 'title' => '入参结构体', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '聚合任务组状态，“Running” 或者 “Stopped”。默认 Running', + 'description' => 'The status of the aggregation task group. Valid values are "Running" and "Stopped". The default value is Running.', + 'type' => 'string', + 'required' => true, + 'enum' => ['Running', 'Stopped'], + 'example' => 'Running', + ], ], 'required' => false, - ], - ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxxxxxx', - ], - ], - [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '出参结构体', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-***', - ], - 'maxResults' => [ - 'title' => '列表最大数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'nextToken' => [ - 'title' => '下一个查询开始Token', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'resourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'Service', - ], - ], - ], - ], + 'aggTaskGroupConfigHash' => ['title' => '聚合任务组配置的摘要', 'description' => 'The summary of the aggregation task group configuration.', 'type' => 'string', 'example' => 'a54136014dc386a92c83a6ef1e97ff22'], + 'aggTaskGroupId' => ['title' => '聚合任务组 id', 'description' => 'The ID of the aggregation task group.', 'type' => 'string', 'example' => 'aggTaskGroup-xxx'], + 'aggTaskGroupName' => ['title' => '聚合任务组名称', 'description' => 'The name of the aggregation task group.', 'type' => 'string', 'example' => 'pipeline-aggtask-group'], + 'requestId' => ['title' => '请求 id', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-***'], + 'sourcePrometheusId' => ['title' => '聚合任务组的源 Prometheus 实例 id', 'description' => 'The ID of the source Prometheus instance for the aggregation task group.', 'type' => 'string', 'example' => 'rw-xxx'], + 'status' => ['title' => '聚合任务组的当前状态', 'description' => 'The current status of the aggregation task group.', 'type' => 'string', 'example' => 'Running'], ], + 'example' => '', ], ], ], - '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', - ], + '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' => 'Update Aggregation Task Group Status', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAggTaskGroupStatus'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateAggTaskGroupStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'AggTaskGroup', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}'], + ], ], ], ], - '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"}]', ], - 'ChangeResourceGroup' => [ - 'summary' => '修改资源所属资源组', - 'path' => '/resourcegroup', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateAlertWebhook' => [ + 'path' => '/webhook/{webhookId}', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'webhookId', + 'in' => 'path', + 'schema' => ['description' => 'The unique identifier of the webhook.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'description' => '', + 'contentType' => [ + 'description' => 'The content type of the data. Supported values:'."\n" + ."\n" + .'- JSON'."\n" + ."\n" + .'- FORM', 'type' => 'string', + 'enum' => ['JSON', 'FORM'], 'required' => false, - 'example' => 'Service', + 'example' => 'JSON', + 'title' => '', ], - 'resourceId' => [ - 'description' => '', + 'headers' => [ + 'description' => 'The headers.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The header.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'lang' => [ + 'description' => 'The language. Supported values:'."\n" + ."\n" + .'- zh\\_CN'."\n" + ."\n" + .'- en\\_US', 'type' => 'string', + 'enum' => ['zh_CN', 'en_US'], 'required' => false, - 'example' => 'test', + 'example' => 'zh_CN', + 'title' => '', ], - 'resourceGroupId' => [ - 'description' => '', + 'method' => [ + 'description' => 'The request method. Supported values:'."\n" + ."\n" + .'- GET'."\n" + ."\n" + .'- POST', 'type' => 'string', + 'enum' => ['GET', 'POST'], 'required' => false, - 'example' => 'rg-ae******ey', + 'example' => 'GET', + 'title' => '', ], + 'name' => ['description' => 'The name of the webhook.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'url' => ['description' => 'The URL of the alert callback.', 'type' => 'string', 'required' => false, 'example' => 'http://aliyun.com/test', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -21451,1279 +19128,1026 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8A33DBEA-*****-*****-*****-*****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - ], - 'DescribeRegions' => [ - 'summary' => '查询地域信息列表', - 'path' => '/regions', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource %s is not found.', 'description' => 'The specified resource% s does not exist.'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateAlertWebhook', + 'summary' => 'Updates a webhook.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\"\\n}","type":"json"}]', + ], + 'UpdateBizTrace' => [ + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'language', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ja' => 'ja', - 'en' => 'en', - 'zh' => 'zh', - ], - 'example' => 'zh', - ], + 'name' => 'bizTraceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the business trace.', 'type' => 'string', 'required' => false, 'example' => 'e339260ed64c95d', 'title' => ''], ], - ], - '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' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'localName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'China (Beijing)', - ], - ], - ], - ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'bizTraceName' => ['description' => 'The name of the business trace.', 'type' => 'string', 'required' => false, 'example' => 'just test', 'title' => ''], + 'workspace' => ['description' => 'The workspace.', 'type' => 'string', 'required' => false, 'example' => 'default-cms-xxxxxxx-cn-hangzhou', 'title' => ''], + 'ruleConfig' => ['description' => 'The list of configuration rules.', '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"]}}]}}]', 'title' => ''], + 'advancedConfig' => ['description' => 'The advanced configuration.', 'type' => 'string', 'required' => false, 'example' => '{"sample":{"strategy":"BY_APP"}}', 'title' => ''], ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'], + 'bizTraceId' => ['description' => 'The ID of the business trace.', 'type' => 'string', 'example' => 'e339260ed64c95d', 'title' => ''], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', + ], + ], ], - '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"}]', - ], - 'GetCmsService' => [ - 'summary' => '获取云监控开通状态', - 'path' => '/cmsservice', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateBizTrace', + 'summary' => 'Modifies a business trace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateBizTrace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'BizTrace', 'arn' => 'acs:cms:{#regionId}:{#accountId}:biztrace/{#BizTraceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', + ], + 'UpdateContext' => [ + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}/context/{contextId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'product', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '空：云产品开通prometheus场景使用。'."\n" - .'prometheus：开通prometheuse服务（按上报量或写入量计费）'."\n" - .'sls：开通sls日志服务', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'prometheus' => 'prometheus', - ], - 'example' => 'prometheus', - 'enum' => [ - 'prometheus', - ], - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'service', - 'in' => 'query', - 'allowEmptyValue' => true, + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The context store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], + [ + 'name' => 'contextId', + 'in' => 'path', + 'schema' => ['description' => 'The context ID.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '897294a7-67a4-4f60-976c-e136edc5f97e', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '空：云产品开通prometheus场景使用。'."\n" - .'prometheus：检查上报量计费的prometheus是否开通。'."\n" - .'prometheusgb：检查写入量计费的prometheus是否开通。'."\n" - .'ackpro：检查容器监控pro是否开通。', - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The updated text for the long-term memory.', 'type' => 'string', 'required' => false, 'example' => 'Users prefer to first view the SLS error logs, index configuration, and the most recent Agent execution trace.'."\n" + ."\n", 'title' => ''], + 'payload' => ['description' => 'The payload to update.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "userId": "u-10001",'."\n" + .' "agentId": "sls-agent",'."\n" + .' "appId": "console",'."\n" + .' "categories": ['."\n" + .' "preference"'."\n" + .' ],'."\n" + .' "source": "user_confirmed",'."\n" + .' "topic": "debugging_preference",'."\n" + .' "immutable": false,'."\n" + .' "createdAt": 1776319200,'."\n" + .' "updatedAt": 1776319200'."\n" + .' }', 'title' => ''], + 'triggerCondition' => ['description' => 'The trigger condition.', 'type' => 'string', 'required' => false, 'example' => 'Identify and troubleshoot SLs issues', 'title' => ''], + 'experience' => ['description' => 'The experience object.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "taskType": "troubleshooting",'."\n" + .' "complexity": "medium",'."\n" + .' "confidence": 0.95'."\n" + .'}', 'title' => ''], + 'metadata' => ['description' => 'A set of key-value pairs to attach to an object for storing custom information.', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + ], + 'description' => 'The request body.', 'required' => false, - 'enumValueTitles' => [ - 'prometheusgb' => 'prometheusgb', - 'promethues' => 'promethues', - 'ackpro' => 'ackpro', - ], - 'example' => 'prometheus', - 'enum' => [ - 'prometheus', - 'prometheusgb', - 'promethues', - 'ackpro', - ], + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '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' => '', - 'type' => 'string', - 'example' => 'PROM_NOT_OPEN', - ], - ], - ], + 'schema' => ['description' => 'Returns an empty object on success.', 'type' => 'object', 'example' => '{}', 'title' => ''], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateContext', + 'summary' => 'Updates a context.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"enabled\\": false,\\n \\"errorCode\\": \\"PROM_NOT_OPEN\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'CreateBizTrace' => [ - 'summary' => '创建业务链路', - 'path' => '/bizTrace', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateContextStore' => [ + 'summary' => 'Modifies the configuration of a context store.', + 'path' => '/workspace/{workspace}/contextstore/{contextStoreName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'contextStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the context store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-context-store', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request 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', + 'description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'config' => [ + 'description' => 'The configuration information.', + 'type' => 'object', + 'properties' => [ + 'metadataField' => [ + 'description' => 'The metadata field.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The metadata field.', 'type' => 'string', 'example' => '{'."\n" + .' "project": "attributes.project",'."\n" + .' "logstore": "attributes.logstore",'."\n" + .' "agentId": "attributes.agent_id",'."\n" + .' "scene": "attributes.scene"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'source' => [ + 'description' => 'The reference path.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '1776824891000', 'title' => ''], + 'logstore' => ['description' => 'The name of the Simple Log Service Logstore.', 'type' => 'string', 'required' => false, 'example' => 'sls-test-logstore', 'title' => ''], + 'project' => ['description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'required' => false, 'example' => 'sls-test-project', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], '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", + 'title' => '', + 'example' => '', ], - 'advancedConfig' => [ - 'description' => '', - 'type' => 'string', + 'contextType' => ['description' => 'The context type.', 'type' => 'string', 'required' => false, 'example' => 'memory', 'title' => ''], + 'dataset' => [ + 'description' => 'The dataset information.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test_dataset', 'title' => ''], + ], 'required' => false, - 'example' => '{"sample":{"strategy":"BY_APP"}}', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'bizTraceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'e339260ed64c95d', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify context store configuration', + 'description' => 'Only Alibaba Cloud accounts that have activated Network Analysis and Monitoring can create one-time detection tasks.'."\n" + ."\n" + .'This topic provides an example of how to create a one-time detection task. The detection task is named `task1`, the detection address is `http://www.aliyun.com`, the detection type is `HTTP`, and the number of detection points is `1`.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', ], - 'CreateServiceObservability' => [ - 'summary' => '创建应用可观测实例', - 'path' => '/workspace/{workspace}/service-observability/{type}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDataset' => [ + 'summary' => 'Updates a dataset.', + 'path' => '/workspace/{workspace}/dataset/{datasetName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-cms-1654218965343050-cn-hangzhou', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'type', + 'name' => 'datasetName', 'in' => 'path', + 'schema' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_dataset', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'rum' => '', - 'apm' => '', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The new description for the dataset.', 'type' => 'string', 'required' => false, 'example' => 'test dataset', 'title' => ''], ], - 'example' => 'apm', + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + ], + 'UpdateDeliveryTask' => [ + 'summary' => 'Updates a data delivery task. The update uses patch semantics: fields that are not specified remain unchanged.', + 'path' => '/delivery-task/{taskId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '6afe16bece7996a3', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body. All fields are optional. Specify only the fields that you want to update.', + 'type' => 'object', + 'properties' => [ + 'taskName' => ['description' => 'The task name. The name can contain letters, digits, underscores (_), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'new-task-name', 'title' => ''], + 'dataSourceId' => ['description' => 'The data source ID, which is the Managed Service for Prometheus instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rw-5f2b4sc7es4d66', 'title' => ''], + 'taskDescription' => ['description' => 'The task description.', 'type' => 'string', 'required' => false, 'example' => 'updated desc', 'title' => ''], + 'status' => [ + 'description' => 'The task status. This parameter is used to enable or disable the task.', + 'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'], + 'type' => 'string', + 'enum' => ['Running', 'Disable'], + 'required' => false, + 'example' => 'Enable', + 'title' => '', + ], + 'labelFiltersType' => [ + 'description' => 'The metric filtering mode.', 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', + 'enum' => ['Allow', 'Deny'], + 'required' => false, + 'example' => 'Deny', + 'title' => '', + ], + 'labelFilters' => [ + 'description' => 'The metric filter conditions. The entire value is replaced rather than incrementally merged.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'filterKey → filterValue. Example: job → my_job.', 'type' => 'string', 'example' => '__name__: up', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'externalLabels' => [ + 'description' => 'The additional labels attached to all delivered metrics. The key is the label name and the value is the label value.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'externalLabelsKey → externalLabelsValue. Example: region → ap-southeast-1.', 'type' => 'string', 'example' => 'region: cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'sinkList' => [ + 'description' => 'The list of delivery targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The delivery target.', + 'type' => 'object', + 'properties' => [ + 'sinkType' => [ + 'description' => 'The delivery target type.', + 'type' => 'string', + 'enum' => ['Prometheus', 'AcsMaxCompute', 'AcsKafka'], + 'required' => false, + 'example' => 'Prometheus', + 'title' => '', + ], + 'sinkConfigs' => [ + 'description' => 'The detailed configuration of the delivery target. The meanings of keys and values vary depending on the sinkType.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The configuration items supported by each sinkType.', 'type' => 'string', 'example' => 'Url: http://xxxx/api/v1/write', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzoiafjtr7zyq', 'title' => ''], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - ], - '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' => '', - 'type' => 'string', 'required' => false, - 'example' => 'e339260ed64c95d', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9335D7CB-2725-53DD-A2B3-187821C8F1B8'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - ], - 'GetAddon' => [ - 'summary' => '插件详情(Addon)', - 'path' => '/addons/{addonName}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update a data delivery task', + 'description' => 'Deletes a specified site monitoring task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'DeliveryTask', 'arn' => 'acs:cms:{#regionId}:{#accountId}:deliverytask/{#TaskId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9335D7CB-2725-53DD-A2B3-187821C8F1B8\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateIntegrationPolicy' => [ + 'summary' => 'Updates the specified policy.', + 'path' => '/integration-policies/{integrationPolicyId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'addonName', - 'in' => 'path', - 'schema' => [ - 'title' => '查询参数', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'security-actiontrail', - ], - ], - [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon版本号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - ], - [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body parameters.', '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' => '[{\'DisplayName\': u\'\\u4f1a\\u8bae\'}]', - ], - ], - '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' => '', - 'type' => 'string', - 'example' => 'http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f', - ], - ], - ], - ], - 'description' => [ - 'description' => '', - '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', - 'example' => 'true', - 'description' => '', - ], - ], - 'services' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - ], - ], - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Observability integration.', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85', - ], - 'policies' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'alertDefaultStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'defaultInstall' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'enableServiceAccount' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'promQL' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'up=1', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'protocols' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Prometheus Metrics', - ], - 'icon' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'icon URL', - ], - 'label' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rum_api_dot_metric_set', - ], - ], - ], - ], - 'targetAddonName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cs-default', - ], - ], - ], - 'policyType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CS', - ], - 'commonSchemaRefs' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'type' => 'string', - ], - 'version' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'icon' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'icon URL', - ], - 'keywords' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'finance', - ], - ], - 'language' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zh', - ], - 'latestReleaseCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-09-12 12:30:30', - ], - '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' => '10', + 'feePackage' => ['description' => 'The type of the paid plan. Valid values: CS\\_Pro, CS\\_Basic, and empty.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CS_Pro'], + 'policyName' => ['description' => 'The name of the rule. The name must be 3 to 63 characters in length and start with a letter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'metrics-inner-manage'], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-aekzoiafjtr7zyq'], + 'tags' => [ + 'description' => 'The tags of the resource.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags of the resource.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'algo_bhv_expose_in_airec_exposure'], + 'value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '[{\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}]'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'integrationPolicyId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Integration Center policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'polixy-xxxxxxxxx'], + ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + ], + 'example' => '', + ], + ], ], - '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' => 'GetAddon', - ], - 'GetAddonCodeTemplate' => [ - 'summary' => '插件schema详情(Addon)', - 'path' => '/addons/{addonName}/alert-code-template', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Access Center Policy', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntegrationPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateIntegrationPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'IntegrationPolicy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'UpdateMemory' => [ + 'summary' => 'Updates a specific Memory.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}/memory/{memoryId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'addonName', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => 'Addon的名称信息', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'apm-opentelemetry', - ], + 'schema' => ['description' => 'The name of the Workspace.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Memory Store.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test-memory-store', 'title' => ''], ], [ - 'name' => 'environmentType', - 'in' => 'query', - 'schema' => [ - 'title' => '环境类型 CS(容器) | ECS', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Client', - ], + 'name' => 'memoryId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Memory.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '019ca1e5-7307-7d50-b943-5e628326a8ed', 'title' => ''], ], [ - 'name' => 'version', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The Request Body.', + 'type' => 'object', + 'properties' => [ + 'metadata' => ['description' => 'The metadata of the Memory.', 'type' => 'object', 'required' => false, 'example' => '{"sessionId":"test_session_001"}', 'title' => ''], + 'text' => ['description' => 'The new text for the Memory.', 'type' => 'string', 'required' => false, 'example' => 'Likes to play tennis on weekends', 'title' => ''], + ], 'required' => false, - 'example' => '0.1.0', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The Response Data.', '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-***', - ], + 'requestId' => ['title' => 'ID of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********'], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'GetAddonSchema' => [ - 'summary' => '插件schema详情(Addon)', - 'path' => '/addons/{addonName}/schema', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify memory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateMemory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\"\\n}","type":"json"}]', + ], + 'UpdateMemoryStore' => [ + 'summary' => 'Modify a memory store.', + 'path' => '/workspace/{workspace}/memorystore/{memoryStoreName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'addonName', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => 'Addon的名称信息', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cloud-rds-audit-log', - ], - ], - [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Workspace name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'environmentType', - 'in' => 'query', - 'schema' => [ - 'title' => '环境类型 CS(容器) | ECS', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'memoryStoreName', + 'in' => 'path', + 'schema' => ['description' => 'Memory store name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'qianyi_test_3', 'title' => ''], ], [ - 'name' => 'version', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.1.1', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ - 'fields' => [ - 'description' => '', + 'description' => ['description' => 'Description.', 'type' => 'string', 'required' => false, 'example' => 'memoryStore test', 'title' => ''], + 'shortTermTtl' => ['description' => 'Short-term memory retention time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], + 'extractionStrategies' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'conditions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'action' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'redeploy', - ], - 'field' => [ - 'description' => '', - 'type' => 'string', - ], - 'op' => [ - 'description' => '', - 'type' => 'string', - ], - 'value' => [ - 'description' => '', - 'type' => 'any', - 'example' => '[{\'count\': \'1\', \'max\': \'358.106\', \'sum\': \'358.106\', \'ts\': \'1755049815000000\', \'min\': \'358.106\'}, {\'count\': \'1\', \'max\': \'326.311\', \'sum\': \'326.311\', \'ts\': \'1755049830000000\', \'min\': \'326.311\'}]', - ], - ], - ], - ], - 'defaultValue' => [ - 'description' => '', - 'type' => 'any', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'o11y-demo-cn-heyuan', - ], - 'disabled' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'element' => [ - 'description' => '', - 'type' => 'string', - ], - 'fieldPath' => [ - 'type' => 'string', - ], - 'label' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rum_api_dashboard_explorer_link_metric_set', - ], - 'placeholder' => [ - 'description' => '', - 'type' => 'string', - ], - 'props' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'dataSource' => [ - 'description' => 'AK', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'label' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - ], - ], - ], - 'related' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'false', - ], - ], - 'selectMode' => [ - 'type' => 'string', - ], - ], - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xtrace', - ], - 'validation' => [ - 'type' => 'object', - 'properties' => [ - 'max' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'maxLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ok', - ], - 'min' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'minLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'regular' => [ - 'type' => 'string', - ], - 'required' => [ - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', + 'items' => ['description' => 'Array of strategies.', 'type' => 'string', 'required' => false, 'example' => 'Fact', 'title' => ''], + 'description' => 'Extraction strategies. Supports "Episodic", "Summary", and "Fact".', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'response_time', + 'customExtractionStrategies' => [ + 'type' => 'array', + 'items' => ['description' => 'Array of strategies.', '$ref' => '#/components/schemas/CustomExtractionStrategy', 'required' => false, 'title' => '', 'example' => ''], + 'description' => 'Custom extraction strategies.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'Request data.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], + ], + 'title' => '', + 'description' => 'Response data.', + 'example' => '', + ], + ], ], - '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' => 'GetAddonSchema', - ], - 'GetBizTrace' => [ - 'summary' => '查询业务链路', - 'path' => '/bizTrace/{bizTraceId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateMemoryStore', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateMemoryStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'MemoryStore', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#WorkspaceName}/memorystore/{#MemoryStoreName}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + ], + 'UpdateNotifyStrategy' => [ + 'path' => '/notifyStrategies/{notifyStrategyId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'bizTraceId', + 'name' => 'workspace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The request body.', '$ref' => '#/components/schemas/NotifyStrategyForModify', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'notifyStrategyId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e339260ed64c95d', - ], + 'schema' => ['description' => 'The UUID of the notification policy.', 'type' => 'string', 'required' => true, 'example' => '12312-31-23-123-1-23123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The structure of the response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], - 'item' => [ - 'description' => '', - '$ref' => '#/components/schemas/BizTraceConfig', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. This is a unique identifier for troubleshooting.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], + 'notifyStrategyId' => ['description' => 'The UUID of the notification policy.', 'type' => 'string', 'example' => '12312-31-23-123-1-23123', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ['errorCode' => 'StrategyNameConflict', 'errorMessage' => 'The specified strategy name exits already.', 'description' => 'The specified strategy name already exists'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - '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"}]', - ], - 'GetIntegrationVersionForCS' => [ - 'summary' => '查询接入中心在CS的版本', - 'path' => '/integration-version/cs', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateNotifyStrategy', + 'summary' => 'Updates a notification policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNotifyStrategy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateNotifyStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'NotifyStrategy', 'arn' => 'acs:cms:{#regionId}:{#accountId}:notifyStrategy/{#notifyStrategyId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"notifyStrategyId\\": \\"12312-31-23-123-1-23123\\"\\n}","type":"json"}]', + ], + 'UpdatePipeline' => [ + 'path' => '/workspace/{workspace}/pipeline/{pipelineName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'clusterId', - 'in' => 'query', - 'schema' => [ - 'title' => '集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c502646fd0d1249baaf792b3a1b589e1b', - ], + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'clusterType', - 'in' => 'query', + 'name' => 'pipelineName', + 'in' => 'path', + 'schema' => ['description' => 'The pipeline name.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-name-1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '集群类型。取值：acs.ack.cluster,acs.asi.cluster。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'acs.ack.cluster', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The pipeline description.', 'type' => 'string', 'required' => false, 'example' => 'test pipeline ', 'title' => ''], + 'source' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The source type.', 'type' => 'string', 'required' => false, 'example' => 'logstore', 'title' => ''], + 'logstore' => [ + 'type' => 'object', + 'properties' => [ + 'logstore' => ['description' => 'The Logstore name.', 'type' => 'string', 'required' => false, 'example' => 'test-logstore', 'title' => ''], + 'query' => ['description' => 'The filter query.', 'type' => 'string', 'required' => false, 'example' => 'status:500 and method:GET', 'title' => ''], + ], + 'description' => 'The Log Service Logstore configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data source configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'pipeline' => [ + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The node ID.', 'type' => 'string', 'required' => false, 'example' => 'node_1', 'title' => ''], + 'type' => ['description' => 'The node type.', 'type' => 'string', 'required' => false, 'example' => 'dedup-fuzzy', 'title' => ''], + 'parameters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The node-specific parameters.', 'type' => 'any', 'example' => '{'."\n" + .' "output": "ID,key_0,key_2,key_3,key_4",'."\n" + .' "workspace": "workspace-test-dataset",'."\n" + .' "field": "key_0",'."\n" + .' "global": true,'."\n" + .' "dataset": "dataset_1"'."\n" + .' }', 'title' => ''], + 'description' => 'The node parameters.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A node object.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'The pipeline nodes.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The pipeline configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'sink' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The sink type.', 'type' => 'string', 'required' => false, 'example' => 'dataset', 'title' => ''], + 'dataset' => [ + 'type' => 'object', + 'properties' => [ + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], + 'dataset' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => false, 'example' => 'dataset_1', 'title' => ''], + ], + 'description' => 'The destination dataset configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data sink configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'executePolicy' => [ + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => 'The execution mode.', 'type' => 'string', 'required' => false, 'example' => 'runOnce', 'title' => ''], + 'runOnce' => [ + 'type' => 'object', + 'properties' => [ + 'fromTime' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + 'toTime' => ['description' => 'The end timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772605413', 'title' => ''], + ], + 'description' => 'The one-time execution configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'scheduled' => [ + 'type' => 'object', + 'properties' => [ + 'interval' => ['description' => 'The execution interval.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], + 'fromTime' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772519013', 'title' => ''], + ], + 'description' => 'The scheduled execution configuration.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The execution policy.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -22732,612 +20156,371 @@ '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', - ], + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'E99F1CCD-256A-5DF9-9B67-8F4A7ACE7132'], ], + 'title' => '', + 'description' => 'The data returned in the response.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdatePipeline', + 'summary' => 'Update pipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"integrationVersion\\": \\"V1\\",\\n \\"requestId\\": \\"CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A\\"\\n}","type":"json"}]', - 'title' => 'GetIntegrationVersionForCS', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E99F1CCD-256A-5DF9-9B67-8F4A7ACE7132\\"\\n}","type":"json"}]', ], - 'GetPrometheusUserSetting' => [ - 'summary' => '查询指定环境实例', - 'path' => '/prometheus-user-setting', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdatePrometheusInstance' => [ + 'summary' => 'Updates the information of a Managed Service for Prometheus instance.', + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcmsCP2WWY', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The Prometheus instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rw-xxxxxxx'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'prometheusUserSetting' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'value1', - ], + 'archiveDuration' => [ + 'title' => '', + 'description' => 'The number of days for automatic archiving after storage expires. A value of 0 indicates no archiving. Valid values for archiving days:'."\n" + .'V1: 1 to 365 days. Supported only for billing by metric write volume.'."\n" + .'V2: 1 to 3650 days (3650 indicates permanent retention).', + 'type' => 'integer', + 'enum' => [], + 'required' => false, + 'example' => '365', + ], + 'authFreeReadPolicy' => ['title' => '', 'description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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' => '', 'description' => 'The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.', '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' => 'Specifies whether to enable authentication-free read.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthFreeWrite' => ['title' => '', 'description' => 'Specifies whether to enable authentication-free write.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '', 'description' => 'Specifies whether to enable access token authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'prometheusInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'test-prom-name', 'title' => ''], + 'status' => ['title' => '', 'description' => 'Instance storage database status of the instance. Only RUNNING is supported. If this parameter is left empty, instance storage database status remains unchanged.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], + 'storageDuration' => [ + 'title' => '', + 'description' => 'The storage duration (days):'."\n" + .'By write volume: 90 or 180.'."\n" + .'By metric reporting volume: 15, 30, 60, 90, or 180.', + 'enumValueTitles' => [15 => '15 days.', 30 => '30 days.', 60 => '60 days.', 90 => '90 days.', 180 => '180 days.', 365 => '365 days.'], + 'type' => 'integer', + 'enum' => ['15', '30', '60', '90', '180', '365'], + 'required' => false, + 'example' => '90', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', + 'paymentType' => [ + 'title' => '', + 'description' => 'The billing method. This parameter can be modified only once during the instance lifetime. Valid values:'."\n" + .'- POSTPAY: pay-as-you-go by metric reporting volume.'."\n" + .'- POSTPAY_GB: pay-as-you-go by metric write volume.', + 'enumValueTitles' => ['POSTPAY_GB' => 'Write volume.', 'POSTPAY' => 'Reporting volume.'], 'type' => 'string', - 'example' => '058550FA-DDBE-519E-9C6D-93521B9A5E90', + 'enum' => ['POSTPAY_GB', 'POSTPAY'], + 'required' => false, + 'example' => 'POSTPAY_GB', ], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'default-cms-1500199863951574-cn-shanghai'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rw-abc123', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1E92F783-E057-58F1-BD5C-92DED088E7A5'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusUserSetting\\": {\\n \\"key\\": \\"value1\\"\\n },\\n \\"requestId\\": \\"058550FA-DDBE-519E-9C6D-93521B9A5E90\\"\\n}","type":"json"}]', - 'title' => 'GetPrometheusUserSetting', - ], - 'ListAddons' => [ - 'summary' => '新版接入中心产品列表(分组)', - 'path' => '/addons', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"1E92F783-E057-58F1-BD5C-92DED088E7A5\\"\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => 'Update prometheus instance information', + 'description' => 'Updates the information of a Managed Service for Prometheus instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusInstance'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + ], + 'UpdatePrometheusUserSetting' => [ + 'summary' => 'Updates the user settings for Prometheus. Note: If you set `settingKey` to `financeUsageRegion`, Prometheus usage data is sent to Simple Log Service (SLS) in the specified region. Historical usage data will no longer be available in the Prometheus console.', + 'path' => '/prometheus-user-setting/{settingKey}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'aliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境：zh / en'."\n" - .'默认为中文 zh', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'category', - 'in' => 'query', - 'schema' => [ - 'title' => '标签筛选', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'database', - ], - ], - [ - 'name' => 'search', - 'in' => 'query', + 'name' => 'settingKey', + 'in' => 'path', 'schema' => [ - 'title' => 'addon名称', - 'description' => '', + 'description' => 'The key of the user setting.', + 'enumValueTitles' => ['defaultPaymentType' => 'The default billing method.', 'defaultPostPayDays' => 'The default retention period for the pay-as-you-go billing method based on reported data.', 'financeUsageRegion' => 'The ID of the region where usage statistics are stored.', 'defaultPostPayGBDays' => 'The default retention period for the pay-as-you-go billing method based on written data.'], 'type' => 'string', - 'required' => false, - 'example' => '105095', + 'required' => true, + 'example' => 'financeUsageRegion', + 'title' => '', ], ], [ - 'name' => 'regexp', + 'name' => 'settingValue', 'in' => 'query', - 'schema' => [ - 'title' => '查询字段, 是否正则匹配, 默认为false'."\n", - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The value of the user setting.', 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'promQL' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'protocols' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Support OpenTelemetry Protocal', - ], - 'icon' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'label' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OpenTelemetry', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'openTelemetry', - ], - ], - ], - ], - 'targetAddonName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - ], - ], - ], - 'policyType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CS', - ], - 'commonSchemaRefs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'group' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'acs-ecs', - ], - 'version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.1.4', - ], - ], - ], - ], - ], - ], - ], - 'icon' => [ - 'description' => '', - '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*****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8FDE2569-626B-5176-9844-28877A*****'], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'ListBizTraces' => [ - 'summary' => '业务链路列表', - 'path' => '/bizTraces', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdatePrometheusUserSetting', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdatePrometheusUserSetting', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdatePrometheusView' => [ + 'path' => '/prometheus-views/{prometheusViewId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Prometheus view instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rw-xxxxxxxx'], ], [ - 'name' => 'nextToken', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => ['description' => 'The policy for password-free read access. IP address segments and VPC IDs are supported.', 'type' => 'string', 'required' => false, 'title' => '', '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' => 'Specifies whether to enable password-free read access.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enableAuthToken' => ['title' => '', 'description' => 'Specifies whether to enable authentication tokens.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'prometheusInstances' => [ + 'description' => 'A list of Prometheus instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of Prometheus instances.', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'c7ba84651c71e442c8d0653085d862164'], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-north-2-gov-1'], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '16727123456789'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'prometheusViewName' => ['description' => 'The name of the Prometheus view.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-prom-view-name'], + 'status' => ['description' => 'The status of the Prometheus view.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Running'], + 'workspace' => ['title' => '', 'description' => 'The workspace to which the view belongs.', 'type' => 'string', 'required' => false, 'example' => 'default-cms-108490012345-cn-heyuan'], + ], 'required' => false, - 'example' => 'aa9d0e569b88098a0e3155c29b473201a', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response body', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0CEC5375-C554-562B-A65F-*****', - ], - 'maxResults' => [ - 'description' => '', - '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', - ], - ], + 'prometheusViewId' => ['title' => '', 'description' => 'The ID of the Prometheus view instance.', 'type' => 'string', 'example' => 'rw-xxxxxx'], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '64D964F5-76C7-19A2-9399-457744AB3619'], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'ListIntegrationPolicyAddons' => [ - 'summary' => '策略addon列表', - 'path' => '/integration-policies/{policyId}/addons', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Prometheus View Instance Information', + 'summary' => 'Updates the information about a Prometheus view instance.', + 'description' => 'Updates the information about a Prometheus view instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusView'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdatePrometheusView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'PrometheusView', 'arn' => 'acs:cms:{#regionId}:{#accountId}:prometheusview/{#prometheusViewId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"rw-xxxxxx\\",\\n \\"requestId\\": \\"64D964F5-76C7-19A2-9399-457744AB3619\\"\\n}","type":"json"}]', + ], + 'UpdateService' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'policyId', + 'name' => 'workspace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], + ], + [ + 'name' => 'serviceId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the service.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '环境id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-3563e6bf338141b3b92c118e2c318c37', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => 'The display name. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'api-monitor-test', 'required' => false, 'title' => ''], + 'description' => ['description' => 'The description of the service. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'test', 'required' => false, 'title' => ''], + 'attributes' => ['description' => 'The extended properties.', 'type' => 'string', 'example' => '{"language":"java"}', 'required' => false, 'title' => ''], + 'serviceStatus' => ['description' => 'The status of the service. This parameter is valid only when serviceType is set to RUM.', 'type' => 'string', 'example' => 'Stopped', 'required' => false, 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -23346,1063 +20529,657 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'addons' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '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' => '', - ], - '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' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'metricCheckRule' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'promQl' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'up{job="mysql"} > 0', - ], - ], - ], - ], - 'needRestartAfterIntegration' => [ - 'description' => '', - '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' => '', - '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' => '', - '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '123-0F43-23423-AC43-34234', 'title' => ''], + 'serviceId' => ['description' => 'The ID of the service.', 'type' => 'string', 'example' => 'em87vd@c2e25bcfe0e21ce0***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListIntegrationPolicyAddons', - ], - 'ListIntegrationPolicyCollectors' => [ - 'summary' => '获取接入中心策略的存储要求信息', - 'path' => '/integration-policies/{policyId}/collectors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Application Observability Service', + 'summary' => 'Updates an application observability service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateService'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Service', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/{#ServiceId}'], + ], + ], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"serviceId\\": \\"em87vd@c2e25bcfe0e21ce0***\\"\\n}","type":"json"}]', + ], + 'UpdateServiceRecord' => [ + 'path' => '/workspace/{workspace}/service/{serviceId}/record', + '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' => 'policyId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'env-d95435164593aece55f9999ce45c', - ], - ], - [ - 'name' => 'addonReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'release-1234567', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'collectorType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Exporter', - ], + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => ['description' => 'The service ID.', 'type' => 'string', 'required' => true, 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', 'title' => ''], ], [ - 'name' => 'language', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'recordType' => [ + 'title' => '', + 'description' => 'The type of the linked entry. Currently supported value:'."\n" + .'logCorrelation, which indicates application log association.', + 'type' => 'string', + 'required' => true, + 'enum' => ['logCorrelation'], + 'example' => 'logCorrelation', + ], + 'recordContent' => ['title' => '', 'description' => 'The entry content in JSON string format. The format varies depending on the recordType value.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "project": "proj-xtrace-16c988dcfe21fcb73c5e6f234927d998-cn-hangzhou",'."\n" + .' "storeName": "app-biz-log",'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "bindType": "logstore",'."\n" + .' "traceIdRelateField": ""'."\n" + .'}'], + ], 'required' => false, - 'example' => 'zh', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.193.82.198', - ], - 'managed' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'managedInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'securityGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sg-xxxxx', - ], - 'vswitchId' => [ - 'description' => '', - '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' => '', - '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' => [ - 'type' => 'string', - ], - 'addonMeta' => [ - '$ref' => '#/components/schemas/AddonMeta', - ], - ], - ], - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update a service-linked entry', + 'summary' => 'Updates a service-linked entry.', + 'description' => 'Updates an existing service-linked entry.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - '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' => 'ListIntegrationPolicyCollectors', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0\\"\\n}","type":"json"}]', ], - 'ListIntegrationPolicyServiceMonitors' => [ - 'summary' => '获取接入中心策略的存储要求信息', - 'path' => '/integration-policies/{policyId}/service-monitors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateSubscription' => [ + 'path' => '/subscriptions/{subscriptionId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'policyId', - 'in' => 'path', - 'schema' => [ - 'title' => '接入中心策略ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - ], - [ - 'name' => 'addonReleaseName', + 'name' => 'workspace', 'in' => 'query', - 'schema' => [ - 'title' => 'Addon Release名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'release-12345678', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'workspace-test', 'title' => ''], ], [ - 'name' => 'namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'arms-prom', - ], + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The request body.', '$ref' => '#/components/schemas/SubscriptionForModify', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'encryptYaml', - 'in' => 'query', - 'schema' => [ - 'title' => '是否加密Yaml。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'subscriptionId', + 'in' => 'path', + 'schema' => ['description' => 'The subscription ID.', 'type' => 'string', 'required' => true, 'example' => '123123123123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'clusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ea119prod-ea119blinkcptssd1', - ], - 'policyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', - ], - 'serviceMonitors' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'addonName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud-acs-ecs', - ], - 'addonReleaseName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'release-1234567', - ], - 'addonVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'configYaml' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'apiVersion: xxxxx', - ], - 'enableStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'run', - ], - 'encryptYaml' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK', - ], - 'endpoints' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'interval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30s', - ], - 'matchedTargetCount' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '62a526c5-f6ca-4cfb-b5a4-b76974cffe51', - ], - 'namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'arms-prom', - ], - ], - ], - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', - ], + 'title' => '', + 'description' => 'The response body structure.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '0CEC5375-C554-562B-A65F-******'], + 'subscriptionId' => ['description' => 'The subscription ID.', 'type' => 'string', 'example' => '123123123123', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], ], - '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' => 'ListIntegrationPolicyServiceMonitors', - ], - 'UpdateBizTrace' => [ - 'summary' => '修改业务链路', - 'path' => '/bizTrace/{bizTraceId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => 'Update a subscription', + 'summary' => 'Updates a subscription.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSubscription'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-******\\",\\n \\"subscriptionId\\": \\"123123123123\\"\\n}","type":"json"}]', + ], + 'UpdateUmodel' => [ + 'summary' => 'Updates the configuration of a Umodel.', + 'path' => '/workspace/{workspace}/umodel', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'bizTraceId', + 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'e339260ed64c95d', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request 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"}}', - ], + 'description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace test'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', - ], - 'bizTraceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'e339260ed64c95d', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '234324-123-123-123-23423'], + 'workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'title' => '', 'example' => 'workspace-test'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"234324-123-123-123-23423\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + 'title' => 'Update Umodel', + 'description' => 'Updates the configuration of a Umodel.', + 'changeSet' => [ + ['createdAt' => '2025-08-12T02:41:41.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', - ], - 'UpdatePrometheusUserSetting' => [ - 'summary' => '更新Prom实例信息', - 'path' => '/prometheus-user-setting/{settingKey}', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUmodel'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateUmodel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], + ], + 'UpsertUmodelCommonSchemaRef' => [ + 'summary' => 'Upserts a common Umodel schema reference.', + 'path' => '/workspace/{workspace}/umodel/common-schema-ref', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'settingKey', + 'name' => 'workspace', 'in' => 'path', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + [ + 'name' => 'group', + 'in' => 'query', + 'schema' => ['description' => 'The group of the common Umodel schema.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'card-service-daily01'], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => ['description' => 'The version number.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0.1.0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0B9377D9-C56B-5C2E-A8A4-************'], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'key1', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', + 'title' => 'UpsertUmodelCommonSchemaRef', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertUmodelCommonSchemaRef'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'settingValue', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpsertUmodelCommonSchemaRef', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], + ], + ], + 'UpsertUmodelData' => [ + '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' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'workspace-test'], + ], + [ + 'name' => 'method', 'in' => 'query', - 'allowEmptyValue' => false, + 'schema' => ['description' => 'The method.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Upsert'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'setting值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', + 'description' => 'The list of elements.', + 'type' => 'object', + 'properties' => [ + 'elements' => [ + 'description' => 'The content of the element.', + 'type' => 'array', + 'items' => ['description' => 'The content of the element.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '{}'], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8FDE2569-626B-5176-9844-28877A*****', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Add or Overwrite Umodel (Elements)', + 'summary' => 'Inserts or updates Umodel elements.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertUmodelData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpsertUmodelData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Cms', 'resourceType' => 'Umodel', 'arn' => 'acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/umodel'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', - 'title' => 'UpdatePrometheusUserSetting', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-beijing.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhengzhou-jva.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-heyuan.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-northeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-northeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-3.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-5.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-5.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-6.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-7.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'ap-southeast-8', 'regionName' => 'Malaysia (Johor)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-8.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-8.aliyuncs.com', 'vpc' => 'cms-vpc.ap-southeast-8.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'regionName' => 'China (Zhongwei)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhongwei.aliyuncs.com', 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', 'vpc' => 'cms-vpc.cn-zhongwei.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-qingdao.aliyuncs.com', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-shanghai.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-hongkong.aliyuncs.com', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-shenzhen.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-nanjing.aliyuncs.com', 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-nanjing.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-fuzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-fuzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-chengdu.aliyuncs.com', 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-guangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-huhehaote.aliyuncs.com', 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-hangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-southeast-1', 'regionName' => 'US（Atlanta）', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-west-1.aliyuncs.com', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'regionName' => 'France (Paris)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-west-2.aliyuncs.com', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com', 'vpc' => 'cms-vpc.eu-west-2.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-central-1.aliyuncs.com', 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-east-1.aliyuncs.com', 'endpoint' => 'metrics.us-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-west-1.aliyuncs.com', 'endpoint' => 'metrics.us-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.na-south-1.aliyuncs.com', 'endpoint' => 'metrics.na-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.na-south-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.me-east-1.aliyuncs.com', 'endpoint' => 'metrics.me-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.ap-south-1.aliyuncs.com', 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.me-central-1.aliyuncs.com', 'endpoint' => 'metrics.me-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu-gic-1', 'regionName' => 'China (Ulanqab) GIC', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'vpc' => 'cms-vpc.cn-wulanchabu-gic-1.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan-acdr-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-north-2-gov-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessDeniedException', 'message' => 'You do not have the authority to operate this rule.', 'http_code' => 401, 'description' => 'ess rules cannot be modified in the cloud monitoring console.'], + ['code' => 'AccessForbidden', 'message' => 'No permission, please use Ram for authorization.', 'http_code' => 403, 'description' => 'No permission, please use Ram for authorization.'], + ['code' => 'AgentStateError', 'message' => 'Expected agent running state is stopped.', 'http_code' => 412, 'description' => 'Uninstall the plug-in when the status is Stopped.'], + ['code' => 'BadRequest', 'message' => 'Bad request.', 'http_code' => 400, 'description' => 'Error Parameter Request'], + ['code' => 'ContactNotExists', 'message' => 'ContactName does not exist.', 'http_code' => 404, 'description' => 'The contact name was not found.'], + ['code' => 'CSS_CREATE_ORDER_ERROR', 'message' => 'Create order error', 'http_code' => 400, 'description' => 'Failed to create order'], + ['code' => 'EmptyProbeList', 'message' => 'The selected probe list is empty.', 'http_code' => 400, 'description' => 'The selected probe list is empty'], + ['code' => 'ExceedingQuota', 'message' => 'You have exceeded the task limit.', 'http_code' => 406, 'description' => 'You have exceeded the task limit'], + ['code' => 'ExceedingQuota', 'message' => 'Exceeding quota limits.', 'http_code' => 406, 'description' => 'The number of tasks exceeds the limit'], + ['code' => 'Forbidden', 'message' => 'You are not authorized to operate the specified resource.', 'http_code' => 403, 'description' => 'No permission, please use RAM to authorize'], + ['code' => 'FrequencyLimit', 'message' => 'Frequency too high, please try again later.', 'http_code' => 429, 'description' => 'Frequency too high, please try again later'], + ['code' => 'Illegal Task Name', 'message' => 'The task name of the sitemonitor task is illegal.', 'http_code' => 400, 'description' => 'Site monitoring task name is illegal.'], + ['code' => 'IllegalAddress', 'message' => 'illegal address.', 'http_code' => 400, 'description' => 'Illegal Address'], + ['code' => 'Illgeal Task Name', 'message' => 'The task name for sitemonitor task is illegal.', 'http_code' => 400, 'description' => 'Site monitoring task name is illegal'], + ['code' => 'InsecureParams', 'message' => 'The params for site monitor is insecure.', 'http_code' => 400, 'description' => 'There is a security risk to the parameters of the site monitoring task'], + ['code' => 'InternalError', 'message' => '%s.', 'http_code' => 500, 'description' => '%s'], + ['code' => 'InternalUnknownError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'A service runtime error occurred.'], + ['code' => 'InternetServerError', 'message' => 'System internal error.', 'http_code' => 500, 'description' => 'System internal error'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied', 'http_code' => 403, 'description' => 'Permission denied.'], + ['code' => 'InvalidAuthorization', 'message' => 'InvalidAuthorization.', 'http_code' => 403, 'description' => 'You do not have the required permissions.'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied.', 'http_code' => 403, 'description' => 'You do not have the required permissions.'], + ['code' => 'InvalidAuthorizationTokenExpire', 'message' => 'Authentication token expired, please re-authenticate.', 'http_code' => 403, 'description' => 'Authentication token expired, please re-authenticate'], + ['code' => 'InvalidClientTokenId', 'message' => 'not allow this operation.', 'http_code' => 403, 'description' => 'No permission'], + ['code' => 'InvalidParameter', 'message' => '%s is missing or invalid.', 'http_code' => 400, 'description' => 'The request parameters are invalid or required parameters are missing (such as GroupName, WorkspaceId, GroupId, or region being empty).'], + ['code' => 'InvalidParameter', 'message' => 'Invalid parameter.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'InvalidParameterValue', 'message' => 'Illegal parameters.', 'http_code' => 400, 'description' => 'Illegal parameters.'], + ['code' => 'InvalidQueryParameter', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => 'Query parameter error'], + ['code' => 'InvalidQueryParameter', 'message' => 'Invalid query parameter.', 'http_code' => 400, 'description' => 'Bad query parameters'], + ['code' => 'MaxRcaTimesExceed', 'message' => 'The maximum reanalysis limit has been reached.', 'http_code' => 400, 'description' => 'The maximum reanalysis limit has been reached.'], + ['code' => 'NameRepeat', 'message' => 'The task name already exists.', 'http_code' => 400, 'description' => 'The task name already exists. Make sure that the task name is not used in protocol-based synthetic tests and synthetic tests for browsers.'], + ['code' => 'NotAuthSLR', 'message' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', 'http_code' => 403, 'description' => 'The service-linked role AliyunServiceRoleForCloudMonitor is required.'], + ['code' => 'NotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The corresponding resource was not found.'], + ['code' => 'NotFound.EndpointConnector', 'message' => 'endpoint connector not found.', 'http_code' => 404, 'description' => 'endpoint connector does not exist'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid Isp.', 'http_code' => 400, 'description' => 'Invalid Isp'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid IspCity for certain probes.', 'http_code' => 400, 'description' => 'The isp or city of certain probes provided is invalid.'], + ['code' => 'OperatorCityInvalid', 'message' => 'The synthetic probe info provided is incorrect. The incorrect probe info are as below. %s.', 'http_code' => 400, 'description' => 'The synthetic probe info provided is incorrect.'], + ['code' => 'ParameterInvalid', 'message' => 'The parameter is missing or invalid. %s', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'ParameterInvalid', 'message' => 'Parameter invalid.', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'PhoneIsEmptyOrNotVerified', 'message' => 'Contact does not have a phone number configured or not verified.', 'http_code' => 400, 'description' => 'Contact does not have a phone number configured or not verified'], + ['code' => 'RateLimit', 'message' => 'Service rate limit.', 'http_code' => 400, 'description' => 'Service load is high, please try again later'], + ['code' => 'ResourceExist', 'message' => 'Resource already exist .', 'http_code' => 400, 'description' => 'The resource already exists.'], + ['code' => 'ResourceLimit', 'message' => 'Namespace limited.', 'http_code' => 400, 'description' => 'A maximum of 30 indicator warehouses can be created for one account.'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The specified resource is not found.'], + ['code' => 'ResourceNotFound', 'message' => 'Resource % not found.', 'http_code' => 404, 'description' => '已废弃'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource %s is not found.', 'http_code' => 404, 'description' => 'The specified resource% s does not exist.'], + ['code' => 'ResourceOverLimit', 'message' => 'The resource has exceeded the limit. %s', 'http_code' => 429, 'description' => 'The quantity limit has been exceeded.'], + ['code' => 'RestrictedUser', 'message' => 'The user has no access to this operation. %s.', 'http_code' => 403, 'description' => 'The user does not have permission for the current action.'], + ['code' => 'RmcNotEnabled', 'message' => 'ResourceCenter Service is not enabled.', 'http_code' => 403, 'description' => 'You have not activated Resource Center.'], + ['code' => 'StrategyNameConflict', 'message' => 'The specified strategy name exits already.', 'http_code' => 400, 'description' => 'The specified strategy name already exists'], + ['code' => 'TaskIdNotExist', 'message' => 'Task does not exist.', 'http_code' => 404, 'description' => 'Task does not exist'], + ['code' => 'TaskNotExist', 'message' => 'Task does not exist.', 'http_code' => 400, 'description' => 'Site monitoring task does not exist'], + ['code' => 'TaskNotExist', 'message' => 'The specified task does not exist.', 'http_code' => 404, 'description' => 'The specified task does not exist.'], + ['code' => 'UnauthorizedTasks', 'message' => 'You are not permitted to operate the specified tasks.', 'http_code' => 403, 'description' => 'You are not permitted to operate the specified tasks.'], + ['code' => 'UnsupportedWorkspaceRegion', 'message' => 'Synthetic monitoring is not supported in this workspace region.', 'http_code' => 400, 'description' => 'Synthetic monitoring is not supported in this workspace region.'], + ['code' => 'VerifyCodeIsSent', 'message' => 'Verification code sent too often, please try again later.', 'http_code' => 400, 'description' => 'The verification code is sent too often, please try again later.'], + ['code' => 'WorkspaceNotExist', 'message' => 'The specified workspace does not exist.', 'http_code' => 400, 'description' => 'The workspace does not exist.'], + ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid or a required parameter is missing.', 'http_code' => 400, 'description' => 'The request parameter is invalid or a required parameter is missing.'], + ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults parameter is invalid.', 'http_code' => 400, 'description' => 'The MaxResults parameter is invalid, must be a positive integer within the allowed limit.'], + ['code' => 'InvalidParameter.NextToken', 'message' => 'The NextToken is invalid or does not match the request parameters.', 'http_code' => 400, 'description' => 'The NextToken is invalid or does not match the request parameters.'], + ['code' => 'InvalidParameter.RegionId', 'message' => 'Unable to determine the region for the observe group.', 'http_code' => 400, 'description' => 'Unable to determine the region: the account has not enabled CloudResource and no central region can be derived.'], + ['code' => 'ObserveGroup.AlreadyExists', 'message' => 'An observe group with the same name already exists in the workspace.', 'http_code' => 409, 'description' => 'An observe group with the same name already exists in the workspace.'], + ['code' => 'DatabaseError', 'message' => 'A database error occurred while processing the request.', 'http_code' => 500, 'description' => 'A database error occurred. Please retry later or contact the administrator.'], + ['code' => 'ObserveGroup.NotFound', 'message' => 'The specified observe group does not exist.', 'http_code' => 404, 'description' => 'The specified observe group does not exist. Please check the ObserveGroupId.'], + ['code' => 'InternalError', 'message' => 'An internal error occurred while processing the request.', 'http_code' => 500, 'description' => 'An internal error occurred (e.g. failed to update Diamond config or deliver MetaQ). Please retry later.'], + ['code' => 'Workspace.NotFound', 'message' => 'The specified workspace does not exist or you have no permission.', 'http_code' => 404, 'description' => 'The specified workspace does not exist or you have no access.'], + ], + 'changeSet' => [ [ - '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', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListIntegrationPolicies'], + ], + 'createdAt' => '2025-10-30T12:37:24.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetIntegrationPolicy'], + ['description' => 'Response parameters changed', 'api' => 'ListIntegrationPolicies'], + ], + 'createdAt' => '2025-10-30T11:47:29.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateIntegrationPolicy'], + ], + 'createdAt' => '2025-10-28T08:08:49.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListIntegrationPolicyDashboards'], + ], + 'createdAt' => '2025-10-20T14:08:17.000Z', + 'description' => '', ], - [ - 'regionId' => 'cn-heyuan-acdr-1', - 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddonReleases'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAggTaskGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyStorageRequirements'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelData'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlertActions'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyCustomScrapeJobRules'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceObservability'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusVirtualInstances'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSubscription'], + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddonRelease'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEntityStore'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTicket'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAggTaskGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEntityStore'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodelCommonSchemaRef'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusViews'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServices'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusView'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntityStoreData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertUmodelCommonSchemaRef'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusVirtualInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateService'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntegrationPolicy'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateService'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusView'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodelCommonSchemaRef'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicies'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstances'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAggTaskGroupStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAggTaskGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrationPolicy'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddonRelease'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUmodel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusDashboards'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpsertUmodelData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodel'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUmodel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNotifyStrategy'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntegrationPolicy'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAggTaskGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUmodelData'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIntegrationPolicy'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddonRelease'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyDashboards'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationPolicyPodMonitors'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntityStore'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAggTaskGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUmodel'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'], + ['threshold' => '210', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddonRelease'], ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + 'product' => ['code' => 'cms', 'title' => 'Cms'], + ], + 'ram' => [ + 'productCode' => 'Cms', + 'productName' => 'Cloud Monitor', + 'ramCodes' => ['cms'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [ + [ + 'name' => 'acs:Service', + 'schema' => ['type' => 'String', 'description' => ''], + ], + [ + 'name' => 'acs:ResourceGroupId', + 'schema' => ['type' => 'String', 'description' => ''], + ], ], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; -- cgit v1.2.3