summaryrefslogtreecommitdiff
path: root/data/zh_cn/nis
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/nis')
-rw-r--r--data/zh_cn/nis/2021-12-16/api-docs.php11013
1 files changed, 4505 insertions, 6508 deletions
diff --git a/data/zh_cn/nis/2021-12-16/api-docs.php b/data/zh_cn/nis/2021-12-16/api-docs.php
index f4ff3bb..140aeff 100644
--- a/data/zh_cn/nis/2021-12-16/api-docs.php
+++ b/data/zh_cn/nis/2021-12-16/api-docs.php
@@ -1,1074 +1,1454 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'nis',
- 'version' => '2021-12-16',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'nis', 'version' => '2021-12-16'],
'directories' => [
[
- 'id' => 391923,
- 'title' => '流量分析器',
+ 'children' => ['StartNisTrafficRanking', 'DescribeNisTrafficRanking'],
'type' => 'directory',
- 'children' => [
- 'StartNisTrafficRanking',
- 'DescribeNisTrafficRanking',
- ],
+ 'title' => '流量分析器',
+ 'id' => 387517,
],
[
- 'id' => 391926,
- 'title' => '流量分析',
+ 'children' => ['GetNisNetworkRanking', 'GetInternetTuple', 'GetNatTopN', 'GetVbrFlowTopN', 'GetTransitRouterFlowTopN'],
'type' => 'directory',
- 'children' => [
- 'GetNisNetworkRanking',
- 'GetInternetTuple',
- 'GetNatTopN',
- 'GetVbrFlowTopN',
- 'GetTransitRouterFlowTopN',
- ],
+ 'title' => '流量分析',
+ 'id' => 98115,
],
[
- 'id' => 391932,
- 'title' => '自助诊断',
+ 'children' => ['CreateNetworkReachableAnalysis', 'CreateNetworkPath', 'CreateAndAnalyzeNetworkPath', 'DeleteNetworkPath', 'DeleteNetworkReachableAnalysis', 'GetNetworkReachableAnalysis'],
'type' => 'directory',
- 'children' => [
- 'CreateNetworkReachableAnalysis',
- 'CreateNetworkPath',
- 'CreateAndAnalyzeNetworkPath',
- 'DeleteNetworkPath',
- 'DeleteNetworkReachableAnalysis',
- 'GetNetworkReachableAnalysis',
- ],
+ 'title' => '自助诊断',
+ 'id' => 98108,
],
[
- 'id' => 391939,
- 'title' => '网络Metric',
+ 'children' => ['GetNisNetworkMetrics'],
'type' => 'directory',
- 'children' => [
- 'GetNisNetworkMetrics',
- ],
+ 'title' => '网络Metric',
+ 'id' => 134747,
],
[
- 'id' => 391941,
- 'title' => '网络巡检',
+ 'children' => ['StartNisInspectionTask', 'UpdateNisInspectionTask', 'DeleteNisInspectionTask', 'ListNisInspectionTasks', 'DescribeNisInspectionTask', 'ListNisInspectionResourceType', 'DescribeNisInspectionReportStatus', 'DescribeNisInspectionReportSummary', 'DescribeNisInspectionReportCheckItems', 'DescribeNisInspectionRecommendationResources', 'ListNisInspectionTaskReports', 'DeleteNisInspectionReport'],
'type' => 'directory',
- 'children' => [
- 'StartNisInspectionTask',
- 'UpdateNisInspectionTask',
- 'DeleteNisInspectionTask',
- 'ListNisInspectionTasks',
- 'DescribeNisInspectionTask',
- 'ListNisInspectionResourceType',
- 'DescribeNisInspectionReportStatus',
- 'DescribeNisInspectionReportSummary',
- 'DescribeNisInspectionReportCheckItems',
- 'DescribeNisInspectionRecommendationResources',
- 'ListNisInspectionTaskReports',
- 'DeleteNisInspectionReport',
- ],
+ 'title' => '网络巡检',
+ 'id' => 148089,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'StartNisTrafficRanking' => [
- 'summary' => '触发NIS流量分析器执行指定范围内的流量排序任务',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateAndAnalyzeNetworkPath' => [
+ 'summary' => '调用CreateAndAnalyzeNetworkPath接口,发起网络可达性分析任务。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '222984',
- 'abilityTreeNodes' => [
- 'FEATUREnetana5MCZ6K',
- 'FEATUREnetanaOV20CD',
- 'FEATUREnetanaB9LIVJ',
- 'FEATUREnetanaCEA895',
- ],
+ 'abilityTreeCode' => '178742',
+ 'abilityTreeNodes' => ['FEATUREnetana59X9GB', 'FEATUREnetana98CV3P', 'FEATUREnetanaWZGUR4', 'FEATUREnetanaDZZVCZ', 'FEATUREnetana0CBIRP', 'FEATUREnetanaJGHZ2X', 'FEATUREnetanaRD137H', 'FEATUREnetanaCAWHBE', 'FEATUREnetana8JUW6E'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'RegionNo',
+ 'name' => 'SourceId',
'in' => 'query',
- 'schema' => [
- 'title' => '资源所在地域。',
- 'description' => '资源所在地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => '源资源ID。', 'type' => 'string', 'required' => true, 'example' => 'i-uf62y8khhbkbdrp6****'],
],
[
- 'name' => 'TrafficAnalyzerId',
+ 'name' => 'SourceIpAddress',
'in' => 'query',
- 'schema' => [
- 'title' => '资源所在地域。',
- 'description' => '流量分析器ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nta-262****ca07f',
- ],
+ 'schema' => ['description' => '源IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'],
],
[
- 'name' => 'TupleDimension',
+ 'name' => 'TargetIpAddress',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '资源所在地域。',
- 'description' => '流量存储聚合维度。'."\n"
- ."\n"
- .'根据TraffficScenario场景:'."\n"
- ."\n"
- .'- VpcFlowLogAll/VpcFlowLog:必传,用于指定查询特定的存储聚合视图,和流量分析器中配置的存储聚合属性对应。'."\n"
- ."\n"
- .'- TRFlowLog/CbwpMetric:非必传,根据流量分析器存储聚合属性自适应。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Tuple5' => '五元组',
- 'Tuple1' => '一元组',
- 'Tuple2' => '二元组',
- ],
- 'example' => 'Tuple1',
- 'enum' => [
- 'Tuple1',
- 'Tuple2',
- 'Tuple5',
- ],
- ],
+ 'schema' => ['description' => '目的IP地址。', 'type' => 'string', 'required' => false, 'example' => '172.50.XX.XX'],
],
[
- 'name' => 'TrafficScenario',
+ 'name' => 'SourceType',
+ 'in' => 'query',
+ 'schema' => ['description' => '源资源类型。'."\n"
+ ."\n"
+ .' - **ecs**:云服务器ECS(Elastic Compute Service)。'."\n"
+ .' - **internetIp**:公网IP地址。'."\n"
+ .' - **vsw**:交换机(vSwitch)。'."\n"
+ .' - **vpn**:VPN网关。'."\n"
+ .' - **vbr**:边界路由器VBR(Virtual Border Router)。', 'type' => 'string', 'required' => true, 'example' => 'ecs'],
+ ],
+ [
+ 'name' => 'SourcePort',
+ 'in' => 'query',
+ 'schema' => ['description' => '源端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'TargetId',
+ 'in' => 'query',
+ 'schema' => ['description' => '目的资源ID。'."\n"
+ ."\n"
+ .'> 调用该API时,TargetId参数必须输入。', 'type' => 'string', 'required' => false, 'example' => 'i-m5eactvw7wtpktv5****'],
+ ],
+ [
+ 'name' => 'TargetType',
+ 'in' => 'query',
+ 'schema' => ['description' => '目的资源类型。'."\n"
+ .' - **ecs**:云服务器ECS(Elastic Compute Service)。 '."\n"
+ .'- **internetIp**:公网IP地址。'."\n"
+ .' - **vsw**:交换机(vSwitch)。'."\n"
+ .' - **vpn**:VPN网关。'."\n"
+ .' - **vbr**:边界路由器VBR(Virtual Border Router)。'."\n"
+ .' - **clb**:传统型负载均衡CLB(Classic Load Balancer)。'."\n"
+ ."\n"
+ .'>调用该API时,TargetType参数必须输入。', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
+ ],
+ [
+ 'name' => 'TargetPort',
+ 'in' => 'query',
+ 'schema' => ['description' => '目的端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => '协议类型。取值:'."\n"
+ ."\n"
+ .' - **tcp**:传输控制协议。'."\n"
+ .' - **udp**:用户数据报协议。'."\n"
+ .' - **icmp**:网络控制报文协议。'."\n"
+ ."\n"
+ .'> 调用该API时,Protocol参数必须输入。', 'type' => 'string', 'required' => false, 'example' => 'tcp'],
+ ],
+ [
+ 'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => '要发起网络可达性分析任务的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '按流量转发所使用的阿里云网络资源类型进行分析,枚举如下:'."\n"
- .'AccessInternetIPV4:所有阿里云公网类型IPV4。'."\n"
- .'AccessInternetIPV4Limited:所有受地域限速的阿里云公网类型IPV4。'."\n"
- .'ElasticIP: 弹性公网EIP(IPV4)。'."\n"
- .'PublicIpEcs: 绑定在ECS的固定公网IP(IPV4)。'."\n"
- .'PublicIpClb: 绑定在CLB的固定公网IP(IPV4)。'."\n"
- .'GA:全球加速。'."\n"
- .'NAT:通过SNAT的访问公网流量。'."\n"
- .'TR:流经云企业网转发路由器的流量。'."\n"
- .'TRAttachment:流经云企业网连接实例的流量,包括地域内连接和跨地域连接。'."\n"
- .'VBR:流经边界路由器的流量。'."\n"
- .'GA:流经全球加速的流量。'."\n"
- .'ECR:流经ECR的流量。'."\n"
- .'VPC:流经VPC的流量。'."\n"
- .'InternetProbing: 公网探测数据。'."\n"
- .'IntranetProbing: 内网探测数据。',
- 'description' => '支持分析场景: '."\n"
- ."\n"
- .'- 全部VPC流日志分析'."\n"
- .'- 公网VPC流日志分析'."\n"
- .'- 全部TR流日志分析'."\n"
- .'- 共享带宽指标分析',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'VpcFlowLogAll',
- 'enum' => [
- 'VpcFlowLogAll',
- 'VpcFlowLogInternet',
- 'TRFlowLog',
- 'CbwpMetric',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B'],
+ 'NetworkReachableAnalysisId' => ['description' => '发起的网络可达性分析任务ID。', 'type' => 'string', 'example' => 'nra-dfe9e53d2b524568****'],
+ 'SourceId' => ['description' => '源资源ID。', 'type' => 'string', 'example' => 'i-uf62y8khhbkbdrp6****'],
+ 'TargetId' => ['description' => '目的资源ID。', 'type' => 'string', 'example' => 'i-m5eactvw7wtpktv5****'],
+ 'SourceType' => ['description' => '源资源类型。', 'type' => 'string', 'example' => 'ecs'],
+ 'TargetType' => ['description' => '目的资源类型。', 'type' => 'string', 'example' => 'ecs'],
+ 'SourcePort' => ['description' => '源端口。', 'type' => 'string', 'example' => '0'],
+ 'TargetPort' => ['description' => '目的端口。', 'type' => 'string', 'example' => '80'],
+ 'Protocol' => ['description' => '协议类型。', 'type' => 'string', 'example' => 'tcp'],
+ 'SourceIpAddress' => ['description' => '源IP地址。', 'type' => 'string', 'example' => '192.168.XX.XX'],
+ 'TargetIpAddress' => ['description' => '目的IP地址。', 'type' => 'string', 'example' => '172.50.XX.XX'],
],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalParam.InternetIP', 'errorMessage' => 'The specified IP address (%s) is not an internet IP address.', 'description' => '指定的IP(%s)不是公网地址。即IP地址不能在10.0.0.0~10.255.255.255、172.16.0.0 ~172.31.255.255、192.168.0.0~192.168.255.255 这3个地址段内。'],
+ ['errorCode' => 'IllegalParam.IP', 'errorMessage' => 'The specified IP address (%s) is invalid.', 'description' => '指定的IP地址(%s)无效。'],
+ ['errorCode' => 'Mismatch.SourceIdAndTargetId', 'errorMessage' => 'Reachability Analyzer does not support the scenario in which source and target Internet IP addresses and ECS instance ID (%s and %s) are bound.', 'description' => '路径分析不支持源与目的的公网IP和ECS实例ID(%s和%s)具有绑定关系。'],
+ ['errorCode' => 'IllegalParam.SourceAndTargetInternetIp', 'errorMessage' => 'Both source ID and target ID are IP addresses, but are not Internet IP addresses. Reachability Analyzer does not support the scenario.', 'description' => '源与目的都是IP,但都不是阿里云公网IP,路径分析不支持这种场景。'],
+ ['errorCode' => 'IllegalParam.SourcePort', 'errorMessage' => 'The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536].', 'description' => 'SourcePort参数不合法,必须介于0到65536(含)之间。'],
+ ['errorCode' => 'IllegalParam.TargetPort', 'errorMessage' => 'The specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536].', 'description' => 'TargetPort参数不合法,必须介于0到65536(含)之间。'],
+ ['errorCode' => 'IllegalParam.SourceId', 'errorMessage' => 'The specified SourceId(%s) may be not exist.', 'description' => '指定的实例(%s)可能不存在,请检查是否拼写错误。'],
+ ['errorCode' => 'IllegalParam.TargetId', 'errorMessage' => 'The specified TargetId(%s) may be not exist.', 'description' => '指定的实例(%s)可能不存在,请检查是否拼写错误。'],
+ ['errorCode' => 'IllegalParam.SourceIp', 'errorMessage' => 'Please enter a valid source IP.', 'description' => '请输入合法的源IP'],
+ ['errorCode' => 'IllegalParam.SourceType', 'errorMessage' => 'The specified source type (%s) is invalid.', 'description' => '指定的源类型(%s)无效。'],
+ ['errorCode' => 'IllegalParam.Protocol', 'errorMessage' => 'The specified Protocol(%s) is invalid.', 'description' => '指定的Protocol(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.TargetType', 'errorMessage' => 'The specified target type (%s) is invalid.', 'description' => '指定的目的类型(%s)无效。'],
+ ['errorCode' => 'IllegalParam.TargetIp', 'errorMessage' => 'The specified target ip (%s) is invalid.', 'description' => '指定的目的IP(%s)格式不正确。'],
+ ['errorCode' => 'IllegalParam.NotSupportHaVpn', 'errorMessage' => 'The specified VPN(%s), which is not currently supported for such instances.', 'description' => '指定的VPN(%s)是HaVpn,此类实例目前尚不支持。'."\n"],
+ ['errorCode' => 'IllegalParam.SourceNotBound', 'errorMessage' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.', 'description' => '弹性公网IP(%s)未绑定资源,暂不支持分析。'],
+ ['errorCode' => 'IllegalParam.TargetNotBound', 'errorMessage' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.', 'description' => '弹性公网IP(%s)未绑定资源,暂不支持分析。'],
+ ['errorCode' => 'IllegalParam.NotPublicIp', 'errorMessage' => 'The specified (%s) is invalid.', 'description' => '指定的参数 (%s) 不是公网IP。'."\n"],
+ ['errorCode' => 'IllegalParam.SourceEqualTarget', 'errorMessage' => 'The specified source and destination are identical, which is not supported for analysis.', 'description' => '指定的源和目的相同,不支持分析。'],
+ ['errorCode' => 'IllegalParam.TypeAndIdMismatch', 'errorMessage' => 'The specified instanceId (%s) and type do not match.', 'description' => '指定的实例 (%s) 和实例类型不匹配。'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden.NetworkPath', 'errorMessage' => 'The current user has not activated NIS and is not authorized to use the path analysis interface.', 'description' => '当前用户未开通NIS,无权限使用路径分析接口。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '发起网络可达性分析任务',
+ 'description' => '该接口根据输入的源和目的信息,无需创建网络分析路径,直接发起可达性分析任务。返回分析结果后,将不在系统中记录,如需在NIS中留存网络路径或可达性分析任务结果,建议使用**createNetworkReachableAnalysis**接口。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAndAnalyzeNetworkPath'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Direction',
- 'in' => 'query',
- 'schema' => [
- 'title' => '基于阿里云资源的网络流量方向:'."\n"
- .'in:流入资源的流量方向。'."\n"
- .'out:流出资源的流量方向。'."\n"
- .'跨域流量分析因只采集出向流量,所以传入in也以out处理。'."\n"
- .'地域内性能观测和地域间性能观测因需在Filter内指定源或目的,所以可以任意指定Direction。',
- 'description' => '基于阿里云资源的网络流量方向'."\n"
- ."\n"
- .'In:流入目标资源的流量方向。'."\n"
- .'Out:流出目标资源的流量方向。'."\n"
- ."\n"
- .'- VPC 流日志场景(`TraffficScenario = VpcFlowLogAll` / `VpcFlowLogInternet `)'."\n"
- .' - In:流入 ENI 的流量。'."\n"
- .' - Out:流出 ENI 的流量。'."\n"
- ."\n"
- .'- TR 流日志场景(`TraffficScenario = TRFlowlog`)'."\n"
- .' - In:流入 TR 的流量。'."\n"
- .' - Out:流出 TR 的流量。'."\n"
- ."\n"
- .'- 共享带宽指标分析场景(`TraffficScenario = CbwpMetric`)'."\n"
- .' - In:流入 EIP 的流量。'."\n"
- .' - Out:流出 EIP 的流量。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Out',
- 'enum' => [
- 'In',
- 'Out',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:CreateAndAnalyzeNetworkPath',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"NetworkReachableAnalysisId\\": \\"nra-dfe9e53d2b524568****\\",\\n \\"SourceId\\": \\"i-uf62y8khhbkbdrp6****\\",\\n \\"TargetId\\": \\"i-m5eactvw7wtpktv5****\\",\\n \\"SourceType\\": \\"ecs\\",\\n \\"TargetType\\": \\"ecs\\",\\n \\"SourcePort\\": \\"0\\",\\n \\"TargetPort\\": \\"80\\",\\n \\"Protocol\\": \\"tcp\\",\\n \\"SourceIpAddress\\": \\"192.168.XX.XX\\",\\n \\"TargetIpAddress\\": \\"172.50.XX.XX\\"\\n}","type":"json"}]',
+ ],
+ 'CreateNetworkPath' => [
+ 'summary' => '调用CreateNetworkPath接口,创建网络分析路径,用于云上网络路径可达性分析。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'GroupBy',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '116922',
+ 'abilityTreeNodes' => ['FEATUREnetana59X9GB', 'FEATUREnetana98CV3P', 'FEATUREnetanaWZGUR4', 'FEATUREnetanaDZZVCZ', 'FEATUREnetana0CBIRP', 'FEATUREnetanaJGHZ2X', 'FEATUREnetanaRD137H', 'FEATUREnetanaCAWHBE', 'FEATUREnetana8JUW6E'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => '要创建网络分析路径的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'maxLength' => 64],
+ ],
+ [
+ 'name' => 'NetworkPathName',
+ 'in' => 'query',
+ 'schema' => ['description' => '路径名称。', 'type' => 'string', 'required' => true, 'example' => 'ecs2PublicIp', 'maxLength' => 128],
+ ],
+ [
+ 'name' => 'SourceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '源资源ID。', 'type' => 'string', 'required' => true, 'example' => 'i-2zef4ngqfarepyun****'],
+ ],
+ [
+ 'name' => 'SourceType',
+ 'in' => 'query',
+ 'schema' => ['description' => '源资源类型。'."\n"
+ ."\n"
+ .' - **ecs**:云服务器ECS(Elastic Compute Service)。'."\n"
+ .' - **internetIp**:公网IP地址。'."\n"
+ .' - **vsw**:交换机(vSwitch)。'."\n"
+ .' - **vpn**:VPN网关。'."\n"
+ .' - **vbr**:边界路由器VBR(Virtual Border Router)。', 'type' => 'string', 'required' => true, 'example' => 'ecs'],
+ ],
+ [
+ 'name' => 'SourceIpAddress',
+ 'in' => 'query',
+ 'schema' => ['description' => '源IP地址。', 'type' => 'string', 'required' => false, 'example' => '172.17.XX.XX'],
+ ],
+ [
+ 'name' => 'SourcePort',
+ 'in' => 'query',
+ 'schema' => ['description' => '源端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443'],
+ ],
+ [
+ 'name' => 'TargetId',
+ 'in' => 'query',
+ 'schema' => ['description' => '目的资源ID。'."\n"
+ .'>调用该API时,TargetId参数必须输入。', 'type' => 'string', 'required' => false, 'minimum' => '0', 'example' => 'i-bp13d0e064gubm****', 'maxItems' => 24],
+ ],
+ [
+ 'name' => 'TargetType',
+ 'in' => 'query',
+ 'schema' => ['description' => '目的资源类型。'."\n"
+ .' - **ecs**:云服务器ECS(Elastic Compute Service)。 '."\n"
+ .'- **internetIp**:公网IP地址。'."\n"
+ .' - **vsw**:交换机(vSwitch)。'."\n"
+ .' - **vpn**:VPN网关。'."\n"
+ .' - **vbr**:边界路由器VBR(Virtual Border Router)。'."\n"
+ .' - **clb**:传统型负载均衡CLB(Classic Load Balancer)。'."\n"
+ ."\n"
+ .'> 调用该API时,TargetType参数必须输入。', 'type' => 'string', 'required' => false, 'minimum' => '0', 'example' => 'ecs', 'maxItems' => 24],
+ ],
+ [
+ 'name' => 'TargetIpAddress',
+ 'in' => 'query',
+ 'schema' => ['description' => '目的IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'],
+ ],
+ [
+ 'name' => 'TargetPort',
+ 'in' => 'query',
+ 'schema' => ['description' => '目的端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => '协议类型。取值:'."\n"
+ ."\n"
+ .' - **tcp**:传输控制协议。'."\n"
+ .' - **udp**:用户数据报协议。'."\n"
+ .' - **icmp**:网络控制报文协议。'."\n"
+ .'> 调用该API时,Protocol参数必须输入。', 'type' => 'string', 'required' => false, 'example' => 'tcp', 'maxLength' => 16],
+ ],
+ [
+ 'name' => 'NetworkPathDescription',
+ 'in' => 'query',
+ 'schema' => ['description' => '网络路径的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Analysis ECS to ECS path'],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '支持基于指定的多项流量维度进行聚合排序。',
+ 'description' => '标签列表。',
'type' => 'array',
'items' => [
- 'description' => '根据 `TupleDimension` 字段和 `TrafficScenario` 字段,可以指定流量的聚合维度如下:'."\n"
- ."\n"
- .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet `(VPC 流日志场景):'."\n"
- ."\n"
- .' - `TupleDimension = Tuple1` 时,支持:'."\n"
- .' - `VpcId`:VPC ID'."\n"
- .' - `VSwitchId`:交换机 ID'."\n"
- .' - `CloudIp`:云端 IP'."\n"
- ."\n"
- .' - `TupleDimension = Tuple2` 时,支持:'."\n"
- .' - `VpcId`:VPC ID'."\n"
- .' - `VSwitchId`:交换机 ID'."\n"
- .' - `SourceIp`:源端 IP'."\n"
- .' - `DestinationIp`:目的端 IP'."\n"
- .' - `TrafficPath`:流量路径'."\n"
- ."\n"
- .' - `TupleDimension = Tuple5` 时,支持:'."\n"
- .' - `VpcId`:VPC ID'."\n"
- .' - `VSwitchId`:交换机 ID'."\n"
- .' - `SourceIp`:源端 IP'."\n"
- .' - `DestinationIp`:目的端 IP'."\n"
- .' - `TrafficPath`:流量路径'."\n"
- .' - `SourcePort`:源端端口'."\n"
- .' - `DestinationPort`:目的端端口'."\n"
- .' - `Protocol`:网络协议'."\n"
- ."\n"
- .' - 统计 VPC 公网场景(`TrafficScenario = VpcFlowLogInternet`)时,额外支持:'."\n"
- .' - `Country`:客户端国家'."\n"
- .' - `Province`:客户端省份'."\n"
- .' - `City`:客户端城市'."\n"
- .' - `Isp`:网络服务提供商'."\n"
- .' - `Asn`:自治系统号码'."\n"
- ."\n"
- .'- `TrafficScenario = TRFlowlog`(TR 流日志场景,元组自适应,`TupleDimension` 非必填)支持:'."\n"
- .' - `TransitRouterAttachmentId`: 网络实例连接 ID(必填)'."\n"
- .' - `TransitRouterId`:转发路由器实例 ID'."\n"
- .' - `SourceIp`:源端 IP'."\n"
- .' - `DestinationIp`:目的端 IP'."\n"
- .' - `Dscp`:区分服务代码点'."\n"
- .' - `Protocol`:网络协议'."\n"
- .' - `SourcePort`:源端端口'."\n"
- .' - `DestinationPort`:目的端端口'."\n"
- .' - `非TR跨地域场景` 下,额外支持:'."\n"
- .' - `TransitRouterSourceResourceId`:源网络实例 ID'."\n"
- .' - `TransitRouterDestinationResourceId`:目的网络实例 ID'."\n"
- .' - `VPC连接流量场景` 下,额外支持:'."\n"
- .' - `TransitRouterSourceNetworkInterface`:源TR ENI'."\n"
- .' - `TransitRouterDestinationNetworkInterface`:目的TR ENI'."\n"
- ."\n"
- .'- `TrafficScenario = CbwpMetric`(CBWP 指标分析场景,`TupleDimension` 非必填)支持:'."\n"
- .' - `PublicIpAddress`:绑定的 EIP 的公网 IP 地址'."\n"
- .' - `BindingResourceType`:EIP 所绑定的实例资源类型'."\n"
- .' - `BindingResourceId`:EIP 所绑定的实例资源 ID'."\n"
- .' - `CbwpId`:共享带宽包 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["VpcId"]',
- 'enum' => [
- 'VpcId',
- 'VSwitchId',
- 'CloudIp',
- 'SourceIp',
- 'DestinationIp',
- 'Protocol',
- 'SourcePort',
- 'DestinationPort',
- 'TrafficPath',
- 'Country',
- 'Province',
- 'City',
- 'Isp',
- 'Asn',
- 'TransitRouterAttachmentId',
- 'Dscp',
- 'TransitRouterPairAttachmentId',
- 'TransitRouterSourceResourceId',
- 'TransitRouterDestinationResourceId',
- 'TransitRouterSourceNetworkInterface',
- 'TransitRouterDestinationNetworkInterface',
- 'TransitRouterId',
- 'BindingResourceId',
- 'BindingResourceType',
- 'CbwpId',
- 'PublicIpAddress',
+ 'description' => '标签信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。最多支持128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或`https://`。'."\n"
+ ."\n"
+ .'一次调用最多支持添加20个标签。', 'type' => 'string', 'required' => false, 'example' => 'role'],
+ 'Value' => ['description' => '标签值。最多支持输入20个标签值。一旦输入该值,可以为空字符串。'."\n"
+ ."\n"
+ .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'ops'],
],
+ 'required' => false,
],
'required' => false,
+ 'maxItems' => 21,
],
],
[
- 'name' => 'OrderBy',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
+ 'schema' => ['description' => '路径所属的资源组。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm27qsxjj****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '指定公网流量进行排名的指标。大小写敏感。'."\n"
- .' bps:每秒比特数。'."\n"
- .' pps:每秒包数。'."\n"
- .' ByteCount:累计字节数。'."\n"
- .' PacketCount:累计包数。'."\n"
- .'公网场景特有参数:'."\n"
- .' rtt:tcp协议建立连接时的往返延迟。'."\n"
- .' RetransmitRate:重传率。'."\n"
- .'区域级限速场景特有参数:'."\n"
- .' RatelimitDropPps:限速丢包速率。'."\n"
- .'NAT场景特有参数:'."\n"
- .' ActiveSessionCount:并发会话数。'."\n"
- .' NewSessionPerSecond:每秒新建会话数。',
- 'description' => '根据 `TrafficScenario` 字段,支持按以下指标对流量进行排名:'."\n"
- ."\n"
- .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet `(VPC 流日志场景):'."\n"
- .' - `Bytes`:带宽'."\n"
- .' - `Packets`:包数'."\n"
- .' - `RoundTripTime`:TCP RTT'."\n"
- ."\n"
- .'- `TrafficScenario = TRFlowlog`(TR 流日志场景):'."\n"
- .' - `Bytes`:带宽'."\n"
- .' - `Packets`:包数'."\n"
- .' - `PacketsLostNoRoute`:无路由丢包数'."\n"
- .' - `PacketsLostBlackhole`:黑洞路由丢包数'."\n"
- .' - `PacketsLostTTLExpired`:TTL 超时丢包数'."\n"
- ."\n"
- .'- `TrafficScenario = CbwpMetric`(共享带宽指标分析场景):'."\n"
- .' - `Bytes`:带宽'."\n"
- .' - `Packets`:包数',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Bytes',
- 'enum' => [
- 'Bytes',
- 'Packets',
- 'RoundTripTime',
- 'PacketsLostNoRoute',
- 'PacketsLostBlackhole',
- 'PacketsLostTTLExpired',
+ 'type' => 'object',
+ 'properties' => [
+ 'NetworkPathId' => ['description' => '网络路径ID。', 'type' => 'string', 'example' => 'np-4cbf598673d14d27****'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '92DD9FFB-06FB-56F7-83EF-5CEF98F5562A'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalParam.InternetIP', 'errorMessage' => 'The specified IP address (%s) is not an internet IP address.', 'description' => '指定的IP(%s)不是公网地址。即IP地址不能在10.0.0.0~10.255.255.255、172.16.0.0 ~172.31.255.255、192.168.0.0~192.168.255.255 这3个地址段内。'],
+ ['errorCode' => 'IllegalParam.IP', 'errorMessage' => 'The specified IP address (%s) is invalid.', 'description' => '指定的IP地址(%s)无效。'],
+ ['errorCode' => 'QuotaExceeded.NetworkPath', 'errorMessage' => 'The quota of %s is exceeded, usage %s/%s.', 'description' => '网络路径数量(%s)超过阈值,使用率:%s/%s。'],
+ ['errorCode' => 'ResourceAlreadyExist.NetworkPath', 'errorMessage' => 'The specified resource of %s already exists.', 'description' => '指定的网络路径配置%s已存在。'],
+ ['errorCode' => 'Mismatch.SourceIdAndTargetId', 'errorMessage' => 'Reachability Analyzer does not support the scenario in which source and target Internet IP addresses and ECS instance ID (%s and %s) are bound.', 'description' => '路径分析不支持源与目的的公网IP和ECS实例ID(%s和%s)具有绑定关系。'],
+ ['errorCode' => 'IllegalParam.SourceAndTargetInternetIp', 'errorMessage' => 'Both source ID and target ID are IP addresses, but are not Internet IP addresses. Reachability Analyzer does not support the scenario.', 'description' => '源与目的都是IP,但都不是阿里云公网IP,路径分析不支持这种场景。'],
+ ['errorCode' => 'IllegalParam.SourcePort', 'errorMessage' => 'The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536].', 'description' => 'SourcePort参数不合法,必须介于0到65536(含)之间。'],
+ ['errorCode' => 'IllegalParam.TargetPort', 'errorMessage' => 'The specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536].', 'description' => 'TargetPort参数不合法,必须介于0到65536(含)之间。'],
+ ['errorCode' => 'IllegalParam.SourceId', 'errorMessage' => 'The specified SourceId(%s) may be not exist.', 'description' => '指定的实例(%s)可能不存在,请检查是否拼写错误。'],
+ ['errorCode' => 'IllegalParam.TargetId', 'errorMessage' => 'The specified TargetId(%s) may be not exist.', 'description' => '指定的实例(%s)可能不存在,请检查是否拼写错误。'],
+ ['errorCode' => 'MissingParameter.TagValue', 'errorMessage' => 'You must specify Tag.N.Value.', 'description' => '必须指定Tag的Value。'],
+ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => '超过了标签的最大数目。'],
+ ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => 'Tag的包含重复的key。'],
+ ['errorCode' => 'MissingParameter.TagKey', 'errorMessage' => 'You must specify Tag.N.Key.', 'description' => '必须指定Tag的Key。'],
+ ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => 'Tag的Key参数无效'],
+ ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => 'Tag的Value参数无效。'],
+ ['errorCode' => 'IllegalParam.SourceIp', 'errorMessage' => 'Please enter a valid source IP.', 'description' => '请输入合法的源IP'],
+ ['errorCode' => 'IllegalParam.Protocol', 'errorMessage' => 'The specified Protocol(%s) is invalid.', 'description' => '指定的Protocol(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.TargetType', 'errorMessage' => 'The specified target type (%s) is invalid.', 'description' => '指定的目的类型(%s)无效。'],
+ ['errorCode' => 'IllegalParam.SourceType', 'errorMessage' => 'The specified source type (%s) is invalid.', 'description' => '指定的源类型(%s)无效。'],
+ ['errorCode' => 'IllegalParam.TargetIp', 'errorMessage' => 'The specified target ip (%s) is invalid.', 'description' => '指定的目的IP(%s)格式不正确。'],
+ ['errorCode' => 'IllegalParam.NotSupportHaVpn', 'errorMessage' => 'The specified VPN(%s), which is not currently supported for such instances.', 'description' => '指定的VPN(%s)是HaVpn,此类实例目前尚不支持。'."\n"],
+ ['errorCode' => 'IllegalParam.SourceNotBound', 'errorMessage' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.', 'description' => '弹性公网IP(%s)未绑定资源,暂不支持分析。'],
+ ['errorCode' => 'IllegalParam.TargetNotBound', 'errorMessage' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.', 'description' => '弹性公网IP(%s)未绑定资源,暂不支持分析。'],
+ ['errorCode' => 'IllegalParam.NotPublicIp', 'errorMessage' => 'The specified (%s) is invalid.', 'description' => '指定的参数 (%s) 不是公网IP。'."\n"],
+ ['errorCode' => 'IllegalParam.SourceEqualTarget', 'errorMessage' => 'The specified source and destination are identical, which is not supported for analysis.', 'description' => '指定的源和目的相同,不支持分析。'],
+ ['errorCode' => 'IllegalParam.TypeAndIdMismatch', 'errorMessage' => 'The specified instanceId (%s) and type do not match.', 'description' => '指定的实例 (%s) 和实例类型不匹配。'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden.NetworkPath', 'errorMessage' => 'The current user has not activated NIS and is not authorized to use the path analysis interface.', 'description' => '当前用户未开通NIS,无权限使用路径分析接口。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NetworkPathId\\": \\"np-4cbf598673d14d27****\\",\\n \\"RequestId\\": \\"92DD9FFB-06FB-56F7-83EF-5CEF98F5562A\\"\\n}","type":"json"}]',
+ 'title' => '创建网络分析路径',
+ 'description' => '- **CreateNetworkPath**接口支持多种组网场景以及多种资源间的路径创建,路径创建后,路径参数将被保存,便于重复分析。'."\n"
+ .' - 一个阿里云账号(主账号)最多支持创建100条路径。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNetworkPath'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:CreateNetworkPath',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkPath', 'arn' => 'acs:nis:*:{#accountId}:networkpath/*'],
],
],
],
+ ],
+ ],
+ 'CreateNetworkReachableAnalysis' => [
+ 'summary' => '调用CreateNetworkReachableAnalysis接口,创建网络可达性分析任务。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Filter',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => '要创建网络可达性分析的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ [
+ 'name' => 'NetworkPathId',
+ 'in' => 'query',
+ 'schema' => ['description' => '网络路径ID。 您可以通过调用[CreateNetworkPath](~~2366522~~)接口获取网络路径ID。', 'type' => 'string', 'required' => true, 'example' => 'np-b2f618ceb2c84057****'],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '支持进一步指定流量的过滤条件,进行聚焦性流量分析。',
- 'description' => '支持进一步指定流量的过滤条件,进行聚焦性流量分析。',
+ 'description' => '标签列表。',
'type' => 'array',
'items' => [
- 'description' => '指定流量的过滤条件,Key-Value-Operator对象。',
+ 'description' => '标签信息。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '根据 TupleDimension 字段和 TrafficScenario 字段,支持过滤的条件标签键,如下所示:'."\n"
- ."\n"
- .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet`(VPC 流日志场景):'."\n"
- ."\n"
- .' - `TupleDimension` 为一元组时,支持:'."\n"
- .' - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填,对应value值不可多选)'."\n"
- .' - `VpcId`:VPC ID(对应value值可多选)'."\n"
- .' - `VSwitchId`:交换机 ID(对应value值可多选)'."\n"
- .' - `NetworkInterfaceId`:弹性网卡 ID(对应value值可多选)'."\n"
- .' - `EcsId`:云服务器 ECS ID(对应value值可多选)'."\n"
- .' - `CloudIp`:云端 IP(对应value值可多选)'."\n"
- ."\n"
- .' - `TupleDimension` 为二元组时,支持:'."\n"
- .' - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填,对应value值不可多选)'."\n"
- .' - `VpcId`:VPC ID(对应value值可多选)'."\n"
- .' - `VSwitchId`:交换机 ID(对应value值可多选)'."\n"
- .' - `NetworkInterfaceId`:弹性网卡 ID(对应value值可多选)'."\n"
- .' - `EcsId`:云服务器 ECS ID(对应value值可多选)'."\n"
- .' - `SourceIp`:源端 IP(对应value值可多选)'."\n"
- .' - `DestinationIp`:目的端 IP(对应value值可多选)'."\n"
- .' - `TrafficPath`:流量路径(对应value值可多选)'."\n"
- ."\n"
- .' - `TupleDimension` 为五元组时,支持:'."\n"
- .' - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填,对应value值不可多选)'."\n"
- .' - `VpcId`:VPC ID(对应value值可多选)'."\n"
- .' - `VSwitchId`:交换机 ID(对应value值可多选)'."\n"
- .' - `NetworkInterfaceId`:弹性网卡 ID(对应value值可多选)'."\n"
- .' - `EcsId`:云服务器 ECS ID(对应value值可多选)'."\n"
- .' - `SourceIp`:源端 IP'."\n"
- .' - `DestinationIp`:目的端 IP'."\n"
- .' - `TrafficPath`:流量路径(对应value值可多选)'."\n"
- .' - `SourcePort`:源端口(对应value值可多选)'."\n"
- .' - `DestinationPort`:目的端口(对应value值可多选)'."\n"
- .' - `Protocol`:网络协议(对应value值可多选)'."\n"
- ."\n"
- .' - VPC 公网场景(`TrafficScenario = VpcFlowLogInternet`)下,按互联网位置进行过滤时,额外支持:'."\n"
- .' - `ClientCountry`:按国家过滤流量分析范围(对应value值可多选)'."\n"
- .' - `ClientCity`:按城市过滤流量分析范围(对应value值可多选)'."\n"
- .' - `ClientAsn`:按 ASN 过滤流量分析范围(对应value值可多选)'."\n"
- .' - `ClientIsp`:按客户端运营商过滤流量分析范围(对应value值可多选)'."\n"
- ."\n"
- .' - VPC 场景下,均可按流量指标过滤:'."\n"
- .' - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应value值不可多选)'."\n"
- .' - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应value值不可多选)'."\n"
- .' - `MinRoundTripTime`:指定参与排序的最小 RTT,单位 ms(对应value值不可多选)'."\n"
- .' - `MaxRoundTripTime`:指定参与排序的最大 RTT,单位 ms(对应value值不可多选)'."\n"
- .' - `MinPackages`:指定参与排序的最小包数,单位个(对应value值不可多选)'."\n"
- .' - `MaxPackages`:指定参与排序的最大包数,单位个(对应value值不可多选)'."\n"
- ."\n"
- .'---'."\n"
- ."\n"
- .'- `TrafficScenario = TRFlowlog`(TR 流日志场景):'."\n"
- ."\n"
- .' - 查询二元组或自适应为二元组时,支持:'."\n"
- .' - `TransitRouterAttachmentId`:网络实例连接 ID(必填,对应value值不可多选)'."\n"
- .' - `TransitRouterPairAttachmentId`:对端TR连接ID(对应value值可多选)'."\n"
- .' - `TransitRouterId`:转发路由器实例 ID(对应value值可多选)'."\n"
- .' - `SourceIp`:源端 IP(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)'."\n"
- .' - `DestinationIp`:目的端 IP(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)'."\n"
- .' - `Dscp`:区分服务代码点(对应value值可多选)'."\n"
- ."\n"
- .' - 查询五元组或自适应为五元组时,在二元组支持的基础上,额外支持:'."\n"
- .' - `Protocol`:网络协议(对应value值可多选)'."\n"
- .' - `SourcePort`:源端端口(对应value值可多选)'."\n"
- .' - `DestinationPort`:目的端端口(对应value值可多选)'."\n"
- .' - `非TR跨地域场景` 下,额外支持:'."\n"
- .' - `TransitRouterSourceResourceId`:源网络实例 ID(对应value值可多选)'."\n"
- .' - `TransitRouterDestinationResourceId`:目的网络实例 ID(对应value值可多选)'."\n"
- .' - `VPC连接流量场景` 下,额外支持:'."\n"
- .' - `TransitRouterSourceNetworkInterface`:源TR ENI(对应value值可多选)'."\n"
- .' - `TransitRouterDestinationNetworkInterface`:目的TR ENI(对应value值可多选)'."\n"
- ."\n"
- .' - TR 场景下,均可按流量指标过滤:'."\n"
- .' - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应value值不可多选)'."\n"
- .' - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应value值不可多选)'."\n"
- .' - `MinPackages`:指定参与排序的最小包数,单位个(对应value值不可多选)'."\n"
- .' - `MaxPackages`:指定参与排序的最大包数,单位个(对应value值不可多选)'."\n"
- .' - `MinPacketsLostNoRoute`:最小无路由丢包数,单位个(对应value值不可多选)'."\n"
- .' - `MinPacketsLostBlackhole`:最小黑洞路由丢包数,单位个(对应value值不可多选)'."\n"
- .' - `MinPacketsLostTTLExpired`:最小 TTL 超时丢包数,单位个(对应value值不可多选)'."\n"
- .' - `MaxPacketsLostNoRoute`:最大无路由丢包数,单位个(对应value值不可多选)'."\n"
- .' - `MaxPacketsLostBlackhole`:最大黑洞路由丢包数,单位个(对应value值不可多选)'."\n"
- .' - `MaxPacketsLostTTLExpired`:最大 TTL 超时丢包数,单位个(对应value值不可多选)'."\n"
- ."\n"
- .'---'."\n"
- ."\n"
- .'- `TrafficScenario = CbwpMetric`(共享带宽指标分析场景):'."\n"
- ."\n"
- .' - 按条件过滤,支持:'."\n"
- .' - `PublicIpAddress`:绑定的 EIP 的公网 IP 地址(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)'."\n"
- .' - `BindingResourceType`:EIP 所绑定的实例资源类型(对应value值可多选)'."\n"
- .' - `BindingResourceId`:EIP 所绑定的实例资源 ID(对应value值可多选)'."\n"
- .' - `CbwpId`:共享带宽包 ID(必填,对应value值不可多选)'."\n"
- .' - `InstanceId`:共享带宽包所绑定的 EIP ID(对应value值可多选)'."\n"
- ."\n"
- .' - CBWP 场景下,均可按流量指标过滤:'."\n"
- .' - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应value值不可多选)'."\n"
- .' - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应value值不可多选)'."\n"
- .' - `MinPackages`:指定参与排序的最小包数,单位个(对应value值不可多选)'."\n"
- .' - `MaxPackages`:指定参与排序的最大包数,单位个(对应value值不可多选)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FlowAction',
- 'enum' => [
- 'FlowAction',
- 'VpcId',
- 'VSwitchId',
- 'NetworkInterfaceId',
- 'CloudIp',
- 'DestinationIp',
- 'SourceIp',
- 'EcsId',
- 'TrafficPath',
- 'ClientCountry',
- 'ClientCity',
- 'ClientAsn',
- 'ClientIsp',
- 'SourcePort',
- 'DestinationPort',
- 'Protocol',
- 'MinBytes',
- 'MaxBytes',
- 'MinRoundTripTime',
- 'MaxRoundTripTime',
- 'MinPackages',
- 'MaxPackages',
- 'TransitRouterAttachmentId',
- 'Dscp',
- 'TransitRouterPairAttachmentId',
- 'MinPacketsLostBlackhole',
- 'MaxPacketsLostBlackhole',
- 'MinPacketsLostNoRoute',
- 'MaxPacketsLostNoRoute',
- 'MinPacketsLostTTLExpired',
- 'MaxPacketsLostTTLExpired',
- 'TransitRouterSourceResourceId',
- 'TransitRouterSourceNetworkInterface',
- 'TransitRouterDestinationResourceId',
- 'TransitRouterDestinationNetworkInterface',
- 'TransitRouterId',
- 'PublicIpAddress',
- 'InstanceId',
- 'BindingResourceType',
- 'BindingResourceId',
- 'CbwpId',
- ],
- ],
- 'Value' => [
- 'description' => '过滤条件的值。',
- 'type' => 'array',
- 'items' => [
- 'description' => '根据过滤的key类型,传入对应的过滤值。'."\n"
- ."\n"
- .'根据 `TupleDimension` 字段和 `TrafficScenario` 字段,支持情况如下:'."\n"
- ."\n"
- .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet`(VPC 流日志场景)'."\n"
- ."\n"
- .' - 当 key 为 `FlowAction` 时,value 枚举为:'."\n"
- .' - `ACCEPT`(默认传 `Accept`):安全组和网络 ACL 允许的流量'."\n"
- .' - `REJECT`:安全组和网络 ACL 拒绝的流量'."\n"
- ."\n"
- .'- `TrafficScenario = TRFlowlog`(TR 流日志场景)'."\n"
- ."\n"
- .' - key 为 `TransitRouterAttachmentId` 时为必传项,对应的 value 同为必填(指定具体的 VPC 连接 / VPN 连接 / VBR 连接 / ECR 连接 / 跨地域连接或网络实例连接 ID)。'."\n"
- ."\n"
- .'- `TrafficScenario = CbwpMetric`(共享带宽指标分析场景)'."\n"
- ."\n"
- .' - key 为 `CbwpId` 时为必传项,对应的 value 同为必填(指定具体的共享带宽包 ID)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Accept',
- ],
- 'required' => false,
- ],
- 'Operator' => [
- 'description' => '针对指定的key类型,部分支持使用操作符,对传入的value进行字符串匹配,支持的枚举如下(默认值为 `in`):'."\n"
- ."\n"
- .'- `in`:等于'."\n"
- .'- `not in`:不等于'."\n"
- .'- `like`:包含'."\n"
- ."\n"
- .'根据 `TupleDimension` 字段和 `TrafficScenario` 字段,`like` 的支持情况如下:'."\n"
- ."\n"
- .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet`(VPC 流日志场景):'."\n"
- .' - 当 key 为以下字段时,支持 `like`:'."\n"
- .' - `CloudIp`'."\n"
- .' - `SourceIp`'."\n"
- .' - `DestinationIp`'."\n"
- ."\n"
- .'- `TrafficScenario = TRFlowlog`(TR 流日志场景):'."\n"
- .' - 当 key 为以下字段时,支持 `like`:'."\n"
- .' - `SourceIp`'."\n"
- .' - `DestinationIp`'."\n"
- ."\n"
- .'- `TrafficScenario = CbwpMetric`(共享带宽指标分析场景):'."\n"
- .' - 当 key 为以下字段时,支持 `like`:'."\n"
- .' - `PublicIpAddress`'."\n"
- ."\n"
- .'除以上字段外,其余字段仅支持 `in` 和 `not in` 操作符。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'not in' => 'not in',
- 'in' => 'in',
- 'like' => 'like',
- ],
- 'example' => 'in',
- ],
+ 'Key' => ['description' => '标签键。最多支持128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或`https://`。'."\n"
+ ."\n"
+ .'一次调用最多支持添加20个标签。', 'type' => 'string', 'required' => false, 'example' => 'Team'],
+ 'Value' => ['description' => '标签值。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。一旦输入该值,可以为空字符串。'."\n"
+ ."\n"
+ .'一次调用最多支持添加20个标签值。', 'type' => 'string', 'required' => false, 'example' => 'ops'],
],
'required' => false,
],
'required' => false,
+ 'maxItems' => 21,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NetworkReachableAnalysisId' => ['description' => '网络可达性分析任务ID。', 'type' => 'string', 'example' => 'nra-2fede05617494417****'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IncorrectStatus.NetworkPath', 'errorMessage' => 'The last analysis status of %s is %s. Please try again later.', 'description' => '%s有分析任务未完成,请等待其完成后再试!'],
+ ['errorCode' => 'QuotaExceeded.ParallelNraLimit', 'errorMessage' => 'The maximum number of parallel reachability analysis task is exceeded.', 'description' => '并行的路径分析任务数量已超过规格。'],
+ ['errorCode' => 'QuotaExceeded.MaxNraCount', 'errorMessage' => 'The maximum number of reachability analysis task is exceeded.', 'description' => '保存的路径分析任务数量已超过规格。'],
+ ['errorCode' => 'IllegalParam.ZoneId', 'errorMessage' => 'The specified available zone (%s) is invalid.', 'description' => '指定的可用区(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.StepMinutes', 'errorMessage' => 'The specified sampling interval (%s) is invalid.', 'description' => '指定的采样间隔(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.BeginTime', 'errorMessage' => 'The specified begin time (%s) is invalid.', 'description' => '指定的开始时间(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.EndTime', 'errorMessage' => 'The specified end time (%s) is invalid.', 'description' => '指定的结束时间(%s)不合法。'],
+ ['errorCode' => 'Mismatch.BeginTimeAndEndTime', 'errorMessage' => 'The specified begin time must be earlier than the end time.', 'description' => '指定的开始时间在结束时间之后。'],
+ ['errorCode' => 'MissingParameter.TagValue', 'errorMessage' => 'You must specify Tag.N.Value.', 'description' => '必须指定Tag的Value。'],
+ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => '超过了标签的最大数目。'],
+ ['errorCode' => 'MissingParameter.TagKey', 'errorMessage' => 'You must specify Tag.N.Key.', 'description' => '必须指定Tag的Key。'],
+ ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => 'Tag的包含重复的key。'],
+ ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => 'Tag的Key参数无效'],
+ ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => 'Tag的Value参数无效。'],
+ ],
+ 404 => [
+ ['errorCode' => 'ResourceNotFound.NetworkPath', 'errorMessage' => 'The specified resource of %s is not found.', 'description' => ''],
+ ],
+ ],
+ 'title' => '创建网络可达性分析任务',
+ 'description' => '- **CreateNetworkReachableAnalysis**接口是对**CreateNetworkPath**接口中返回的网络路径创建可达性分析任务,并记录分析结果。'."\n"
+ .' - **CreateNetworkReachableAnalysis**接口支持对同一网络路径进行多次分析。'."\n"
+ .' - 一个阿里云账号(主账号)最多支持创建1000条可达性分析记录。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNetworkReachableAnalysis'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:CreateNetworkReachableAnalysis',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkReachableAnalysis', 'arn' => 'acs:nis:*:{#accountId}:networkreachableanalysis/*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NetworkReachableAnalysisId\\": \\"nra-2fede05617494417****\\",\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteNetworkPath' => [
+ 'summary' => '删除网络分析路径。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'BeginTime',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '116931',
+ 'abilityTreeNodes' => ['FEATUREnetana59X9GB', 'FEATUREnetana98CV3P', 'FEATUREnetanaWZGUR4', 'FEATUREnetanaDZZVCZ', 'FEATUREnetana0CBIRP', 'FEATUREnetanaJGHZ2X', 'FEATUREnetanaRD137H', 'FEATUREnetanaCAWHBE', 'FEATUREnetana8JUW6E'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '要删除的网络分析路径的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ [
+ 'name' => 'NetworkPathIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '起始时间戳,单位毫秒。未指定时默认查最近1小时。',
- 'description' => '查询起始时间的毫秒时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '网络分析路径集合。',
+ 'type' => 'array',
+ 'items' => ['description' => '您可以通过调用[CreateNetworkPath](~~2366522~~)接口获取网络分析路径ID。', 'type' => 'string', 'required' => false, 'example' => 'np-10c31b7aca0e4486****'],
'required' => true,
- 'example' => '1638239092000',
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C4331873-C534-590F-A905-F66C53B88A47'],
+ 'Data' => ['type' => 'boolean', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalParam.DiskCategory', 'errorMessage' => 'The specified disk category (%s) is invalid.', 'description' => '指定的磁盘类型(%s)不合法。'],
+ ['errorCode' => 'SizeExceeds.Zones', 'errorMessage' => 'The length of the specified available zones exceeds the limit.', 'description' => '指定的可用区列表长度超过限制。'],
+ ['errorCode' => 'SizeExceeds.DiskCategories', 'errorMessage' => 'The length of the specified disk categories exceeds the limit.', 'description' => '指定的磁盘类型列表长度超过限制。'],
+ ['errorCode' => 'OperationDenied.ZonesConflict', 'errorMessage' => 'The specified available zones do not belong to the same region.', 'description' => '指定的可用区不属于同一个地域。'],
+ ['errorCode' => 'IllegalParam.ZoneId', 'errorMessage' => 'The specified available zone (%s) is invalid.', 'description' => '指定的可用区(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.StepMinutes', 'errorMessage' => 'The specified sampling interval (%s) is invalid.', 'description' => '指定的采样间隔(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.BeginTime', 'errorMessage' => 'The specified begin time (%s) is invalid.', 'description' => '指定的开始时间(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.EndTime', 'errorMessage' => 'The specified end time (%s) is invalid.', 'description' => '指定的结束时间(%s)不合法。'],
+ ['errorCode' => 'Mismatch.BeginTimeAndEndTime', 'errorMessage' => 'The specified begin time must be earlier than the end time.', 'description' => '指定的开始时间在结束时间之后。'],
+ ['errorCode' => 'IllegalParam.NetworkPathId', 'errorMessage' => 'The parameter (%s) cannot be empty.', 'description' => '该参数(%s)不能为空.'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden.NetworkPathId', 'errorMessage' => 'The user does not have permission on the instance parameter (%s).', 'description' => '该用户没有该实例资源(%s)权限.'],
+ ],
[
- 'name' => 'EndTime',
+ ['errorCode' => 'ResourceNotFound.NetworkPathId', 'errorMessage' => 'The instance resource (%s) does not exist.', 'description' => '该实例资源(%s)不存在。'],
+ ],
+ ],
+ 'title' => '删除网络分析路径',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNetworkPath'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'nis:DeleteNetworkPath',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkPath', 'arn' => 'acs:nis:*:{#accountId}:networkpath/{#NetworkPathId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4331873-C534-590F-A905-F66C53B88A47\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteNetworkReachableAnalysis' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '116935',
+ 'abilityTreeNodes' => ['FEATUREnetana59X9GB', 'FEATUREnetana98CV3P', 'FEATUREnetanaWZGUR4', 'FEATUREnetanaDZZVCZ', 'FEATUREnetana0CBIRP', 'FEATUREnetanaJGHZ2X', 'FEATUREnetanaRD137H', 'FEATUREnetanaCAWHBE', 'FEATUREnetana8JUW6E'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '网络可达性分析任务的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ [
+ 'name' => 'NetworkReachableAnalysisIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '结束时间戳,单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。',
- 'description' => '查询结束时间的毫秒时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '网络可达性分析任务ID集合。',
+ 'type' => 'array',
+ 'items' => ['description' => '网络可达性分析任务ID。您可以通过调用[CreateNetworkReachableAnalysis](~~2366521~~)接口获取网络可达性分析任务ID。', 'type' => 'string', 'required' => false, 'example' => '[\\"nra-be3cff6bed3049f5****\\"]'],
'required' => true,
- 'example' => '1684373700099',
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4838F3F2-30E1-5D82-B25A-B9FE33BC3E25'],
+ 'Data' => ['type' => 'boolean', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalParam.DiskCategory', 'errorMessage' => 'The specified disk category (%s) is invalid.', 'description' => '指定的磁盘类型(%s)不合法。'],
+ ['errorCode' => 'SizeExceeds.Zones', 'errorMessage' => 'The length of the specified available zones exceeds the limit.', 'description' => '指定的可用区列表长度超过限制。'],
+ ['errorCode' => 'SizeExceeds.DiskCategories', 'errorMessage' => 'The length of the specified disk categories exceeds the limit.', 'description' => '指定的磁盘类型列表长度超过限制。'],
+ ['errorCode' => 'OperationDenied.ZonesConflict', 'errorMessage' => 'The specified available zones do not belong to the same region.', 'description' => '指定的可用区不属于同一个地域。'],
+ ['errorCode' => 'IllegalParam.ZoneId', 'errorMessage' => 'The specified available zone (%s) is invalid.', 'description' => '指定的可用区(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.StepMinutes', 'errorMessage' => 'The specified sampling interval (%s) is invalid.', 'description' => '指定的采样间隔(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.BeginTime', 'errorMessage' => 'The specified begin time (%s) is invalid.', 'description' => '指定的开始时间(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.EndTime', 'errorMessage' => 'The specified end time (%s) is invalid.', 'description' => '指定的结束时间(%s)不合法。'],
+ ['errorCode' => 'Mismatch.BeginTimeAndEndTime', 'errorMessage' => 'The specified begin time must be earlier than the end time.', 'description' => '指定的开始时间在结束时间之后。'],
+ ['errorCode' => 'IllegalParam.NetworkReachableAnalysisId', 'errorMessage' => 'The parameter (%s) cannot be empty.', 'description' => '该参数(%s)不能为空。'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden.NetworkReachableAnalysisId', 'errorMessage' => 'The user does not have permission on the instance parameter (%s).', 'description' => '该用户没有该资源(%s)权限.'],
+ ],
[
- 'name' => 'Sort',
+ ['errorCode' => 'ResourceNotFound.NetworkReachableAnalysisId', 'errorMessage' => 'The instance resource (%s) does not exist.', 'description' => '该资源(%s)不存在。'],
+ ],
+ ],
+ 'title' => '删除网络可达性分析任务',
+ 'summary' => '调用DeleteNetworkReachableAnalysis接口,删除网络可达性分析任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNetworkReachableAnalysis'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'nis:DeleteNetworkReachableAnalysis',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkReachableAnalysis', 'arn' => 'acs:nis:*:{#accountId}:networkreachableanalysis/{#NetworkReachableAnalysisId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4838F3F2-30E1-5D82-B25A-B9FE33BC3E25\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteNisInspectionReport' => [
+ 'summary' => '删除巡检报告。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226212',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InspectionReportId',
'in' => 'query',
+ 'schema' => ['description' => '巡检报告ID', 'type' => 'string', 'required' => true, 'example' => 'nir-ffd1af****196d0'."\n", 'maxLength' => 128, 'minLength' => 1],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '排序方式,'."\n"
- .'asc:按正序排序。'."\n"
- .'desc:按逆序排序。',
- 'description' => '指定流量分析的排序方式'."\n"
- .'- ASC:按正序排序。'."\n"
- .'- DESC:按逆序排序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Desc',
- 'default' => 'Desc',
- 'enum' => [
- 'Desc',
- 'Asc',
+ 'title' => 'RpcResponse<Boolean>',
+ 'description' => 'RpcResponse<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B'],
+ 'Data' => ['description' => '删除结果', 'type' => 'boolean', 'example' => 'True'],
],
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'Forbidden.InspectionReportId', 'errorMessage' => 'This user does not have permission to this report parameter (%s).', 'description' => '该用户无该报告参数(%s)权限。'],
+ ],
[
- 'name' => 'TopN',
+ ['errorCode' => 'ResourceNotFound.InspectionReportId', 'errorMessage' => 'The specified InspectionReportId(%s) is not found.', 'description' => '指定的InspectionReportId(%s)不存在。'],
+ ],
+ ],
+ 'title' => '删除巡检报告',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'nis:DeleteNisInspectionReport',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteNisInspectionTask' => [
+ 'summary' => '删除巡检任务。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '226555',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InspectionTaskId',
'in' => 'query',
+ 'schema' => ['description' => '巡检任务ID。', 'type' => 'string', 'required' => true, 'example' => 'ni-209d****wfirfwc2yl'."\n", 'maxLength' => 128, 'minLength' => 1],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '展示排序靠前的数据。默认值:10。表示默认展示排序前 10 的数据。最大值:100。',
- 'description' => '指定流量排序查询的条目数。'."\n"
- ."\n"
- .'支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ 'title' => 'RpcResponse<Boolean>',
+ 'description' => 'RpcResponse<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
+ 'Data' => ['description' => '删除结果。', 'type' => 'boolean', 'example' => 'True'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IncorrectStatus.InspectionTaskNotInactive', 'errorMessage' => 'The specified task InspectionTaskId(%s) is not closed and cannot be deleted.', 'description' => '指定的任务InspectionTaskId(%s)不是关闭状态,不支持删除。'],
+ ],
+ 404 => [
+ ['errorCode' => 'ResourceNotFound.InspectionTaskId', 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.', 'description' => '指定的InspectionTaskId(%s)不存在。'],
+ ],
+ ],
+ 'title' => '删除巡检任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'nis:DeleteNisInspectionTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'DescribeNisInspectionRecommendationResources' => [
+ 'summary' => '查询巡检报告异常项实例列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226209',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InspectionReportId',
+ 'in' => 'query',
+ 'schema' => ['description' => '巡检报告ID', 'type' => 'string', 'required' => true, 'example' => 'nir-ffd1af****196d0'."\n", 'maxLength' => 128, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'RecommendationCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '异常建议码', 'type' => 'string', 'required' => true, 'example' => 'nat_snat_cross_az_warn', 'maxLength' => 64, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的最大条目数。最大值为100。默认值为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
+ ],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
- 'description' => '语言,枚举:zh-CN,en-US',
+ 'description' => '使用的语言。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
- 'enum' => [
- 'zh-CN',
- 'en-US',
+ 'enum' => ['zh-CN', 'en-US'],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'RpcResponse<NextTokenResult<DescribeNisInspectionRecommendationResourcesResponse>>',
+ 'description' => 'RpcResponse<NextTokenResult<DescribeNisInspectionRecommendationResourcesResponse>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
+ 'ResourceList' => [
+ 'description' => '资源列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceId' => ['description' => '异常实例ID', 'type' => 'string', 'example' => 'ngw-p0wn04hi4****q2us6q7q'],
+ 'ResourceName' => ['description' => '实例名称', 'type' => 'string', 'example' => 'Public NAT gateway'],
+ 'AnalysisData' => ['description' => '异常信息详情', 'type' => 'string', 'example' => "\n"
+ .'{ResourceId: "ngw-p0wn04hi4****q2us6q7q"}'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'qt0DqY2lXxwBt9/ROQoS/7J9p90D1vF2vFbwzb/1oSWr3AxcM6/KpObZ7Z1PZdcV'],
+ 'TotalCount' => ['description' => '资源信息总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '192'],
+ 'MaxResults' => ['description' => '分页查询时每页的最大条目数。最大值为100。默认值为20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'InspectionReportId' => ['description' => '资源报告ID', 'type' => 'string', 'example' => 'nir-ffd1af****196d0'."\n"],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalParam.NextToken', 'errorMessage' => 'The specified nextToken(%s) is invalid.', 'description' => '指定的NextToken(%s)参数不合法。'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden.InspectionReportId', 'errorMessage' => 'This user does not have permission to this report parameter (%s).', 'description' => '该用户无该报告参数(%s)权限。'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound.InspectionReportId', 'errorMessage' => 'The specified InspectionReportId(%s) is not found.', 'description' => '指定的InspectionReportId(%s)不存在。'],
+ ['errorCode' => 'ResourceNotFound.RecommendationCode', 'errorMessage' => 'The specified parameter RecommendationCode(%s) does not exist.', 'description' => '指定的参数RecommendationCode(%s) 不存在。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"ResourceList\\": [\\n {\\n \\"ResourceId\\": \\"ngw-p0wn04hi4****q2us6q7q\\",\\n \\"ResourceName\\": \\"Public NAT gateway\\",\\n \\"AnalysisData\\": \\"\\\\n{ResourceId: \\\\\\"ngw-p0wn04hi4****q2us6q7q\\\\\\"}\\"\\n }\\n ],\\n \\"NextToken\\": \\"qt0DqY2lXxwBt9/ROQoS/7J9p90D1vF2vFbwzb/1oSWr3AxcM6/KpObZ7Z1PZdcV\\",\\n \\"TotalCount\\": 192,\\n \\"MaxResults\\": 20,\\n \\"InspectionReportId\\": \\"nir-ffd1af****196d0\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '查询巡检报告异常项实例列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionRecommendationResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
+ ],
+ ],
+ 'DescribeNisInspectionReportCheckItems' => [
+ 'summary' => '查询巡检报告检查项详情。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'NextToken',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226206',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InspectionReportId',
+ 'in' => 'query',
+ 'schema' => ['description' => '巡检报告ID', 'type' => 'string', 'required' => true, 'example' => 'nir-ffd1af****196d0', 'maxLength' => 128, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '资源类型',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '关联资源的类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['NAT' => 'NAT', 'VPN' => 'VPN', 'NLB' => 'NLB', 'VBR' => 'VBR', 'ALB' => 'ALB', 'CLB' => 'CLB', 'EIP' => 'EIP', 'TR' => 'TR'],
+ 'example' => 'NAT',
+ 'maxLength' => 32,
+ 'minLength' => 1,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'CategoryCode',
'in' => 'query',
'schema' => [
- 'description' => '是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。',
+ 'description' => '巡检项类别。',
'type' => 'string',
'required' => false,
- 'example' => '2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+',
+ 'example' => 'stability',
+ 'enum' => ['cost_optimizing', 'performance', 'security', 'stability', 'operational_excellence'],
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'RiskLevel',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '分页大小,取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '风险等级集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '风险等级,不填为全部风险等级。取值:'."\n"
+ .'- **HighRisk**:高风险'."\n"
+ .'- **MediumRisk**:中风险'."\n"
+ .'- **LowRisk**:低风险'."\n"
+ .'- **NoRisk**:无风险',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'HighRisk',
+ 'enum' => ['HighRisk', 'MediumRisk', 'LowRisk', 'NoRisk'],
+ ],
'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
+ 'maxItems' => 20,
],
],
[
- 'name' => 'StorageInterval',
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的最大条目数。最大值为100。默认值为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
+ ],
+ [
+ 'name' => 'Language',
'in' => 'query',
'schema' => [
- 'description' => '存储桶精度属性。'."\n"
- ."\n"
- .'存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。'."\n"
- ."\n"
- .'- 流量分析器对应元组支持的存储精度为:'."\n"
- .' - `1`:单位分钟(1 分钟)'."\n"
- .' - `10`:单位分钟(10 分钟)'."\n"
- .' - `60`:单位分钟(60 分钟,即 1 小时)'."\n"
- .' - `1440`:单位分钟(1440 分钟,即 1 天)'."\n"
- ."\n"
- .'- 存储桶精度可用于两类典型用途:'."\n"
- .' - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合'."\n"
- .' - 长周期流量统计:如 1440 分钟(1 天)聚合'."\n"
- ."\n"
- .'- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:'."\n"
- .' - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据'."\n"
- .' - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '语言,枚举:zh-CN,en-US',
+ 'description' => '语言,枚举:zh-CN,en-US',
+ 'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 1 => '1',
- 10 => '10',
- 60 => '60',
- 1440 => '1440',
+ 'example' => 'zh-CN',
+ 'enum' => ['zh-CN', 'en-US'],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'RpcResponse<NextTokenResult<DescribeNisInspectionReportCheckItemsResponse>>',
+ 'description' => 'RpcResponse<NextTokenResult<DescribeNisInspectionReportCheckItemsResponse>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B'],
+ 'CheckItemList' => [
+ 'description' => '巡检检查项列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => ['description' => '巡检检查项关联的资源类型。', 'type' => 'string', 'example' => 'NAT'],
+ 'CategoryCode' => ['description' => '巡检项类别。', 'type' => 'string', 'example' => 'stability'],
+ 'CheckItemCode' => ['description' => '巡检检查项码', 'type' => 'string', 'example' => 'item_nat_water_level_check'],
+ 'Description' => ['description' => '巡检检查项描述。', 'type' => 'string', 'example' => '无'],
+ 'CheckResultList' => [
+ 'description' => '巡检风险等级数量结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RiskLevel' => ['description' => '风险等级。取值:'."\n"
+ .'- **HighRisk**:高风险'."\n"
+ .'- **MediumRisk**:中风险'."\n"
+ .'- **LowRisk**:低风险'."\n"
+ .'- **NoRisk**:无风险', 'type' => 'string', 'example' => 'LowRisk'],
+ 'Count' => ['description' => '巡检报告中对应等级的风险数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'RecommendationList' => [
+ 'description' => '巡检异常项结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RiskLevel' => ['description' => '风险等级。'."\n"
+ .'取值:'."\n"
+ .'- **HighRisk**:高风险'."\n"
+ .'- **MediumRisk**:中风险'."\n"
+ .'- **LowRisk**:低风险'."\n"
+ .'- **NoRisk**:无风险', 'type' => 'string', 'example' => 'LowRisk'],
+ 'RecommendationCode' => ['description' => '巡检异常项。', 'type' => 'string', 'example' => 'nat_snat_cross_az_warn'],
+ 'Abnormality' => ['description' => '异常项描述。', 'type' => 'string', 'example' => 'Multiple cross-zone resources share a single NAT gateway.'],
+ 'Reason' => ['description' => '异常原因。', 'type' => 'string', 'example' => 'Multiple cross-zone resources share a single NAT gateway.'],
+ 'Suggestion' => ['description' => '优化建议。', 'type' => 'string', 'example' => 'Deploy NAT gateways in all zones where resources reside.'],
+ 'Metadata' => ['description' => '异常项对应资源的元数据。', 'type' => 'string', 'example' => '{"Columns":[{"ColumnType":"id","ColumnTitle":"Resource ID","ColumnValue":"ResourceId"},{"ColumnType":"az","ColumnTitle":"NAT Deployment Zone","ColumnValue":"NatAZ"},{"ColumnType":"array.az","ColumnTitle":"Resource Deployment Zone","ColumnValue":"ForwardsAZs"},{"ColumnType":"region","ColumnTitle":"Region","ColumnValue":"RegionNo"}]}'],
+ 'ReasonCode' => ['type' => 'string', 'description' => ''],
+ 'SuggestionCode' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'CheckItemName' => ['description' => '检查项的名称。', 'type' => 'string', 'example' => 'NAT high-availability deployment check'],
+ 'DescriptionCode' => ['title' => '巡检项描述Code', 'type' => 'string', 'example' => 'item_ep_high_availability_check_description'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'NextToken' => ['description' => '是否拥有下一次查询的令牌(Token)。取值:如果NextToken为空表示没有下一次查询。 如果NextToken有返回值,该取值表示下一次查询开始的令牌。', 'type' => 'string', 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj'],
+ 'TotalCount' => ['description' => '返回的条目总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
+ 'MaxResults' => ['description' => '分页大小,取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'InspectionReportId' => ['description' => '巡检报告ID', 'type' => 'string', 'example' => 'nir-ffd1af****196d0'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IncorrectStatus.InspectionReportNotFinish', 'errorMessage' => 'The specified task report InspectionReportId(%s) has not been completed.', 'description' => '指定的任务报告InspectionReportId(%s)还没有完成。'],
+ ['errorCode' => 'IllegalParam.ResourceType', 'errorMessage' => 'The specified resourceType (%s) is invalid.', 'description' => '指定的ResourceType变量值(%s)不存在。'],
+ ['errorCode' => 'IllegalParam.RiskLevel', 'errorMessage' => 'The specified argument RiskLevel(%s) is illegal.', 'description' => '指定的参数RiskLevel(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.NextToken', 'errorMessage' => 'The specified nextToken(%s) is invalid.', 'description' => '指定的NextToken(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.UnsupportedResourceType', 'errorMessage' => 'The specified parameter ResourceType(%s) is invalid, with a resource type that is not currently supported.', 'description' => '指定的参数ResourceType(%s)不合法,有当前不支持的资源类型。'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden.InspectionReportId', 'errorMessage' => 'This user does not have permission to this report parameter (%s).', 'description' => '该用户无该报告参数(%s)权限。'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound.InspectionReportId', 'errorMessage' => 'The specified InspectionReportId(%s) is not found.', 'description' => '指定的InspectionReportId(%s)不存在。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"CheckItemList\\": [\\n {\\n \\"ResourceType\\": \\"NAT\\",\\n \\"CategoryCode\\": \\"stability\\",\\n \\"CheckItemCode\\": \\"item_nat_water_level_check\\",\\n \\"Description\\": \\"无\\",\\n \\"CheckResultList\\": [\\n {\\n \\"RiskLevel\\": \\"LowRisk\\",\\n \\"Count\\": 0\\n }\\n ],\\n \\"RecommendationList\\": [\\n {\\n \\"RiskLevel\\": \\"LowRisk\\",\\n \\"RecommendationCode\\": \\"nat_snat_cross_az_warn\\",\\n \\"Abnormality\\": \\"Multiple cross-zone resources share a single NAT gateway.\\",\\n \\"Reason\\": \\"Multiple cross-zone resources share a single NAT gateway.\\",\\n \\"Suggestion\\": \\"Deploy NAT gateways in all zones where resources reside.\\",\\n \\"Metadata\\": \\"{\\\\\\"Columns\\\\\\":[{\\\\\\"ColumnType\\\\\\":\\\\\\"id\\\\\\",\\\\\\"ColumnTitle\\\\\\":\\\\\\"Resource ID\\\\\\",\\\\\\"ColumnValue\\\\\\":\\\\\\"ResourceId\\\\\\"},{\\\\\\"ColumnType\\\\\\":\\\\\\"az\\\\\\",\\\\\\"ColumnTitle\\\\\\":\\\\\\"NAT Deployment Zone\\\\\\",\\\\\\"ColumnValue\\\\\\":\\\\\\"NatAZ\\\\\\"},{\\\\\\"ColumnType\\\\\\":\\\\\\"array.az\\\\\\",\\\\\\"ColumnTitle\\\\\\":\\\\\\"Resource Deployment Zone\\\\\\",\\\\\\"ColumnValue\\\\\\":\\\\\\"ForwardsAZs\\\\\\"},{\\\\\\"ColumnType\\\\\\":\\\\\\"region\\\\\\",\\\\\\"ColumnTitle\\\\\\":\\\\\\"Region\\\\\\",\\\\\\"ColumnValue\\\\\\":\\\\\\"RegionNo\\\\\\"}]}\\",\\n \\"ReasonCode\\": \\"\\",\\n \\"SuggestionCode\\": \\"\\"\\n }\\n ],\\n \\"CheckItemName\\": \\"NAT high-availability deployment check\\",\\n \\"DescriptionCode\\": \\"item_ep_high_availability_check_description\\"\\n }\\n ],\\n \\"NextToken\\": \\"hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj\\",\\n \\"TotalCount\\": 11,\\n \\"MaxResults\\": 20,\\n \\"InspectionReportId\\": \\"nir-ffd1af****196d0\\"\\n}","type":"json"}]',
+ 'title' => '查询巡检报告检查项详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionReportCheckItems',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'example' => '10',
],
],
],
+ ],
+ 'DescribeNisInspectionReportStatus' => [
+ 'summary' => '查询巡检报告状态。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226204',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InspectionReportId',
+ 'in' => 'query',
+ 'schema' => ['description' => '巡检报告ID。', 'type' => 'string', 'required' => true, 'example' => 'nir-2ca527b8de114ba4afb9', 'maxLength' => 128, 'minLength' => 1],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'RpcResponse<ArrayList<NtaNetworkRankingResponse>>',
- 'description' => 'RpcResponse<ArrayList<NtaNetworkRankingResponse>>',
+ 'title' => 'RpcResponse<DescribeNisInspectionReportStatusResponse>',
+ 'description' => 'RpcResponse<DescribeNisInspectionReportStatusResponse>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
+ 'InspectionReportId' => ['description' => '巡检报告ID。', 'type' => 'string', 'example' => 'nir-2ca527b8de114ba4afb9'],
+ 'InspectionTaskId' => ['description' => '巡检任务ID。', 'type' => 'string', 'example' => 'ni-8svmpe0yso****r7fh79'],
+ 'Status' => [
+ 'description' => '巡检报告状态。',
'type' => 'string',
- 'example' => '4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941',
+ 'enumValueTitles' => ['Failed' => '失败', 'Finish' => '结束', 'On-going' => '执行中'],
+ 'example' => 'Finish',
],
- 'NisTrafficRankingId' => [
- 'description' => '返回本次流量排序分析的结果ID,需调用DescribeNisTrafficRanking接口获取最终分析结果。',
+ 'StartTime' => ['description' => '开始时间。', 'type' => 'string', 'example' => '2024-07-18 15:12:28'],
+ 'EndTime' => ['description' => '停止时间。', 'type' => 'string', 'example' => '2024-07-18 15:13:07'],
+ 'InspectionProject' => [
+ 'description' => '巡检任务采用的巡检方案类别。',
'type' => 'string',
- 'example' => 'task-6462a7b4c4a54b****',
+ 'enumValueTitles' => ['customized' => '自定义场景', 'basic' => '基础场景'],
+ 'example' => 'basic',
],
+ 'InspectionTaskName' => ['description' => '巡检任务名称。', 'type' => 'string', 'example' => 'Default'],
],
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Forbidden.NoPermission',
- 'errorMessage' => 'The authentication result is successful but the verification fails.',
- ],
- [
- 'errorCode' => 'IllegalParam.RegionNo',
- 'errorMessage' => 'The specified parameter RegionNo(%s) is illegal.',
- ],
- [
- 'errorCode' => 'DuplicatedParam.GroupBy',
- 'errorMessage' => 'Duplicate data exists for the specified GroupBy(%s) parameter.',
- ],
- [
- 'errorCode' => 'IllegalParam.GroupBy',
- 'errorMessage' => 'The specified param of GroupBy (%s) is invalid.',
- ],
- [
- 'errorCode' => 'DuplicatedParam.Filter',
- 'errorMessage' => 'The specified Filter(%s) parameter has a duplicate Key.',
- ],
- [
- 'errorCode' => 'IllegalParam.UserOwesFees',
- 'errorMessage' => 'User (%s) is overdue.',
- ],
- [
- 'errorCode' => 'IllegalParam.UserNotActivated',
- 'errorMessage' => 'User (%s) did not provision service.',
- ],
- [
- 'errorCode' => 'IncorrectStatus.TrafficAnalyzerId',
- 'errorMessage' => 'TrafficAnalyzerId (%s) is not in a valid status.',
- ],
- [
- 'errorCode' => 'IllegalParam.CloudIp',
- 'errorMessage' => 'The specified CloudIp(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceIp',
- 'errorMessage' => 'Please enter a valid source IP.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourcePort',
- 'errorMessage' => 'The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536].',
- ],
- [
- 'errorCode' => 'IllegalParam.DestinationPort',
- 'errorMessage' => 'The specified DestinationPort(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.Protocol',
- 'errorMessage' => 'The specified Protocol(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinBytes',
- 'errorMessage' => 'The format of the specified parameter MinBytes(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxBytes',
- 'errorMessage' => 'The format of the specified parameter MaxBytes(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinRoundTripTime',
- 'errorMessage' => 'The format of the specified parameter MinRoundTripTime(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxRoundTripTime',
- 'errorMessage' => 'The format of the specified parameter MaxRoundTripTime(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinPackages',
- 'errorMessage' => 'The format of the specified parameter MinPackages(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxPackages',
- 'errorMessage' => 'The format of the specified parameter MaxPackages(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParam.TupleDimension',
- 'errorMessage' => 'The specified TupleDimension(%s) argument is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.OrderBy',
- 'errorMessage' => 'The specified param of orderBy (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime',
- 'errorMessage' => 'The param of BeginTimeAndEndTime is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.DestinationIp',
- 'errorMessage' => 'The specified ip(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxPacketsLostTTLExpired',
- 'errorMessage' => 'The format of the specified parameter MaxPacketsLostTTLExpired(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinPacketsLostTTLExpired',
- 'errorMessage' => 'The format of the specified parameter MinPacketsLostTTLExpired(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxPacketsLostNoRoute',
- 'errorMessage' => 'The format of the specified parameter MaxPacketsLostNoRoute(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinPacketsLostNoRoute',
- 'errorMessage' => 'The format of the specified parameter MinPacketsLostNoRoute(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxPacketsLostBlackhole',
- 'errorMessage' => 'The format of the specified parameter MaxPacketsLostBlackhole(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinPacketsLostBlackhole',
- 'errorMessage' => 'The format of the specified parameter MinPacketsLostBlackhole(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParam.Filter',
- 'errorMessage' => 'The specified Filter parameter (%s) is illegal.',
- ],
- [
- 'errorCode' => 'MissingParam.TransitRouterAttachmentId',
- 'errorMessage' => 'TransitRouterAttachmentId required in the specified Filter and GroupBy parameters.',
- ],
- [
- 'errorCode' => 'QuotaExceeded.CheckRowReadLimit',
- 'errorMessage' => 'The query time range exceeds the read data rows quota %s. Shorten the query interval.',
+ 403 => [
+ ['errorCode' => 'Forbidden.InspectionReportId', 'errorMessage' => 'This user does not have permission to this report parameter (%s).', 'description' => '该用户无该报告参数(%s)权限。'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound.InspectionReportId', 'errorMessage' => 'The specified InspectionReportId(%s) is not found.', 'description' => '指定的InspectionReportId(%s)不存在。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"InspectionReportId\\": \\"nir-2ca527b8de114ba4afb9\\",\\n \\"InspectionTaskId\\": \\"ni-8svmpe0yso****r7fh79\\",\\n \\"Status\\": \\"Finish\\",\\n \\"StartTime\\": \\"2024-07-18 15:12:28\\",\\n \\"EndTime\\": \\"2024-07-18 15:13:07\\",\\n \\"InspectionProject\\": \\"basic\\",\\n \\"InspectionTaskName\\": \\"Default\\"\\n}","type":"json"}]',
+ 'title' => '查询巡检报告状态',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionReportStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
- [
- 'errorCode' => 'MissingParam.TransitRouterId',
- 'errorMessage' => 'When querying cross-region network connections, you need to specify the forwarding router ID.',
+ ],
+ ],
+ ],
+ 'DescribeNisInspectionReportSummary' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226211',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InspectionReportId',
+ 'in' => 'query',
+ 'schema' => ['description' => '巡检报告ID。', 'type' => 'string', 'required' => true, 'example' => 'nir-38abb318b27b49cc9a01', 'maxLength' => 128, 'minLength' => 1],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'RpcResponse<DescribeNisInspectionReportSummaryResponse>',
+ 'description' => 'RpcResponse<DescribeNisInspectionReportSummaryResponse>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4838F3F2-30E1-5D82-B25A-B9FE33BC3E25'],
+ 'InspectionReportId' => ['description' => '巡检报告ID。', 'type' => 'string', 'example' => 'nir-38abb318b27b49cc9a01'],
+ 'InspectionTaskId' => ['description' => '巡检任务ID', 'type' => 'string', 'example' => 'ni-8svmpe0yso2bhzr7fh79'],
+ 'Status' => [
+ 'description' => '任务运行状态:'."\n"
+ ."\n"
+ .'Creating: 创建中'."\n"
+ ."\n"
+ .'Active: 已开启'."\n"
+ ."\n"
+ .'Running: 执行中'."\n"
+ ."\n"
+ .'Inactive:已关闭',
+ 'type' => 'string',
+ 'enumValueTitles' => ['Creating' => '创建中', 'Active' => '已开启', 'Running' => '执行中', 'Inactive' => '已关闭'],
+ 'example' => 'Active',
+ ],
+ 'StartTime' => ['description' => '开始时间。', 'type' => 'string', 'example' => '2024-06-03 09:35:00'],
+ 'EndTime' => ['description' => '停止时间。', 'type' => 'string', 'example' => '2024-06-03 09:36:00'."\n"],
+ 'Summary' => [
+ 'description' => '摘要信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheckItemCount' => ['description' => '巡检项数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
+ 'CheckResourceCount' => ['description' => '巡检资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '123'],
+ 'PassRateSummary' => [
+ 'description' => '通过率摘要。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PassRateScope' => [
+ 'description' => '通过率范畴。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['Stability' => '稳定性', 'Total' => '总体'],
+ 'example' => 'Stability',
+ ],
+ 'PassRate' => ['description' => '通过率。', 'type' => 'number', 'format' => 'double', 'example' => '0.98'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'RiskSummary' => [
+ 'description' => '风险摘要。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RiskType' => [
+ 'description' => '风险类型。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['StabilityRisk' => '稳定性风险', 'TotalRisk' => '总体风险'],
+ 'example' => 'StabilityRisk',
+ ],
+ 'RiskLevel' => [
+ 'description' => '风险等级。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['LowRisk' => '低风险', 'HighRisk' => '高风险', 'MediumRisk' => '中风险', 'NoRisk' => '无风险'],
+ 'example' => 'HighRisk',
+ ],
+ 'RiskCount' => ['description' => '风险数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'ResourceCount' => ['description' => '风险关联的资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
],
- [
- 'errorCode' => 'MissingParam.CbwpId',
- 'errorMessage' => 'The CbwpId filtered during the query cannot be empty.',
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'Forbidden.InspectionReportId', 'errorMessage' => 'This user does not have permission to this report parameter (%s).', 'description' => '该用户无该报告参数(%s)权限。'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound.InspectionReportId', 'errorMessage' => 'The specified InspectionReportId(%s) is not found.', 'description' => '指定的InspectionReportId(%s)不存在。'],
+ ],
+ ],
+ 'title' => '查询巡检报告总结',
+ 'summary' => '查询巡检报告总结。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionReportSummary',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
- [
- 'errorCode' => 'ResourceNotFound.TrafficAnalyzerIdOneTupleDimension',
- 'errorMessage' => 'The specified traffic analyzer does not have a corresponding one-element group storage configuration.',
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4838F3F2-30E1-5D82-B25A-B9FE33BC3E25\\",\\n \\"InspectionReportId\\": \\"nir-38abb318b27b49cc9a01\\",\\n \\"InspectionTaskId\\": \\"ni-8svmpe0yso2bhzr7fh79\\",\\n \\"Status\\": \\"Active\\",\\n \\"StartTime\\": \\"2024-06-03 09:35:00\\",\\n \\"EndTime\\": \\"2024-06-03 09:36:00\\\\n\\",\\n \\"Summary\\": {\\n \\"CheckItemCount\\": 11,\\n \\"CheckResourceCount\\": 123,\\n \\"PassRateSummary\\": [\\n {\\n \\"PassRateScope\\": \\"Stability\\",\\n \\"PassRate\\": 0.98\\n }\\n ],\\n \\"RiskSummary\\": [\\n {\\n \\"RiskType\\": \\"StabilityRisk\\",\\n \\"RiskLevel\\": \\"HighRisk\\",\\n \\"RiskCount\\": 3,\\n \\"ResourceCount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeNisInspectionTask' => [
+ 'summary' => '查询巡检任务详情。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '227206',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InspectionTaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '巡检任务ID', 'type' => 'string', 'required' => true, 'example' => 'ni-8svmpe0yso2bhzr7fh79', 'maxLength' => 128, 'minLength' => 1],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'RpcResponse<DescribeNisInspectionTaskResponse>',
+ 'description' => 'RpcResponse<DescribeNisInspectionTaskResponse>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
+ 'InspectionTaskId' => ['description' => '巡检任务ID', 'type' => 'string', 'example' => 'ni-8svmpe0yso2bhzr7fh79'],
+ 'InspectionName' => ['description' => '巡检任务名称', 'type' => 'string', 'example' => 'Default'],
+ 'Status' => ['description' => '任务运行状态:'."\n"
+ ."\n"
+ .'Creating: 创建中'."\n"
+ ."\n"
+ .'Active: 已开启'."\n"
+ ."\n"
+ .'Running: 执行中'."\n"
+ ."\n"
+ .'Inactive:已关闭', 'type' => 'string', 'example' => 'Active'],
+ 'InspectionProject' => ['description' => '巡检任务采用的巡检方案类别:基础(basic)/自定义场景(customized)', 'type' => 'string', 'example' => 'basic'],
+ 'InspectionTriggerTime' => ['description' => '巡检任务触发时间。', 'type' => 'string', 'example' => '2024-07-01 15:15:57'],
+ 'InspectionInterval' => ['description' => '巡检执行周期。单位**天**。', 'type' => 'string', 'example' => '1'],
+ 'LastUpdateReportId' => ['description' => '最新报告ID。', 'type' => 'string', 'example' => 'nir-7c3dd178738a429abe6d'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-07-01 10:00:57'."\n"],
+ 'LastUpdateTime' => ['description' => '最新一次更新时间。', 'type' => 'string', 'example' => '2024-07-01 10:00:59'],
+ 'CheckResourceList' => [
+ 'description' => '巡检资源配置。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'EIP'],
+ 'CheckScope' => [
+ 'description' => '巡检规则。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['Whitelist' => '白名单', 'BlackList' => '黑名单', 'CheckAll' => '资源类型下实例全托管'],
+ 'example' => 'CheckAll',
+ ],
+ ],
+ 'description' => '',
+ ],
+ 'enumValueTitles' => [],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
404 => [
- [
- 'errorCode' => 'ResourceNotFound.TrafficAnalyzerId',
- 'errorMessage' => 'The specified resource TrafficAnalyzerId(%s) does not exist.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.NtaNotStorageBucket',
- 'errorMessage' => 'The data source bound to the traffic analyzer does not have a corresponding storage configuration.',
- ],
+ ['errorCode' => 'ResourceNotFound.InspectionTaskId', 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.', 'description' => '指定的InspectionTaskId(%s)不存在。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '查询巡检任务详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941\\",\\n \\"NisTrafficRankingId\\": \\"task-6462a7b4c4a54b****\\"\\n}","type":"json"}]',
- 'title' => '启动NIS流量排序分析',
- 'description' => '[请确保在使用该接口前,已充分了解NIS-流量分析器的收费方式和价格。](https://help.aliyun.com/zh/nis/product-overview/billing-method-new-version?spm=5176.25472526.console-base_help.dexternal.5b094887xwrWNE)'."\n"
- ."\n"
- .'支持分析场景: '."\n"
- ."\n"
- .'- 全部VPC流日志分析'."\n"
- .'- 公网VPC流日志分析'."\n"
- .'- 全部TR流日志分析'."\n"
- .'- 共享带宽指标分析'."\n"
- ."\n"
- .'## 全部 VPC 流日志分析'."\n"
- ."\n"
- .'### 请求参数'."\n"
- ."\n"
- .'| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |'."\n"
- .'|-------------------|----------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n"
- .'| RegionNo | string | 是 | 资源所在地域。 | cn-shanghai | - |'."\n"
- .'| TrafficAnalyzerId | string | 是 | 流量分析器 ID。 | nta-262****ca07f | - |'."\n"
- .'| TrafficScenario | string | 是 | 支持分析场景:<br>● 全部 VPC 流日志分析 | 固定为:VpcFlowLogAll | VpcFlowLogAll |'."\n"
- .'| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 ENI 的流量。<br>● Out:流出 ENI 的流量。 | In | - In <br>- Out |'."\n"
- .'| TupleDimension | string | 是 | 流量存储聚合维度。 | Tuple1 | - Tuple1 <br>- Tuple2 <br>- Tuple5 |'."\n"
- .'| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | | - |'."\n"
- .'| | string | 否 | 根据 TupleDimension 字段,可以指定流量的聚合维度如下:<br>● TupleDimension = Tuple1 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ CloudIp:云端 IP<br><br>● TupleDimension = Tuple2 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ SourceIp:源端 IP<br> ■ DestinationIp:目的端 IP<br> ■ TrafficPath:流量路径<br><br>● TupleDimension = Tuple5 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ SourceIp:源端 IP<br> ■ DestinationIp:目的端 IP<br> ■ TrafficPath:流量路径<br> ■ SourcePort:源端端口<br> ■ DestinationPort:目的端口<br> ■ Protocol:网络协议 | ["VpcId"] | - VpcId<br>- VSwitchId<br>- CloudIp<br>- SourceIp<br>- DestinationIp<br>- Protocol<br>- SourcePort<br>- DestinationPort<br>- TrafficPath<br>- Country<br>- Province<br>- City<br>- Isp<br>- Asn |'."\n"
- .'| OrderBy | string | 是 | 根据 TrafficScenario 字段,支持按以下指标对流量进行排名:<br><br>TrafficScenario = VpcFlowLogAll / VpcFlowLogInternet(VPC 流日志场景):<br>●Bytes:带宽<br>● Packets:包数<br>● RoundTripTime:TCP RTT | Bytes | - Bytes<br>- Packets<br>- RoundTripTime |'."\n"
- .'| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | | - |'."\n"
- .'| | object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | | - |'."\n"
- .'| key | string | 否 | 支持过滤的条件标签键,如下所示:<br><br>- `TupleDimension` 为一元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(**必填**, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `CloudIp`:云端 IP(对应 value 值可多选)<br><br>- `TupleDimension` 为二元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(**必填**, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `SourceIp`:源端 IP(对应 value 值可多选)<br> - `DestinationIp`:目的端 IP(对应 value 值可多选)<br> - `TrafficPath`:流量路径(对应 value 值可多选)<br><br>- `TupleDimension` 为五元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(**必填**, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `SourceIp`:源端 IP<br> - `DestinationIp`:目的端 IP<br> - `TrafficPath`:流量路径(对应 value 值可多选)<br> - `SourcePort`:源端口(对应 value 值可多选)<br> - `DestinationPort`:目的端口(对应 value 值可多选)<br> - `Protocol`:网络协议(对应 value 值可多选)<br><br>- VPC 场景下,均可按流量指标过滤:<br> - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)<br> - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)<br> - `MinRoundTripTime`:指定参与排序的最小 RTT,单位 ms(对应 value 值不可多选)<br> - `MaxRoundTripTime`:指定参与排序的最大 RTT,单位 ms(对应 value 值不可多选)<br> - `MinPackages`:指定参与排序的最小包数,单位个(对应 value 值不可多选)<br> - `MaxPackages`:指定参与排序的最大包数,单位个(对应 value 值不可多选) | FlowAction | - FlowAction<br>- VpcId<br>- VSwitchId<br>- NetworkInterfaceId<br>- CloudIp<br>- DestinationIp<br>- SourceIp<br>- EcsId<br>- TrafficPath<br>- SourcePort<br>- DestinationPort<br>- Protocol<br>- MinBytes<br>- MaxBytes<br>- MinRoundTripTime<br>- MaxRoundTripTime<br>- MinPackages<br>- MaxPackages |'."\n"
- .'| value | array | 否 | 过滤条件的值。 | | - |'."\n"
- .'| | string | 否 | 根据过滤的 key 类型,传入对应的过滤值。<br><br>当 key 为 `FlowAction` 时,value 枚举为:<br> - `ACCEPT`(默认传 `Accept`):安全组和网络 ACL 允许的流量<br> - `REJECT`:安全组和网络 ACL 拒绝的流量 | Accept | 当 key 为 FlowAction 时:ACCEPT / REJECT |'."\n"
- .'| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in):<br>● in:等于<br>● not in:不等于<br>● like:包含<br><br>根据 TupleDimension 字段和 TrafficScenario 字段,like 的支持情况如下:<br><br>TrafficScenario = VpcFlowLogAll / VpcFlowLogInternet(VPC 流日志场景):<br>当 key 为以下字段时,支持 like:<br> ○ CloudIp<br> ○ SourceIp<br> ○ DestinationIp<br><br>除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in<br>- in<br>- like |'."\n"
- .'| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |'."\n"
- .'| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |'."\n"
- .'| Sort | string | 否 | 指定流量分析的排序方式:<br>● ASC:按正序排序。<br>● DESC:按逆序排序。 | Desc | - Desc<br>- Asc |'."\n"
- .'| TopN | integer | 否 | 指定流量排序查询的条目数。<br>支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |'."\n"
- .'| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN<br>- en-US |'."\n"
- .'| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |'."\n"
- .'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
- .'| StorageInterval | integer | 否 | 存储桶精度属性。<br><br>存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。<br><br>- 流量分析器对应元组支持的存储精度为:<br> - `1`:单位分钟(1 分钟)<br> - `10`:单位分钟(10 分钟)<br> - `60`:单位分钟(60 分钟,即 1 小时)<br> - `1440`:单位分钟(1440 分钟,即 1 天)<br><br>- 存储桶精度可用于两类典型用途:<br> - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合<br> - 长周期流量统计:如 1440 分钟(1 天)聚合<br><br>- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:<br> - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据<br> - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1<br>- 10<br>- 60<br>- 1440 |'."\n"
- ."\n"
- .'### 返回参数'."\n"
- ."\n"
- .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
- .'|---------------------|--------|--------------------------------------------------------------------------------------------|---------------------------|--------|'."\n"
- .'| | object | RpcResponse <ArrayList> | | - |'."\n"
- .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | - |'."\n"
- .'| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |'."\n"
- ."\n"
- .'## 公网 VPC 流日志分析'."\n"
- ."\n"
- .'### 请求参数'."\n"
- ."\n"
- .'| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |'."\n"
- .'|-------------------|---------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n"
- .'| RegionNo | string | 是 | 资源所在地域。 | cn-shanghai | - |'."\n"
- .'| TrafficAnalyzerId | string | 是 | 流量分析器 ID。 | nta-262****ca07f | - |'."\n"
- .'| TrafficScenario | string | 是 | 支持分析场景:<br>● 公网 VPC 流日志分析 | 固定为:VpcFlowLogInternet | VpcFlowLogInternet |'."\n"
- .'| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 ENI 的流量。<br>● Out:流出 ENI 的流量。 | In | - In<br>- Out |'."\n"
- .'| TupleDimension | string | 是 | 流量存储聚合维度。 | Tuple1 | - Tuple1<br>- Tuple2<br>- Tuple5 |'."\n"
- .'| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | | - |'."\n"
- .'| | string | 否 | 根据 TupleDimension 字段,可以指定流量的聚合维度如下:<br>● TupleDimension = Tuple1 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ CloudIp:云端 IP<br><br>● TupleDimension = Tuple2 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ SourceIp:源端 IP<br> ■ DestinationIp:目的端 IP<br> ■ TrafficPath:流量路径<br> ■ `Country`:客户端国家<br> ■ `Province`:客户端省份<br> ■ `City`:客户端城市<br> ■ `Isp`:网络服务提供商<br> ■ `Asn`:自治系统号码<br><br>● TupleDimension = Tuple5 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ SourceIp:源端 IP<br> ■ DestinationIp:目的端 IP<br> ■ TrafficPath:流量路径<br> ■ SourcePort:源端端口<br> ■ DestinationPort:目的端口<br> ■ Protocol:网络协议<br> ■ Country:客户端国家<br> ■ Province:客户端省份<br> ■ City:客户端城市<br> ■ Isp:网络服务提供商<br> ■ Asn:自治系统号码 | ["VpcId"] | - VpcId<br>- VSwitchId<br>- CloudIp<br>- SourceIp<br>- DestinationIp<br>- Protocol<br>- SourcePort<br>- DestinationPort<br>- TrafficPath<br>- Country<br>- Province<br>- City<br>- Isp<br>- Asn |'."\n"
- .'| OrderBy | string | 是 | 支持按以下指标对流量进行排名:Bytes、Packets、RoundTripTime | Bytes | - Bytes<br>- Packets<br>- RoundTripTime |'."\n"
- .'| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | | - |'."\n"
- .'| | object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | | - |'."\n"
- .'| key | string | 否 | 支持过滤的条件标签键,如下所示:<br>- `TupleDimension` 为一元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `CloudIp`:云端 IP(对应 value 值可多选)<br><br>- `TupleDimension` 为二元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `SourceIp`:源端 IP(对应 value 值可多选)<br> - `DestinationIp`:目的端 IP(对应 value 值可多选)<br> - `TrafficPath`:流量路径(对应 value 值可多选)<br> - `ClientCountry`:按国家过滤流量分析范围(对应 value 值可多选)<br> - `ClientCity`:按城市过滤流量分析范围(对应 value 值可多选)<br> - `ClientAsn`:按 ASN 过滤流量分析范围(对应 value 值可多选)<br> - `ClientIsp`:按客户端运营商过滤流量分析范围(对应 value 值可多选)<br><br>- `TupleDimension` 为五元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `SourceIp`:源端 IP<br> - `DestinationIp`:目的端 IP<br> - `TrafficPath`:流量路径(对应 value 值可多选)<br> - `SourcePort`:源端口(对应 value 值可多选)<br> - `DestinationPort`:目的端口(对应 value 值可多选)<br> - `Protocol`:网络协议(对应 value 值可多选)<br> - `ClientCountry`:按国家过滤流量分析范围(对应 value 值可多选)<br> - `ClientCity`:按城市过滤流量分析范围(对应 value 值可多选)<br> - `ClientAsn`:按 ASN 过滤流量分析范围(对应 value 值可多选)<br> - `ClientIsp`:按客户端运营商过滤流量分析范围(对应 value 值可多选)<br><br>- VPC 场景下,均可按流量指标过滤:<br> - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)<br> - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)<br> - `MinRoundTripTime`:指定参与排序的最小 RTT,单位 ms(对应 value 值不可多选)<br> - `MaxRoundTripTime`:指定参与排序的最大 RTT,单位 ms(对应 value 值不可多选)<br> - `MinPackages`:指定参与排序的最小包数,单位个(对应 value 值不可多选)<br> - `MaxPackages`:指定参与排序的最大包数,单位个(对应 value 值不可多选) | FlowAction | - FlowAction<br>- VpcId<br>- VSwitchId<br>- NetworkInterfaceId<br>- CloudIp<br>- DestinationIp<br>- SourceIp<br>- EcsId<br>- TrafficPath<br>- ClientCountry<br>- ClientCity<br>- ClientAsn<br>- ClientIsp<br>- SourcePort<br>- DestinationPort<br>- Protocol<br>- MinBytes<br>- MaxBytes<br>- MinRoundTripTime<br>- MaxRoundTripTime<br>- MinPackages<br>- MaxPackages |'."\n"
- .'| value | array | 否 | 过滤条件的值。 | | - |'."\n"
- .'| | string | 否 | 根据过滤的 key 类型,传入对应的过滤值。<br> - 当 key 为 `FlowAction` 时,value 枚举为:<br> - `ACCEPT`(默认传 `Accept`):安全组和网络 ACL 允许的流量<br> - `REJECT`:安全组和网络 ACL 拒绝的流量 | Accept | - |'."\n"
- .'| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in):<br>● in:等于<br>● not in:不等于<br>● like:包含<br><br>● 当 key 为以下字段时,支持 like:<br> ○ CloudIp<br> ○ SourceIp<br> ○ DestinationIp<br>除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in <br> - in <br> - like |'."\n"
- .'| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |'."\n"
- .'| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |'."\n"
- .'| Sort | string | 否 | 指定流量分析的排序方式:<br>● ASC:按正序排序。<br>● DESC:按逆序排序。 | Desc | - Desc<br>- Asc |'."\n"
- .'| TopN | integer | 否 | 指定流量排序查询的条目数。<br>支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |'."\n"
- .'| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN<br>- en-US |'."\n"
- .'| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |'."\n"
- .'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |'."\n"
- .'| StorageInterval | integer | 否 | 存储桶精度属性。<br><br>存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。<br><br>- 流量分析器对应元组支持的存储精度为:<br> - `1`:单位分钟(1 分钟)<br> - `10`:单位分钟(10 分钟)<br> - `60`:单位分钟(60 分钟,即 1 小时)<br> - `1440`:单位分钟(1440 分钟,即 1 天)<br><br>- 存储桶精度可用于两类典型用途:<br> - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合<br> - 长周期流量统计:如 1440 分钟(1 天)聚合<br><br>- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:<br> - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据<br> - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1<br>- 10<br>- 60<br>- 1440 |'."\n"
- ."\n"
- .'### 返回参数'."\n"
- ."\n"
- .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
- .'|---------------------|--------|----------------------------------------------------------------------------------------|---------------------------|--------|'."\n"
- .'| | object | RpcResponse<ArrayList> | | - |'."\n"
- .'| RequestId | string | 请求ID。 | | - |'."\n"
- .'| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |'."\n"
- ."\n"
- .'## 全部 TR 流日志分析-TR跨地域'."\n"
- ."\n"
- .'### 请求参数'."\n"
- ."\n"
- .'| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |'."\n"
- .'|-------------------|---------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n"
- .'| RegionNo | string | 是 | 资源所在地域 | cn-shanghai | - |'."\n"
- .'| TrafficAnalyzerId | string | 是 | 流量分析器 ID | nta-262****ca07f | - |'."\n"
- .'| TrafficScenario | string | 是 | 支持分析场景:<br>● 全部TR流日志分析 | 固定为:TRFlowLog | TRFlowLog |'."\n"
- .'| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 TR 的流量。<br>● Out:流出 TR 的流量。 | In | - In <br>- Out |'."\n"
- .'| TupleDimension | string | 否 | 流量存储聚合维度。 | Tuple2 | - Tuple2 <br>- Tuple5 |'."\n"
- .'| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | | - |'."\n"
- .'| | string | 否 | (TR 流日志场景,元组自适应,`TupleDimension` 非必填)支持:<br>- `TransitRouterAttachmentId`: 网络实例连接 ID(必填)<br> - `TransitRouterId`:转发路由器实例 ID<br> - `SourceIp`:源端 IP<br> - `DestinationIp`:目的端 IP<br> - `Dscp`:区分服务代码点<br> - `Protocol`:网络协议<br> - `SourcePort`:源端端口<br> - `DestinationPort`:目的端端口 | ["TransitRouterAttachmentId"] | - TransitRouterAttachmentId<br> - TransitRouterId<br> - SourceIp<br> - DestinationIp<br> - Dscp<br> - Protocol<br> - SourcePort<br> - DestinationPort |'."\n"
- .'| OrderBy | string | 是 | 支持按以下指标对流量进行排名: <br> - `Bytes`:带宽<br> - `Packets`:包数<br> - `PacketsLostNoRoute`:无路由丢包数<br> - `PacketsLostBlackhole`:黑洞路由丢包数<br> - `PacketsLostTTLExpired`:TTL 超时丢包数 | Bytes | - Bytes<br>- Packets<br>- PacketsLostNoRoute<br>- PacketsLostBlackhole<br>- PacketsLostTTLExpired |'."\n"
- .'| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | | - |'."\n"
- .'| | object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | | - |'."\n"
- .'| key | string | 否 | 支持过滤的条件标签键,如下所示:<br>- 查询二元组或自适应为二元组时,支持:<br> - `TransitRouterAttachmentId`:网络实例连接 ID(必填,对应value值不可多选)<br> - `TransitRouterPairAttachmentId`:对端TR连接ID(对应value值可多选)<br> - `TransitRouterId`:转发路由器实例 ID(对应value值可多选)<br> - `SourceIp`:源端 IP(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)<br> - `DestinationIp`:目的端 IP(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)<br> - `Dscp`:区分服务代码点(对应value值可多选)<br><br> - 查询五元组或自适应为五元组时,在二元组支持的基础上,额外支持:<br> - `Protocol`:网络协议(对应value值可多选)<br> - `SourcePort`:源端端口(对应value值可多选)<br> - `DestinationPort`:目的端端口(对应value值可多选)<br><br> - TR 场景下,均可按流量指标过滤:<br> - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应value值不可多选)<br> - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应value值不可多选)<br> - `MinPackages`:指定参与排序的最小包数,单位个(对应value值不可多选)<br> - `MaxPackages`:指定参与排序的最大包数,单位个(对应value值不可多选)<br> - `MinPacketsLostNoRoute`:最小无路由丢包数,单位个(对应value值不可多选)<br> - `MinPacketsLostBlackhole`:最小黑洞路由丢包数,单位个(对应value值不可多选)<br> - `MinPacketsLostTTLExpired`:最小 TTL 超时丢包数,单位个(对应value值不可多选)<br> - `MaxPacketsLostNoRoute`:最大无路由丢包数,单位个(对应value值不可多选)<br> - `MaxPacketsLostBlackhole`:最大黑洞路由丢包数,单位个(对应value值不可多选)<br> - `MaxPacketsLostTTLExpired`:最大 TTL 超时丢包数,单位个(对应value值不可多选) | TransitRouterAttachmentId | - TransitRouterAttachmentId<br>- TransitRouterPairAttachmentId<br>- TransitRouterId<br>- SourceIp<br>- DestinationIp<br>- Dscp<br>- Protocol<br>- SourcePort<br>- DestinationPort<br>- MinBytes<br>- MaxBytes<br>- MinPackages<br>- MaxPackages<br>- MinPacketsLostBlackhole<br>- MaxPacketsLostBlackhole<br>- MinPacketsLostNoRoute<br>- MaxPacketsLostNoRoute<br>- MinPacketsLostTTLExpired<br>- MaxPacketsLostTTLExpired |'."\n"
- .'| value | array | 否 | 过滤条件的值。 | | - |'."\n"
- .'| | string | 否 | 根据过滤的key类型,传入对应的过滤值。<br>key 为 TransitRouterAttachmentId 时为必传项,对应的 value 同为必填 | tr-attach-dsvbe32hr*** | - |'."\n"
- .'| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in):<br>● in:等于<br>● not in:不等于<br>● like:包含<br>● 当 key 为以下字段时,支持 like:<br> ○ SourceIp<br> ○ DestinationIp<br>除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in<br>- in<br>- like |'."\n"
- .'| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |'."\n"
- .'| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |'."\n"
- .'| Sort | string | 否 | 指定流量分析的排序方式<br>● ASC:按正序排序。<br>● DESC:按逆序排序。 | Desc | - Desc<br>- Asc |'."\n"
- .'| TopN | integer | 否 | 指定流量排序查询的条目数。<br>支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |'."\n"
- .'| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN<br>- en-US |'."\n"
- .'| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |'."\n"
- .'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |'."\n"
- .'| StorageInterval | integer | 否 | 存储桶精度属性。<br><br>存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。<br><br>- 流量分析器对应元组支持的存储精度为:<br> - `1`:单位分钟(1 分钟)<br> - `10`:单位分钟(10 分钟)<br> - `60`:单位分钟(60 分钟,即 1 小时)<br> - `1440`:单位分钟(1440 分钟,即 1 天)<br><br>- 存储桶精度可用于两类典型用途:<br> - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合<br> - 长周期流量统计:如 1440 分钟(1 天)聚合<br><br>- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:<br> - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据<br> - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1<br>- 10<br>- 60<br>- 1440 |'."\n"
- ."\n"
- .'### 返回参数'."\n"
- ."\n"
- .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
- .'|---------------------|--------|----------------------------------------------------------------------------------------|---------------------------|--------|'."\n"
- .'| | object | RpcResponse<ArrayList> | | - |'."\n"
- .'| RequestId | string | 请求ID。 | | - |'."\n"
- .'| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |'."\n"
- ."\n"
- .'## 共享带宽指标分析'."\n"
- ."\n"
- .'### 请求参数'."\n"
- ."\n"
- .'| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |'."\n"
- .'|-------------------|---------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n"
- .'| RegionNo | string | 是 | 资源所在地域 | cn-shanghai | - |'."\n"
- .'| TrafficAnalyzerId | string | 是 | 流量分析器 ID | nta-262****ca07f | - |'."\n"
- .'| TrafficScenario | string | 是 | 支持分析场景:<br>● 共享带宽指标分析 | 固定为:CbwpMetric | CbwpMetric |'."\n"
- .'| Direction | string | 是 | 基于阿里云资源的网络流量方向。<br>● In:流入 EIP 的流量。<br>● Out:流出 EIP 的流量。 | In | -In <br>-Out |'."\n"
- .'| TupleDimension | string | 否 | 流量存储聚合维度。 | Tuple1 | -Tuple1 |'."\n"
- .'| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | | - |'."\n"
- .'| | string | 否 | CBWP 指标分析场景,(`TupleDimension` 非必填)支持:<br> - `PublicIpAddress`:绑定的 EIP 的公网 IP 地址<br> - `BindingResourceType`:EIP 所绑定的实例资源类型<br> - `BindingResourceId`:EIP 所绑定的实例资源 ID<br> - `CbwpId`:共享带宽包 ID | ["BindingResourceId"] | - BindingResourceId<br>- BindingResourceType<br>- CbwpId<br>- PublicIpAddress |'."\n"
- .'| OrderBy | string | 是 | 支持按以下指标对流量进行排名: <br> - `Bytes`:带宽<br> - `Packets`:包数 | Bytes | - Bytes<br>- Packets |'."\n"
- .'| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | | - |'."\n"
- .'| | object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | | - |'."\n"
- .'| key | string | 否 | 支持过滤的条件标签键,如下所示:<br> - 按条件过滤,支持:<br> - `PublicIpAddress`:绑定的 EIP 的公网 IP 地址(Operator = like 时对应 value 值不可多选,Operator != like 时对应 value 值可多选)<br> - `BindingResourceType`:EIP 所绑定的实例资源类型(对应 value 值可多选)<br> - `BindingResourceId`:EIP 所绑定的实例资源 ID(对应 value 值可多选)<br> - `CbwpId`:共享带宽包 ID(必填, 对应 value 值不可多选)<br> - `InstanceId`:共享带宽包所绑定的 EIP ID(对应 value 值可多选)<br><br> - CBWP 场景下,均可按流量指标过滤:<br> - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)<br> - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)<br> - `MinPackages`:指定参与排序的最小包数,单位个(对应 value 值不可多选)<br> - `MaxPackages`:指定参与排序的最大包数,单位个(对应 value 值不可多选) | CbwpId | - PublicIpAddress<br>- InstanceId<br>- BindingResourceType<br>- BindingResourceId<br>- CbwpId<br>- MinBytes<br>- MaxBytes<br>- MinPackages<br>- MaxPackages |'."\n"
- .'| value | array | 否 | 过滤条件的值。 | | - |'."\n"
- .'| | string | 否 | 根据过滤的key类型,传入对应的过滤值。<br> key 为 `CbwpId` 时为必传项,对应的 value 同为必填(指定具体的共享带宽包 ID)。 | cbwp-advb35j2jn3*** | - |'."\n"
- .'| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in):<br>● in:等于<br>● not in:不等于<br>● like:包含<br>● 当 key 为以下字段时,支持 `like`:<br> - `PublicIpAddress`<br><br>除以上字段外,其余字段仅支持 `in` 和 `not in` 操作符。<br>除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in<br>- in<br>- like |'."\n"
- .'| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |'."\n"
- .'| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |'."\n"
- .'| Sort | string | 否 | 指定流量分析的排序方式<br>● ASC:按正序排序。<br>● DESC:按逆序排序。 | Desc | - Desc<br>- Asc |'."\n"
- .'| TopN | integer | 否 | 指定流量排序查询的条目数。<br>支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |'."\n"
- .'| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN<br>- en-US |'."\n"
- .'| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |'."\n"
- .'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |'."\n"
- .'| StorageInterval | integer | 否 | 存储桶精度属性。<br><br>存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。<br><br>- 流量分析器对应元组支持的存储精度为:<br> - `1`:单位分钟(1 分钟)<br> - `10`:单位分钟(10 分钟)<br> - `60`:单位分钟(60 分钟,即 1 小时)<br> - `1440`:单位分钟(1440 分钟,即 1 天)<br><br>- 存储桶精度可用于两类典型用途:<br> - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合<br> - 长周期流量统计:如 1440 分钟(1 天)聚合<br><br>- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:<br> - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据<br> - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1<br>- 10<br>- 60<br>- 1440 |'."\n"
- ."\n"
- .'### 返回参数'."\n"
- ."\n"
- .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
- .'|---------------------|--------|----------------------------------------------------------------------------------------|---------------------------|--------|'."\n"
- .'| | object | RpcResponse<ArrayList> | | - |'."\n"
- .'| RequestId | string | 请求ID。 | | - |'."\n"
- .'| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"InspectionTaskId\\": \\"ni-8svmpe0yso2bhzr7fh79\\",\\n \\"InspectionName\\": \\"Default\\",\\n \\"Status\\": \\"Active\\",\\n \\"InspectionProject\\": \\"basic\\",\\n \\"InspectionTriggerTime\\": \\"2024-07-01 15:15:57\\",\\n \\"InspectionInterval\\": \\"1\\",\\n \\"LastUpdateReportId\\": \\"nir-7c3dd178738a429abe6d\\",\\n \\"CreateTime\\": \\"2024-07-01 10:00:57\\\\n\\",\\n \\"LastUpdateTime\\": \\"2024-07-01 10:00:59\\",\\n \\"CheckResourceList\\": [\\n {\\n \\"ResourceType\\": \\"EIP\\",\\n \\"CheckScope\\": \\"CheckAll\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeNisTrafficRanking' => [
'summary' => '查询NIS流量排序分析结果',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1080,45 +1460,23 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREnetana5MCZ6K',
- 'FEATUREnetanaOV20CD',
- ],
+ 'abilityTreeNodes' => ['FEATUREnetana5MCZ6K', 'FEATUREnetanaOV20CD'],
],
'parameters' => [
[
'name' => 'NisTrafficRankingId',
'in' => 'query',
- 'schema' => [
- 'description' => '流量排序分析结果 ID,根据StartNisTrafficRanking接口返回进行传入。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'task-6462a7b4c4a54b****',
- ],
+ 'schema' => ['description' => '流量排序分析结果 ID,根据StartNisTrafficRanking接口返回进行传入。', 'type' => 'string', 'required' => true, 'example' => 'task-6462a7b4c4a54b****'],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+',
- ],
+ 'schema' => ['description' => '查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。', 'type' => 'string', 'required' => false, 'example' => '2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+'],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小,取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '20',
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['description' => '分页大小,取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '20', 'example' => '20', 'default' => '20'],
],
],
'responses' => [
@@ -1128,394 +1486,153 @@
'description' => 'RpcResponse<QueryNtaNetworkRankingModel>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941',
- ],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941'],
'FlowRankingList' => [
'description' => '流量排序分析结果列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'RegionId' => [
- 'description' => '流日志所在地域。'."\n"
- .' - 当统计 VPC 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'VpcId' => [
- 'description' => '专有网络(VPC)ID。'."\n"
- .' - 当统计VPC流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'vpc-m5ec6i0h5xss***',
- ],
- 'VSwitchId' => [
- 'description' => '交换机ID。'."\n"
- .' - 当统计VPC流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'vsw-2zeekevlh****',
- ],
- 'NetworkInterfaceId' => [
- 'description' => '弹性网卡ID。'."\n"
- .' - 当统计VPC流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'eni-8vbf2jxul***',
- ],
- 'EcsId' => [
- 'description' => '管理节点ECS实例ID。'."\n"
- .' - 当统计VPC流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'i-uf6i1zi6yhq7h***',
- ],
- 'TrafficPath' => [
- 'description' => '流量路径。'."\n"
- .' - 当统计VPC流日志分析的二元组和五元组时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'all',
- ],
+ 'RegionId' => ['description' => '流日志所在地域。'."\n"
+ .' - 当统计 VPC 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'VpcId' => ['description' => '专有网络(VPC)ID。'."\n"
+ .' - 当统计VPC流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'vpc-m5ec6i0h5xss***'],
+ 'VSwitchId' => ['description' => '交换机ID。'."\n"
+ .' - 当统计VPC流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'vsw-2zeekevlh****'],
+ 'NetworkInterfaceId' => ['description' => '弹性网卡ID。'."\n"
+ .' - 当统计VPC流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'eni-8vbf2jxul***'],
+ 'EcsId' => ['description' => '管理节点ECS实例ID。'."\n"
+ .' - 当统计VPC流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'i-uf6i1zi6yhq7h***'],
+ 'TrafficPath' => ['description' => '流量路径。'."\n"
+ .' - 当统计VPC流日志分析的二元组和五元组时,该字段才会返回。', 'type' => 'string', 'example' => 'all'],
'Direction' => [
'description' => '基于阿里云网络资源实例的流量方向。取值:'."\n"
.'- **in**:入流量。'."\n"
.'- **out**:出流量。',
'type' => 'string',
- 'enumValueTitles' => [
- 'in' => 'in',
- 'out' => 'out',
- ],
+ 'enumValueTitles' => ['in' => 'in', 'out' => 'out'],
'example' => 'in',
],
- 'SourceIp' => [
- 'description' => '源端IP。'."\n"
- .' - 当统计TR和VPC流日志分析的二元组时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '47.92.245.***',
- ],
- 'SourcePort' => [
- 'description' => '源端端口。'."\n"
- .' - 当统计TR和VPC流日志分析的五元组时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '5432',
- ],
- 'DestinationIp' => [
- 'description' => '目的端IP。'."\n"
- .' - 当统计TR和VPC流日志分析的二元组时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '192.168.***.0',
- ],
- 'DestinationPort' => [
- 'description' => '目的端端口。'."\n"
- .' - 当统计TR和VPC流日志分析的五元组时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '23',
- ],
- 'Protocol' => [
- 'description' => '网络协议。'."\n"
- .' - 当统计TR和VPC流日志分析的五元组时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'TCP',
- ],
- 'ClientCountry' => [
- 'description' => '客户端所属的国家信息。'."\n"
- .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '中国',
- ],
- 'ClientProvince' => [
- 'description' => '客户端所在省份。'."\n"
- .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '香港特别行政区',
- ],
- 'ClientCity' => [
- 'description' => '客户端所在城市。'."\n"
- .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '九龙',
- ],
- 'ClientIsp' => [
- 'description' => '网络服务提供商。'."\n"
- .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '阿里云',
- ],
- 'ClientAsn' => [
- 'description' => '自治系统号码。'."\n"
- .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '45102',
- ],
- 'Bytes' => [
- 'description' => '带宽。'."\n"
- .' - 当VPC/TR/共享带宽分析时,该字段均会返回。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'Packets' => [
- 'description' => '包数。'."\n"
- .' - 当VPC/TR/CBWP流日志分析时,该字段均会返回。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'RoundTripTime' => [
- 'description' => 'TCP RTT。'."\n"
- .' - 当VPC流日志分析时,该字段才会返回。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '2',
- ],
- 'BytesRate' => [
- 'description' => '流量占比。'."\n"
- .' - 当TR和VPC流日志分析时,该字段才会返回。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.2',
- ],
- 'PacketsLostNoRoute' => [
- 'description' => '无路由丢包数。'."\n"
- .' - 当TR流日志分析时,该字段才会返回。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '2',
- ],
- 'PacketsLostBlackhole' => [
- 'description' => '黑洞路由丢包数。'."\n"
- .' - 当TR流日志分析时,该字段才会返回。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '4',
- ],
- 'PacketsLostTTLExpired' => [
- 'description' => 'TTL 超时丢包数。'."\n"
- .' - 当TR流日志分析时,该字段才会返回。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '7',
- ],
- 'TransitRouterId' => [
- 'description' => '转发路由器实例ID。'."\n"
- .' - 当TR流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'tr-2zefvwy2fz3444***',
- ],
- 'TransitRouterAttachmentId' => [
- 'description' => '网络实例连接ID。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'tr-attach-bfde1cd4cj***',
- ],
- 'Dscp' => [
- 'description' => '区分服务代码点。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'DestinationRegionNo' => [
- 'description' => '目的端地域ID。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'TransitRouterPairAttachmentId' => [
- 'description' => '转发路由器对等连接实例 ID。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'tr-attach-okvj1cd4cjp***',
- ],
- 'TransitRouterSourceResourceId' => [
- 'description' => '与转发路由器建立连接的源端云资源实例 ID。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'tr-attach-hvve1cd4cjpj***',
- ],
- 'TransitRouterSourceAccountId' => [
- 'description' => '与转发路由器建立连接的源端云资源实例账号ID。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '1906814138***',
- ],
- 'TransitRouterDestinationResourceId' => [
- 'description' => '与转发路由器建立连接的目的端云资源实例 ID。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'tr-attach-bfve1cd4cjp****',
- ],
- 'TransitRouterDestinationAccountId' => [
- 'description' => '与转发路由器建立连接的目的端云资源实例账号ID。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '1906814138****',
- ],
- 'SourceRegionNo' => [
- 'description' => '源端地域ID。'."\n"
- .' - 当 TR 流日志分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'TransitRouterSourceAvailableZone' => [
- 'description' => '与转发路由器建立连接的源端资源所在可用区标识。'."\n"
- .' - 当为 TR 流日志分析下的 VPC 连接流量场景时该字段才会返回。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-j',
- ],
- 'TransitRouterDestinationAvailableZone' => [
- 'description' => '与转发路由器建立连接的目的端资源所在可用区标识。'."\n"
- .' - 当为 TR 流日志分析下的 VPC 连接流量场景时该字段才会返回。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-j',
- ],
- 'TransitRouterDestinationVSwitchId' => [
- 'description' => '与转发路由器建立连接的目的端资源所在交换机ID。'."\n"
- .' - 当为TR流日志分析下的VPC 连接流量场景时该字段才会返回。',
- 'type' => 'string',
- 'example' => 'vsw-2zeekevlhxpqxu****',
- ],
- 'TransitRouterSourceVSwitchId' => [
- 'description' => '与转发路由器建立连接的源端资源所在交换机ID。'."\n"
- .' - 当为TR流日志分析下的VPC 连接流量场景时该字段才会返回。',
- 'type' => 'string',
- 'example' => 'vsw-ikfdkevlhxpqxuz****',
- ],
- 'TransitRouterSourceNetworkInterface' => [
- 'description' => '与转发路由器建立连接的源端资源所在的弹性网卡ID。'."\n"
- .' - 当为TR流日志分析下的VPC 连接流量场景时该字段才会返回。',
- 'type' => 'string',
- 'example' => 'eni-8vbf2jxulma***',
- ],
- 'TransitRouterDestinationNetworkInterface' => [
- 'description' => '与转发路由器建立连接的目的端资源所在的弹性网卡ID。'."\n"
- .' - 当为 TR 流日志分析下的 VPC 连接流量场景时该字段才会返回。',
- 'type' => 'string',
- 'example' => 'eni-fdbf2jxulm***',
- ],
- 'PublicIpAddress' => [
- 'description' => '绑定的 EIP 的公网 IP 地址。'."\n"
- .' - 当查询共享带宽指标分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => '118.31.***.86',
- ],
- 'InstanceId' => [
- 'description' => '共享带宽所绑定的 EIP ID。'."\n"
- .' - 当查询共享带宽指标分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'eip-fb6wzjl9hm****',
- ],
- 'BindingResourceType' => [
- 'description' => 'EIP 所绑定的实例资源类型。'."\n"
- .' - 当查询共享带宽指标分析时,该字段才会返回。'."\n"
- .' - 枚举有:'."\n"
- .' - EIP_ECS:云服务器ECS实例类型'."\n"
- .' - EIP_ENI:负载均衡SLB实例类型'."\n"
- .' - EIP_NAT:NAT网关实例类型'."\n"
- .' - EIP_SLB:弹性网卡实例类型'."\n"
- .' - HAVIP_ECS:高可用虚拟IP类型'."\n"
- .' - TARGET_IP:IP类型',
- 'type' => 'string',
- 'example' => 'EIP_NAT',
- ],
- 'BindingResourceId' => [
- 'description' => 'EIP 所绑定的实例资源。'."\n"
- .' - 当查询共享带宽指标分析时,该字段才会返回。',
- 'type' => 'string',
- 'example' => 'ngw-ufwerthgvc*****',
- ],
+ 'SourceIp' => ['description' => '源端IP。'."\n"
+ .' - 当统计TR和VPC流日志分析的二元组时,该字段才会返回。', 'type' => 'string', 'example' => '47.92.245.***'],
+ 'SourcePort' => ['description' => '源端端口。'."\n"
+ .' - 当统计TR和VPC流日志分析的五元组时,该字段才会返回。', 'type' => 'string', 'example' => '5432'],
+ 'DestinationIp' => ['description' => '目的端IP。'."\n"
+ .' - 当统计TR和VPC流日志分析的二元组时,该字段才会返回。', 'type' => 'string', 'example' => '192.168.***.0'],
+ 'DestinationPort' => ['description' => '目的端端口。'."\n"
+ .' - 当统计TR和VPC流日志分析的五元组时,该字段才会返回。', 'type' => 'string', 'example' => '23'],
+ 'Protocol' => ['description' => '网络协议。'."\n"
+ .' - 当统计TR和VPC流日志分析的五元组时,该字段才会返回。', 'type' => 'string', 'example' => 'TCP'],
+ 'ClientCountry' => ['description' => '客户端所属的国家信息。'."\n"
+ .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。', 'type' => 'string', 'example' => '中国'],
+ 'ClientProvince' => ['description' => '客户端所在省份。'."\n"
+ .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。', 'type' => 'string', 'example' => '香港特别行政区'],
+ 'ClientCity' => ['description' => '客户端所在城市。'."\n"
+ .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。', 'type' => 'string', 'example' => '九龙'],
+ 'ClientIsp' => ['description' => '网络服务提供商。'."\n"
+ .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。', 'type' => 'string', 'example' => '阿里云'],
+ 'ClientAsn' => ['description' => '自治系统号码。'."\n"
+ .' - 当统计VPC流日志分析的VPC 公网场景时,该字段才会返回。', 'type' => 'string', 'example' => '45102'],
+ 'Bytes' => ['description' => '带宽。'."\n"
+ .' - 当VPC/TR/共享带宽分析时,该字段均会返回。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
+ 'Packets' => ['description' => '包数。'."\n"
+ .' - 当VPC/TR/CBWP流日志分析时,该字段均会返回。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
+ 'RoundTripTime' => ['description' => 'TCP RTT。'."\n"
+ .' - 当VPC流日志分析时,该字段才会返回。', 'type' => 'number', 'format' => 'double', 'example' => '2'],
+ 'BytesRate' => ['description' => '流量占比。'."\n"
+ .' - 当TR和VPC流日志分析时,该字段才会返回。', 'type' => 'number', 'format' => 'double', 'example' => '0.2'],
+ 'PacketsLostNoRoute' => ['description' => '无路由丢包数。'."\n"
+ .' - 当TR流日志分析时,该字段才会返回。', 'type' => 'number', 'format' => 'double', 'example' => '2'],
+ 'PacketsLostBlackhole' => ['description' => '黑洞路由丢包数。'."\n"
+ .' - 当TR流日志分析时,该字段才会返回。', 'type' => 'number', 'format' => 'double', 'example' => '4'],
+ 'PacketsLostTTLExpired' => ['description' => 'TTL 超时丢包数。'."\n"
+ .' - 当TR流日志分析时,该字段才会返回。', 'type' => 'number', 'format' => 'double', 'example' => '7'],
+ 'TransitRouterId' => ['description' => '转发路由器实例ID。'."\n"
+ .' - 当TR流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'tr-2zefvwy2fz3444***'],
+ 'TransitRouterAttachmentId' => ['description' => '网络实例连接ID。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'tr-attach-bfde1cd4cj***'],
+ 'Dscp' => ['description' => '区分服务代码点。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => '0'],
+ 'DestinationRegionNo' => ['description' => '目的端地域ID。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'TransitRouterPairAttachmentId' => ['description' => '转发路由器对等连接实例 ID。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'tr-attach-okvj1cd4cjp***'],
+ 'TransitRouterSourceResourceId' => ['description' => '与转发路由器建立连接的源端云资源实例 ID。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'tr-attach-hvve1cd4cjpj***'],
+ 'TransitRouterSourceAccountId' => ['description' => '与转发路由器建立连接的源端云资源实例账号ID。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => '1906814138***'],
+ 'TransitRouterDestinationResourceId' => ['description' => '与转发路由器建立连接的目的端云资源实例 ID。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'tr-attach-bfve1cd4cjp****'],
+ 'TransitRouterDestinationAccountId' => ['description' => '与转发路由器建立连接的目的端云资源实例账号ID。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => '1906814138****'],
+ 'SourceRegionNo' => ['description' => '源端地域ID。'."\n"
+ .' - 当 TR 流日志分析时,该字段才会返回。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'TransitRouterSourceAvailableZone' => ['description' => '与转发路由器建立连接的源端资源所在可用区标识。'."\n"
+ .' - 当为 TR 流日志分析下的 VPC 连接流量场景时该字段才会返回。', 'type' => 'string', 'example' => 'cn-hangzhou-j'],
+ 'TransitRouterDestinationAvailableZone' => ['description' => '与转发路由器建立连接的目的端资源所在可用区标识。'."\n"
+ .' - 当为 TR 流日志分析下的 VPC 连接流量场景时该字段才会返回。', 'type' => 'string', 'example' => 'cn-hangzhou-j'],
+ 'TransitRouterDestinationVSwitchId' => ['description' => '与转发路由器建立连接的目的端资源所在交换机ID。'."\n"
+ .' - 当为TR流日志分析下的VPC 连接流量场景时该字段才会返回。', 'type' => 'string', 'example' => 'vsw-2zeekevlhxpqxu****'],
+ 'TransitRouterSourceVSwitchId' => ['description' => '与转发路由器建立连接的源端资源所在交换机ID。'."\n"
+ .' - 当为TR流日志分析下的VPC 连接流量场景时该字段才会返回。', 'type' => 'string', 'example' => 'vsw-ikfdkevlhxpqxuz****'],
+ 'TransitRouterSourceNetworkInterface' => ['description' => '与转发路由器建立连接的源端资源所在的弹性网卡ID。'."\n"
+ .' - 当为TR流日志分析下的VPC 连接流量场景时该字段才会返回。', 'type' => 'string', 'example' => 'eni-8vbf2jxulma***'],
+ 'TransitRouterDestinationNetworkInterface' => ['description' => '与转发路由器建立连接的目的端资源所在的弹性网卡ID。'."\n"
+ .' - 当为 TR 流日志分析下的 VPC 连接流量场景时该字段才会返回。', 'type' => 'string', 'example' => 'eni-fdbf2jxulm***'],
+ 'PublicIpAddress' => ['description' => '绑定的 EIP 的公网 IP 地址。'."\n"
+ .' - 当查询共享带宽指标分析时,该字段才会返回。', 'type' => 'string', 'example' => '118.31.***.86'],
+ 'InstanceId' => ['description' => '共享带宽所绑定的 EIP ID。'."\n"
+ .' - 当查询共享带宽指标分析时,该字段才会返回。', 'type' => 'string', 'example' => 'eip-fb6wzjl9hm****'],
+ 'BindingResourceType' => ['description' => 'EIP 所绑定的实例资源类型。'."\n"
+ .' - 当查询共享带宽指标分析时,该字段才会返回。'."\n"
+ .' - 枚举有:'."\n"
+ .' - EIP_ECS:云服务器ECS实例类型'."\n"
+ .' - EIP_ENI:负载均衡SLB实例类型'."\n"
+ .' - EIP_NAT:NAT网关实例类型'."\n"
+ .' - EIP_SLB:弹性网卡实例类型'."\n"
+ .' - HAVIP_ECS:高可用虚拟IP类型'."\n"
+ .' - TARGET_IP:IP类型', 'type' => 'string', 'example' => 'EIP_NAT'],
+ 'BindingResourceId' => ['description' => 'EIP 所绑定的实例资源。'."\n"
+ .' - 当查询共享带宽指标分析时,该字段才会返回。', 'type' => 'string', 'example' => 'ngw-ufwerthgvc*****'],
+ 'BytesIncrease' => ['description' => '带宽增长量。'."\n"
+ .' - 当TrafficScenario = TRFlowlog,且Order by 字段为BytesIncrease或BytesIncreaseRatio 时,该字段才会返回。', 'type' => 'number', 'format' => 'double', 'example' => '12345'],
+ 'BytesIncreaseRatio' => ['description' => '带宽增长率。'."\n"
+ .' - 当TrafficScenario = TRFlowlog,且Order by 字段为BytesIncrease或BytesIncreaseRatio 时,该字段才会返回。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
+ 'CenId' => ['title' => 'Cen实例ID', 'description' => 'Cen实例ID', 'type' => 'string'],
],
+ 'description' => '',
],
],
- 'NisTrafficRankingId' => [
- 'description' => '流量排序分析结果 ID。',
- 'type' => 'string',
- 'example' => 'task-7619ecb1db9148bab9f4',
- ],
- 'Status' => [
- 'description' => '任务运行状态。',
- 'type' => 'string',
- 'example' => 'Complete',
- ],
- 'NextToken' => [
- 'description' => '下一个查询开始的Token。',
- 'type' => 'string',
- 'example' => 'LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+',
- ],
- 'MaxResults' => [
- 'description' => '分页大小,取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => '返回的条目总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '72',
- ],
+ 'NisTrafficRankingId' => ['description' => '流量排序分析结果 ID。', 'type' => 'string', 'example' => 'task-7619ecb1db9148bab9f4'],
+ 'Status' => ['description' => '任务运行状态。', 'type' => 'string', 'example' => 'Complete'],
+ 'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+'],
+ 'MaxResults' => ['description' => '分页大小,取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['description' => '返回的条目总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '72'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Forbidden.NoPermission',
- 'errorMessage' => 'The authentication result is successful but the verification fails.',
- ],
- [
- 'errorCode' => 'IllegalParam.NextToken',
- 'errorMessage' => 'The specified argument NextToken(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxBytes',
- 'errorMessage' => 'The format of the specified parameter MaxBytes(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinBytes',
- 'errorMessage' => 'The format of the specified parameter MinBytes(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxRoundTripTime',
- 'errorMessage' => 'The format of the specified parameter MaxRoundTripTime(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinRoundTripTime',
- 'errorMessage' => 'The format of the specified parameter MinRoundTripTime(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MaxPackages',
- 'errorMessage' => 'The format of the specified parameter MaxPackages(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParamFormat.MinPackages',
- 'errorMessage' => 'The format of the specified parameter MinPackages(%s) is not legal.',
- ],
- [
- 'errorCode' => 'IllegalParam.UserOwesFees',
- 'errorMessage' => 'User (%s) is overdue.',
- ],
- [
- 'errorCode' => 'IllegalParam.UserNotActivated',
- 'errorMessage' => 'User (%s) did not provision service.',
- ],
+ ['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'The authentication result is successful but the verification fails.', 'description' => '鉴权结果成功但验证未通过。'],
+ ['errorCode' => 'IllegalParam.NextToken', 'errorMessage' => 'The specified argument NextToken(%s) is illegal.', 'description' => '指定的参数NextToken(%s)不合法。'."\n"],
+ ['errorCode' => 'IllegalParamFormat.MaxBytes', 'errorMessage' => 'The format of the specified parameter MaxBytes(%s) is not legal.', 'description' => '指定的参数MaxBytes(%s)格式不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MinBytes', 'errorMessage' => 'The format of the specified parameter MinBytes(%s) is not legal.', 'description' => '指定的参数MinBytes(%s)格式不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MaxRoundTripTime', 'errorMessage' => 'The format of the specified parameter MaxRoundTripTime(%s) is not legal.', 'description' => '指定的参数MaxRoundTripTime(%s)格式不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MinRoundTripTime', 'errorMessage' => 'The format of the specified parameter MinRoundTripTime(%s) is not legal.', 'description' => '指定的参数MinRoundTripTime(%s)格式不合法。'."\n"],
+ ['errorCode' => 'IllegalParamFormat.MaxPackages', 'errorMessage' => 'The format of the specified parameter MaxPackages(%s) is not legal.', 'description' => '指定的参数MaxPackages(%s)格式不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MinPackages', 'errorMessage' => 'The format of the specified parameter MinPackages(%s) is not legal.', 'description' => '指定的参数MinPackages(%s)格式不合法。'."\n"],
+ ['errorCode' => 'IllegalParam.UserOwesFees', 'errorMessage' => 'User (%s) is overdue.', 'description' => '用户(%s)已欠费.'],
+ ['errorCode' => 'IllegalParam.UserNotActivated', 'errorMessage' => 'User (%s) did not provision service.', 'description' => '用户(%s)未开通服务。'],
],
403 => [
- [
- 'errorCode' => 'OperationDenied.NisTrafficRankingId',
- 'errorMessage' => 'The specified parameter NisTrafficRankingId(%s) user does not have permission to operate.',
- ],
+ ['errorCode' => 'OperationDenied.NisTrafficRankingId', 'errorMessage' => 'The specified parameter NisTrafficRankingId(%s) user does not have permission to operate.', 'description' => '指定的参数NisTrafficRankingId(%s)用户没有操作权限。'],
],
[
- [
- 'errorCode' => 'ResourceNotFound.NisTrafficRankingId',
- 'errorMessage' => 'The specified parameter NisTrafficRankingId(%s) does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound.NisTrafficRankingId', 'errorMessage' => 'The specified parameter NisTrafficRankingId(%s) does not exist.', 'description' => '指定的参数NisTrafficRankingId(%s)不存在。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941\\",\\n \\"FlowRankingList\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcId\\": \\"vpc-m5ec6i0h5xss***\\",\\n \\"VSwitchId\\": \\"vsw-2zeekevlh****\\",\\n \\"NetworkInterfaceId\\": \\"eni-8vbf2jxul***\\",\\n \\"EcsId\\": \\"i-uf6i1zi6yhq7h***\\",\\n \\"TrafficPath\\": \\"all\\",\\n \\"Direction\\": \\"in\\",\\n \\"SourceIp\\": \\"47.92.245.***\\",\\n \\"SourcePort\\": \\"5432\\",\\n \\"DestinationIp\\": \\"192.168.***.0\\",\\n \\"DestinationPort\\": \\"23\\",\\n \\"Protocol\\": \\"TCP\\",\\n \\"ClientCountry\\": \\"中国\\",\\n \\"ClientProvince\\": \\"香港特别行政区\\",\\n \\"ClientCity\\": \\"九龙\\",\\n \\"ClientIsp\\": \\"阿里云\\",\\n \\"ClientAsn\\": \\"45102\\",\\n \\"Bytes\\": 100,\\n \\"Packets\\": 100,\\n \\"RoundTripTime\\": 2,\\n \\"BytesRate\\": 0.2,\\n \\"PacketsLostNoRoute\\": 2,\\n \\"PacketsLostBlackhole\\": 4,\\n \\"PacketsLostTTLExpired\\": 7,\\n \\"TransitRouterId\\": \\"tr-2zefvwy2fz3444***\\",\\n \\"TransitRouterAttachmentId\\": \\"tr-attach-bfde1cd4cj***\\",\\n \\"Dscp\\": \\"0\\",\\n \\"DestinationRegionNo\\": \\"cn-hangzhou\\",\\n \\"TransitRouterPairAttachmentId\\": \\"tr-attach-okvj1cd4cjp***\\",\\n \\"TransitRouterSourceResourceId\\": \\"tr-attach-hvve1cd4cjpj***\\",\\n \\"TransitRouterSourceAccountId\\": \\"1906814138***\\",\\n \\"TransitRouterDestinationResourceId\\": \\"tr-attach-bfve1cd4cjp****\\",\\n \\"TransitRouterDestinationAccountId\\": \\"1906814138****\\",\\n \\"SourceRegionNo\\": \\"cn-hangzhou\\",\\n \\"TransitRouterSourceAvailableZone\\": \\"cn-hangzhou-j\\",\\n \\"TransitRouterDestinationAvailableZone\\": \\"cn-hangzhou-j\\",\\n \\"TransitRouterDestinationVSwitchId\\": \\"vsw-2zeekevlhxpqxu****\\",\\n \\"TransitRouterSourceVSwitchId\\": \\"vsw-ikfdkevlhxpqxuz****\\",\\n \\"TransitRouterSourceNetworkInterface\\": \\"eni-8vbf2jxulma***\\",\\n \\"TransitRouterDestinationNetworkInterface\\": \\"eni-fdbf2jxulm***\\",\\n \\"PublicIpAddress\\": \\"118.31.***.86\\",\\n \\"InstanceId\\": \\"eip-fb6wzjl9hm****\\",\\n \\"BindingResourceType\\": \\"EIP_NAT\\",\\n \\"BindingResourceId\\": \\"ngw-ufwerthgvc*****\\"\\n }\\n ],\\n \\"NisTrafficRankingId\\": \\"task-7619ecb1db9148bab9f4\\",\\n \\"Status\\": \\"Complete\\",\\n \\"NextToken\\": \\"LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 72\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询NIS流量排序分析结果',
'description' => '[请确保在使用该接口前,已充分了解NIS-流量分析器的收费方式和价格。](https://help.aliyun.com/zh/nis/product-overview/billing-method-new-version?spm=5176.25472526.console-base_help.dexternal.5b094887xwrWNE)'."\n"
."\n"
@@ -1526,9 +1643,9 @@
.'- 全部TR流日志分析'."\n"
.'- 共享带宽指标分析'."\n"
."\n"
- .'# VPC 流日志 - 全部 VPC 流日志分析结果'."\n"
+ .'## VPC 流日志 - 全部 VPC 流日志分析结果'."\n"
."\n"
- .'## 请求参数'."\n"
+ .'### 请求参数'."\n"
."\n"
.'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1536,7 +1653,7 @@
.'| NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n"
.'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
."\n"
- .'## 返回参数'."\n"
+ .'### 返回参数'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1549,7 +1666,7 @@
.'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n"
.'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n"
."\n"
- .'### FlowRankingList 元素结构'."\n"
+ .'#### FlowRankingList 元素结构'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|--------------------|--------|--------------------------------------------------------------------------------------------|--------------------|----------|'."\n"
@@ -1572,9 +1689,9 @@
."\n\n"
.'---'."\n"
."\n"
- .'# VPC 流日志 - 公网 VPC 流日志分析结果'."\n"
+ .'## VPC 流日志 - 公网 VPC 流日志分析结果'."\n"
."\n"
- .'## 请求参数'."\n"
+ .'### 请求参数'."\n"
."\n"
.'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1582,7 +1699,7 @@
.'| NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n"
.'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
."\n"
- .'## 返回参数'."\n"
+ .'### 返回参数'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1595,7 +1712,7 @@
.'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n"
.'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n"
."\n"
- .'### FlowRankingList 元素结构'."\n"
+ .'#### FlowRankingList 元素结构'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|--------------------|--------|--------------------------------------------------------------------------------------------|------------------------|----------|'."\n"
@@ -1623,9 +1740,9 @@
."\n\n"
.'---'."\n"
."\n"
- .'# TR 流日志 - TR 跨地域场景分析结果'."\n"
+ .'## TR 流日志 - TR 跨地域场景分析结果'."\n"
."\n"
- .'## 请求参数'."\n"
+ .'### 请求参数'."\n"
."\n"
.'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1633,7 +1750,7 @@
.'| NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n"
.'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
."\n"
- .'## 返回参数'."\n"
+ .'### 返回参数'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1646,7 +1763,7 @@
.'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n"
.'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n"
."\n"
- .'### FlowRankingList 元素结构'."\n"
+ .'#### FlowRankingList 元素结构'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------------|--------|--------------------------------------------------------------------------------------------|-------------------------|----------|'."\n"
@@ -1671,9 +1788,9 @@
."\n\n"
.'---'."\n"
."\n"
- .'# TR 流日志 - VPC 连接流量场景分析结果'."\n"
+ .'## TR 流日志 - VPC 连接流量场景分析结果'."\n"
."\n"
- .'## 请求参数'."\n"
+ .'### 请求参数'."\n"
."\n"
.'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1681,7 +1798,7 @@
.'| NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n"
.'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
."\n"
- .'## 返回参数'."\n"
+ .'### 返回参数'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1694,7 +1811,7 @@
.'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n"
.'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n"
."\n"
- .'### FlowRankingList 元素结构'."\n"
+ .'#### FlowRankingList 元素结构'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|----------------------------------------|--------|--------------------------------------------------------------------------------------------|---------------------------------|----------|'."\n"
@@ -1729,9 +1846,9 @@
."\n\n"
.'---'."\n"
."\n"
- .'# TR 流日志 - VBR 访问流量场景分析结果'."\n"
+ .'## TR 流日志 - VBR 访问流量场景分析结果'."\n"
."\n"
- .'## 请求参数'."\n"
+ .'### 请求参数'."\n"
."\n"
.'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1739,7 +1856,7 @@
.'| NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n"
.'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
."\n"
- .'## 返回参数'."\n"
+ .'### 返回参数'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1752,7 +1869,7 @@
.'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n"
.'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n"
."\n"
- .'### FlowRankingList 元素结构'."\n"
+ .'#### FlowRankingList 元素结构'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|-----------------------------------|--------|--------------------------------------------------------------------------------------------|---------------------------------|----------|'."\n"
@@ -1781,9 +1898,9 @@
."\n\n"
.'---'."\n"
."\n"
- .'# TR 流日志 - ECR 访问流量场景分析结果'."\n"
+ .'## TR 流日志 - ECR 访问流量场景分析结果'."\n"
."\n"
- .'## 请求参数'."\n"
+ .'### 请求参数'."\n"
."\n"
.'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1791,7 +1908,7 @@
.'| NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n"
.'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
."\n"
- .'## 返回参数'."\n"
+ .'### 返回参数'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1804,7 +1921,7 @@
.'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n"
.'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n"
."\n"
- .'### FlowRankingList 元素结构'."\n"
+ .'#### FlowRankingList 元素结构'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|-----------------------------------|--------|--------------------------------------------------------------------------------------------|---------------------------------|----------|'."\n"
@@ -1833,9 +1950,9 @@
."\n\n"
.'---'."\n"
."\n"
- .'# TR 流日志 - VPN 访问流量场景分析结果'."\n"
+ .'## TR 流日志 - VPN 访问流量场景分析结果'."\n"
."\n"
- .'## 请求参数'."\n"
+ .'### 请求参数'."\n"
."\n"
.'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1843,7 +1960,7 @@
.'| NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n"
.'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
."\n"
- .'## 返回参数'."\n"
+ .'### 返回参数'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1856,7 +1973,7 @@
.'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n"
.'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n"
."\n"
- .'### FlowRankingList 元素结构'."\n"
+ .'#### FlowRankingList 元素结构'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|-----------------------------------|--------|--------------------------------------------------------------------------------------------|---------------------------------|----------|'."\n"
@@ -1885,9 +2002,9 @@
."\n\n"
.'---'."\n"
."\n"
- .'# 共享带宽指标分析(CBWP 指标分析)'."\n"
+ .'## 共享带宽指标分析(CBWP 指标分析)'."\n"
."\n"
- .'## 请求参数'."\n"
+ .'### 请求参数'."\n"
."\n"
.'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1895,7 +2012,7 @@
.'| NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n"
.'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
."\n"
- .'## 返回参数'."\n"
+ .'### 返回参数'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n"
@@ -1908,7 +2025,7 @@
.'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n"
.'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n"
."\n"
- .'### FlowRankingList 元素结构'."\n"
+ .'#### FlowRankingList 元素结构'."\n"
."\n"
.'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
.'|--------------------|--------|----------------------------------------------------------------------------------------------------|-----------------------|------------------------------------------------------------------------|'."\n"
@@ -1919,17 +2036,458 @@
.'| BindingResourceId | string | EIP 所绑定的实例资源。 | ngw-ufwerthgvc***** | |'."\n"
.'| Bytes | number | 带宽。 | 100 | |'."\n"
.'| Packets | number | 包数。 | 100 | |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisTrafficRanking',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941\\",\\n \\"FlowRankingList\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcId\\": \\"vpc-m5ec6i0h5xss***\\",\\n \\"VSwitchId\\": \\"vsw-2zeekevlh****\\",\\n \\"NetworkInterfaceId\\": \\"eni-8vbf2jxul***\\",\\n \\"EcsId\\": \\"i-uf6i1zi6yhq7h***\\",\\n \\"TrafficPath\\": \\"all\\",\\n \\"Direction\\": \\"in\\",\\n \\"SourceIp\\": \\"47.92.245.***\\",\\n \\"SourcePort\\": \\"5432\\",\\n \\"DestinationIp\\": \\"192.168.***.0\\",\\n \\"DestinationPort\\": \\"23\\",\\n \\"Protocol\\": \\"TCP\\",\\n \\"ClientCountry\\": \\"中国\\",\\n \\"ClientProvince\\": \\"香港特别行政区\\",\\n \\"ClientCity\\": \\"九龙\\",\\n \\"ClientIsp\\": \\"阿里云\\",\\n \\"ClientAsn\\": \\"45102\\",\\n \\"Bytes\\": 100,\\n \\"Packets\\": 100,\\n \\"RoundTripTime\\": 2,\\n \\"BytesRate\\": 0.2,\\n \\"PacketsLostNoRoute\\": 2,\\n \\"PacketsLostBlackhole\\": 4,\\n \\"PacketsLostTTLExpired\\": 7,\\n \\"TransitRouterId\\": \\"tr-2zefvwy2fz3444***\\",\\n \\"TransitRouterAttachmentId\\": \\"tr-attach-bfde1cd4cj***\\",\\n \\"Dscp\\": \\"0\\",\\n \\"DestinationRegionNo\\": \\"cn-hangzhou\\",\\n \\"TransitRouterPairAttachmentId\\": \\"tr-attach-okvj1cd4cjp***\\",\\n \\"TransitRouterSourceResourceId\\": \\"tr-attach-hvve1cd4cjpj***\\",\\n \\"TransitRouterSourceAccountId\\": \\"1906814138***\\",\\n \\"TransitRouterDestinationResourceId\\": \\"tr-attach-bfve1cd4cjp****\\",\\n \\"TransitRouterDestinationAccountId\\": \\"1906814138****\\",\\n \\"SourceRegionNo\\": \\"cn-hangzhou\\",\\n \\"TransitRouterSourceAvailableZone\\": \\"cn-hangzhou-j\\",\\n \\"TransitRouterDestinationAvailableZone\\": \\"cn-hangzhou-j\\",\\n \\"TransitRouterDestinationVSwitchId\\": \\"vsw-2zeekevlhxpqxu****\\",\\n \\"TransitRouterSourceVSwitchId\\": \\"vsw-ikfdkevlhxpqxuz****\\",\\n \\"TransitRouterSourceNetworkInterface\\": \\"eni-8vbf2jxulma***\\",\\n \\"TransitRouterDestinationNetworkInterface\\": \\"eni-fdbf2jxulm***\\",\\n \\"PublicIpAddress\\": \\"118.31.***.86\\",\\n \\"InstanceId\\": \\"eip-fb6wzjl9hm****\\",\\n \\"BindingResourceType\\": \\"EIP_NAT\\",\\n \\"BindingResourceId\\": \\"ngw-ufwerthgvc*****\\",\\n \\"BytesIncrease\\": 12345,\\n \\"BytesIncreaseRatio\\": 0.5,\\n \\"CenId\\": \\"\\"\\n }\\n ],\\n \\"NisTrafficRankingId\\": \\"task-7619ecb1db9148bab9f4\\",\\n \\"Status\\": \\"Complete\\",\\n \\"NextToken\\": \\"LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 72\\n}","type":"json"}]',
],
- 'GetNisNetworkRanking' => [
- 'summary' => '支持通过排序算法和数据处理能力,对流经不同云网络资源的流量进行排名分析,以及对阿里云性能观测的探测指标进行排序,帮助您快速识别网络瓶颈、优化资源配置和提升整体网络效能。',
- 'methods' => [
- 'get',
- 'post',
+ 'GetInternetTuple' => [
+ 'summary' => '调用GetInternetTuple接口,获取公网流量详情数据排名,覆盖一元组、二元组、五元组粒度,支持按流量、包数等指标排序。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '173536',
+ 'abilityTreeNodes' => ['FEATUREnetana5MCZ6K'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '要查询的公网流量的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
+ ],
+ [
+ 'name' => 'TupleType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '查询的元组类型,枚举:1,2,5,分别表示一元组、二元组、五元组',
+ 'description' => '查询的元组类型。取值: '."\n"
+ .'- **1**:表示一元组。 '."\n"
+ .'- **2**:表示二元组。 '."\n"
+ .'- **5**:表示五元组。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ 'enum' => ['1', '2', '5'],
+ ],
+ ],
+ [
+ 'name' => 'BeginTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询起始时间的毫秒时间戳。', 'description' => '查询起始时间的毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '253402271999000', 'minimum' => '0', 'example' => '1684373600099'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询结束时间的毫秒时间戳。', 'description' => '查询结束时间的毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '253402271999000', 'minimum' => '0', 'example' => '1684373700099'],
+ ],
+ [
+ 'name' => 'Direction',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '查询流量方向,取值:'."\n"
+ .'in:入云方向'."\n"
+ .'out:出云方向',
+ 'description' => '查询流量方向,取值:'."\n"
+ ."\n"
+ .'- **in**:入云方向。'."\n"
+ .'- **out**:出云方向。',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['in' => 'in', 'out' => 'out'],
+ 'example' => 'in',
+ 'enum' => ['in', 'out'],
+ ],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '根据什么指标排序,默认值为ByteCount,即按流量排序。',
+ 'description' => '数据排序的指标。默认值:**ByteCount**,表示按流量排序。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ByteCount',
+ 'enum' => ['Rtt', 'ByteCount', 'PacketCount', 'RetransmitRate'],
+ ],
+ ],
+ [
+ 'name' => 'CloudIp',
+ 'in' => 'query',
+ 'schema' => ['title' => '五元组:云端IP。', 'description' => '阿里云端IP。', 'type' => 'string', 'required' => false, 'example' => '112.74.XX.XX'],
+ ],
+ [
+ 'name' => 'CloudPort',
+ 'in' => 'query',
+ 'schema' => ['title' => '五元组:云端端口', 'description' => '阿里云端端口。 '."\n"
+ .'> 仅**TupleType**配置为**5**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => '443'],
+ ],
+ [
+ 'name' => 'OtherIp',
+ 'in' => 'query',
+ 'schema' => ['title' => '五元组:对端IP', 'description' => '对端IP。'."\n"
+ .' > 仅**TupleType**配置为**2**或**5**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => '122.112.XX.XX'],
+ ],
+ [
+ 'name' => 'OtherPort',
+ 'in' => 'query',
+ 'schema' => ['title' => '五元组:对端端口', 'description' => '对端端口。'."\n"
+ .' > 仅**TupleType**配置为**5**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => '40002'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '实例Id', 'description' => '阿里云端实例ID。', 'type' => 'string', 'required' => false, 'example' => 'eip-sample*'],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['title' => '五元组:协议', 'description' => '协议号。 '."\n"
+ .'>支持全部协议, 仅**TupleType**配置为**5**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => '6'],
+ ],
+ [
+ 'name' => 'Sort',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '排序方向:desc从大到小排序,asc从小到大排序。',
+ 'description' => '流量数据的排序方式。 '."\n"
+ .'- **desc**:从大到小排序。 '."\n"
+ .'- **asc**:从小到大排序',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'desc',
+ 'default' => 'desc',
+ 'enum' => ['desc', 'asc'],
+ ],
+ ],
+ [
+ 'name' => 'TopN',
+ 'in' => 'query',
+ 'schema' => ['title' => '默认10', 'description' => '展示排序靠前的数据。默认值:**10**。表示默认展示排序前10的数据。最大值:**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'CloudIsp',
+ 'in' => 'query',
+ 'schema' => ['title' => '云端运营商。', 'description' => '云端运营商。'."\n"
+ .'> 通常为“阿里巴巴”或“阿里云”。', 'type' => 'string', 'required' => false, 'example' => 'Alibaba'],
+ ],
+ [
+ 'name' => 'OtherIsp',
+ 'in' => 'query',
+ 'schema' => ['title' => '对端运营商,查看运营商情况时,请指定此参数。', 'description' => '对端运营商。 '."\n"
+ .'> 查看运营商情况时,请指定此参数。', 'type' => 'string', 'required' => false, 'example' => 'China Mobile'],
+ ],
+ [
+ 'name' => 'OtherCountry',
+ 'in' => 'query',
+ 'schema' => ['title' => '对端国家。仅TupleType配置为5时,才需要配置该参数。', 'description' => '对端国家。'."\n"
+ .'>仅**TupleType**配置为**2**或**5**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => 'China'],
+ ],
+ [
+ 'name' => 'OtherCity',
+ 'in' => 'query',
+ 'schema' => ['title' => '对端城市。仅TupleType配置为5时,才需要配置该参数。', 'description' => '对端城市。'."\n"
+ .'>仅**TupleType**配置为**2**或**5**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => 'Hangzhou'],
+ ],
+ [
+ 'name' => 'InstanceList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '批量过滤时的实例ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '批量过滤时的实例ID。', 'type' => 'string', 'required' => false, 'example' => '[\\"eip-sample*\\"]'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'CloudIpList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '批量过滤时的云上IP列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '批量过滤时的云上IP。', 'type' => 'string', 'required' => false, 'example' => '[\\"103.212.XX.XX\\"]'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'UseMultiAccount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否使用多账号访问模式', 'description' => '是否使用多账号管理功能。默认值:**false**。表示不使用。 '."\n"
+ .'> 多账号管理功能默认不开放,如需使用,请联系商务经理申请使用权限。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'AccountIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '显式传递子账号ID',
+ 'description' => '成员账号ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '某个成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[123]'],
+ 'required' => false,
+ 'maxItems' => 10,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'RpcResponse<ArrayList<PublicFlowTupleModel>>',
+ 'description' => 'RpcResponse<ArrayList<PublicFlowTupleModel>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B'],
+ 'Data' => [
+ 'description' => '公网流量详情排名列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '公网流量单行详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'BeginTime' => ['title' => '数据时间点', 'description' => '数据毫秒时间戳。', 'type' => 'string', 'example' => '1684373600099'],
+ 'Direction' => ['title' => '数据方向', 'description' => '流量方向。取值:'."\n"
+ .' - **in**:入云方向。 '."\n"
+ .'- **out**:出云方向。', 'type' => 'string', 'example' => 'in'],
+ 'InstanceId' => ['title' => '阿里侧IP归属的实例。', 'description' => '阿里云端IP归属的实例ID。', 'type' => 'string', 'example' => 'eip-sample*'],
+ 'AccessRegion' => ['title' => 'InstanceId为AnyCastEip时,流量进入阿里云的Pop点。', 'description' => '流量进入阿里云的接入点。 '."\n"
+ .'> 仅**InstanceId**为Anycast弹性公网IP时,该参数有效。', 'type' => 'string', 'example' => 'cn-hongkong-pop'],
+ 'CloudIp' => ['title' => '五元组云端IP', 'description' => '阿里云端IP。', 'type' => 'string', 'example' => '112.74.XX.XX'],
+ 'CloudPort' => ['title' => '五元组云端端口', 'description' => '阿里云端端口。', 'type' => 'string', 'example' => '443'],
+ 'OtherIp' => ['title' => '五元组对端IP', 'description' => '对端IP。', 'type' => 'string', 'example' => '122.112.XX.XX'],
+ 'OtherPort' => ['title' => '五元组对端端口', 'description' => '对端端口。', 'type' => 'string', 'example' => '40002'],
+ 'Protocol' => ['title' => '五元组协议', 'description' => '协议号。', 'type' => 'string', 'example' => '6'],
+ 'CloudCountry' => ['title' => '云端国家/地区', 'description' => '阿里云端国家或地区。', 'type' => 'string', 'example' => '中国'],
+ 'CloudProvince' => ['title' => '云端省份', 'description' => '阿里云端省份。', 'type' => 'string', 'example' => '江苏省'],
+ 'CloudCity' => ['title' => '云端城市', 'description' => '阿里云端城市。', 'type' => 'string', 'example' => '南京市'],
+ 'CloudIsp' => ['title' => '云端ISP', 'description' => '阿里云端运营商。', 'type' => 'string', 'example' => 'China Mobile'],
+ 'CloudProduct' => ['title' => '云端ISP', 'description' => '阿里云侧IP归属的实例对应的产品Code。', 'type' => 'string', 'example' => 'EIP'],
+ 'OtherCountry' => ['title' => '对端国家/地区', 'description' => '对端国家或地区。', 'type' => 'string', 'example' => 'United States'],
+ 'OtherProvince' => ['title' => '对端省份', 'description' => '对端省份。当**OtherCountry**为国外时,此值多数为空。', 'type' => 'string', 'example' => '得克萨斯州'],
+ 'OtherCity' => ['title' => '对端城市', 'description' => '对端城市。当**OtherCountry**为国外时,此值多数为空。', 'type' => 'string', 'example' => 'Austin'],
+ 'OtherIsp' => ['title' => '对端ISP', 'description' => '对端运营商。', 'type' => 'string', 'example' => 'amazon.com'],
+ 'OtherProduct' => ['title' => '对端ISP', 'description' => '对端IP归属的产品。如果非云上IP,则为空。', 'type' => 'string', 'example' => 'ECS'],
+ 'Rtt' => ['title' => 'RTT 指标(us)', 'description' => '往返时延RTT(Round Trip Time)。单位:us。', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
+ 'ByteCount' => ['title' => '流量指标(byte)', 'description' => '流量数(Byte)。', 'type' => 'number', 'format' => 'double', 'example' => '88'],
+ 'PacketCount' => ['title' => '包数指标(个)', 'description' => '流量包数。', 'type' => 'number', 'format' => 'double', 'example' => '66'],
+ 'OutOrderCount' => ['title' => '包数指标(个)', 'description' => '乱序包数。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'InByteCount' => ['title' => '包数指标(个)', 'description' => '入云方向流量数。单位:Byte。', 'type' => 'number', 'format' => 'double', 'example' => '88'],
+ 'OutByteCount' => ['title' => '包数指标(个)', 'description' => '出云方向流量数。单位:Byte。', 'type' => 'number', 'format' => 'double', 'example' => '66'],
+ 'InPacketCount' => ['title' => '入方向包数指标(个)', 'description' => '入云方向流量包数。', 'type' => 'number', 'format' => 'double', 'example' => '33'],
+ 'OutPacketCount' => ['title' => '出方向包数指标(个)', 'description' => '出云方向流量包数。', 'type' => 'number', 'format' => 'double', 'example' => '22'],
+ 'InOutOrderCount' => ['title' => '入方向乱序包数指标(个)', 'description' => '入云方向乱序包数。', 'type' => 'number', 'format' => 'double', 'example' => '2'],
+ 'OutOutOrderCount' => ['title' => '出方向乱序包数指标(个)', 'description' => '出云方向乱序包数。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'InRetranCount' => ['title' => '入方向重传包数指标(个)', 'description' => '入云方向重传包数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
+ 'OutRetranCount' => ['title' => '出方向重传包数指标(个)', 'description' => '出云方向重传包数。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'RetransmitRate' => ['title' => '重传率。', 'description' => 'TCP报文的重传率。', 'type' => 'number', 'format' => 'double', 'example' => '0.1'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalParam.TopN', 'errorMessage' => 'The TopN(%s) should not greater than 100.', 'description' => '最大仅支持Top 100,实际传入为(%s)。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime1H', 'errorMessage' => 'It only supports querying data for up to 1 hour: %s.', 'description' => '最长支持查询1小时数据: %s。'],
+ ['errorCode' => 'IllegalParam.GroupBy', 'errorMessage' => 'The specified param of GroupBy (%s) is invalid.', 'description' => '指定的分组字段(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.OrderBy', 'errorMessage' => 'The specified param of orderBy (%s) is invalid.', 'description' => '指定的排序字段(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.RegionId', 'errorMessage' => 'The specified region ID (%s) is invalid.', 'description' => '指定的地域(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime', 'errorMessage' => 'It only supports querying data for up to 24 hours: %s.', 'description' => '最大支持查询24小时数据。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime5M', 'errorMessage' => 'It only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.', 'description' => '当TupleType=5且CloudIp、OtherIp都是空时,只支持查询最长5分钟范围的数据。'],
+ ['errorCode' => 'OperationFailed.DbConcurrentTooHigh', 'errorMessage' => 'The operation failed due to too many concurrent queries. Please try again later.', 'description' => '当前用户过多,导致操作失败,请稍后再重试。'],
+ ['errorCode' => 'OperationFailed.DataTooMuch', 'errorMessage' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.', 'description' => '指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。'],
+ ],
+ 404 => [
+ ['errorCode' => 'ResourceNotFound.InstanceId', 'errorMessage' => 'The specified InstanceId(%s) does not exist.', 'description' => '指定的InstanceId(%s)不存在。'],
+ ['errorCode' => 'ResourceNotFound.IpSets', 'errorMessage' => 'The specified instance does not exist or does not have any acceleration region.', 'description' => '指定的实例不存在或者没有加速区域。'],
+ ],
+ ],
+ 'staticInfo' => [
+ 'substitutions' => ['nis::2021-12-16::GetNisNetworkRanking'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"Data\\": [\\n {\\n \\"BeginTime\\": \\"1684373600099\\",\\n \\"Direction\\": \\"in\\",\\n \\"InstanceId\\": \\"eip-sample*\\",\\n \\"AccessRegion\\": \\"cn-hongkong-pop\\",\\n \\"CloudIp\\": \\"112.74.XX.XX\\",\\n \\"CloudPort\\": \\"443\\",\\n \\"OtherIp\\": \\"122.112.XX.XX\\",\\n \\"OtherPort\\": \\"40002\\",\\n \\"Protocol\\": \\"6\\",\\n \\"CloudCountry\\": \\"中国\\",\\n \\"CloudProvince\\": \\"江苏省\\",\\n \\"CloudCity\\": \\"南京市\\",\\n \\"CloudIsp\\": \\"China Mobile\\",\\n \\"CloudProduct\\": \\"EIP\\",\\n \\"OtherCountry\\": \\"United States\\",\\n \\"OtherProvince\\": \\"得克萨斯州\\",\\n \\"OtherCity\\": \\"Austin\\",\\n \\"OtherIsp\\": \\"amazon.com\\",\\n \\"OtherProduct\\": \\"ECS\\",\\n \\"Rtt\\": 10000,\\n \\"ByteCount\\": 88,\\n \\"PacketCount\\": 66,\\n \\"OutOrderCount\\": 1,\\n \\"InByteCount\\": 88,\\n \\"OutByteCount\\": 66,\\n \\"InPacketCount\\": 33,\\n \\"OutPacketCount\\": 22,\\n \\"InOutOrderCount\\": 2,\\n \\"OutOutOrderCount\\": 1,\\n \\"InRetranCount\\": 0,\\n \\"OutRetranCount\\": 1,\\n \\"RetransmitRate\\": 0.1\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取公网流量详情数据排名',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetInternetTuple'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:GetInternetTuple',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetNatTopN' => [
+ 'summary' => '调用GetNatTopN接口,获取NAT网关的SNAT转发实时数据排名。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '116918',
+ 'abilityTreeNodes' => ['FEATUREnetana5MCZ6K'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'Nat网关实例所属地域', 'description' => 'NAT网关实例所属地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ [
+ 'name' => 'NatGatewayId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'Nat网关实例ID', 'description' => 'NAT网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ngw-sample***'],
+ ],
+ [
+ 'name' => 'BeginTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询指标的开始毫秒时间戳。如果不指定EndTime,则查询的是BeginTime指定的时间点的TopN情况。', 'description' => '查询指标的开始毫秒时间戳。如果不指定**EndTime**,则查询的是**BeginTime**指定的时间点的情况。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1638239092000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询指标的结束毫秒时间戳。BeginTime和EndTime的最大差距不能超过24小时,即86400000。', 'description' => '查询指标的结束毫秒时间戳。**BeginTime**和**EndTime**的最大差距不能超过24小时,即**86400000**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1638239093000'],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '按哪个指标倒叙排序取TopN。',
+ 'description' => '对NAT网关进行SNAT转发实时数据排名的指标。取值:'."\n"
+ .'- **InBps**:入方向流量。单位:bps。'."\n"
+ .'- **OutBps**:出方向流量。单位:bps。'."\n"
+ .'- **InPps**:入方向包速率。单位:个/秒。'."\n"
+ .'- **OutPps**:出方向包速率。单位:个/秒。'."\n"
+ .'- **NewSessionPerSecond**:新建连接数。单位:个/秒。'."\n"
+ .'- **ActiveSessionCount**:并发连接数。单位:个。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'InBps',
+ ],
+ ],
+ [
+ 'name' => 'TopN',
+ 'in' => 'query',
+ 'schema' => ['title' => '取最大多少条数据,默认10,最大100。', 'description' => '查询NAT网关的SNAT转发实时数据排名的条目数。取值范围:**1~100**。默认值:**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Ip',
+ 'in' => 'query',
+ 'schema' => ['title' => '查指定ip的指标,此时无需传topN和orderBy', 'description' => '查询指定IP地址的监控指标。当输入Ip参数时,无需输入**TopN**和**OrderBy**。', 'type' => 'string', 'required' => false, 'example' => '192.168.156.101'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '77C512B5-12f3-f892-BD94-88A98271C1A0'],
+ 'NatGatewayTopN' => [
+ 'title' => '以下指标取BeginTime到EndTime的均值。',
+ 'description' => 'NAT网关SNAT转发实时数据排名数组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'NAT网关SNAT转发实时数据排名对象。以下指标取**BeginTime**到**EndTime**的均值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Ip' => ['title' => 'IP地址', 'description' => 'IP地址。', 'type' => 'string', 'example' => '192.168.156.101'],
+ 'InBps' => ['title' => '入方向流量,单位bps', 'description' => '入方向流量。单位:bps。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ 'OutBps' => ['title' => '出方向流量,单位bps', 'description' => '出方向流量。单位:bps。', 'type' => 'number', 'format' => 'float', 'example' => '200'],
+ 'InPps' => ['title' => '入方向包速率(个/秒)', 'description' => '入方向包速率。单位:个/秒。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
+ 'OutPps' => ['title' => '出方向包速率', 'description' => '出方向包速率。单位:个/秒。', 'type' => 'number', 'format' => 'float', 'example' => '20'],
+ 'InFlowPerMinute' => ['description' => '保留字段,暂未使用。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
+ 'OutFlowPerMinute' => ['description' => '保留字段,暂未使用。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
+ 'NewSessionPerSecond' => ['title' => '新建连接数(个/秒)', 'description' => '新建连接数。单位:个/秒。', 'type' => 'number', 'format' => 'float', 'example' => '2'],
+ 'ActiveSessionCount' => ['title' => '并发连接数(个)', 'description' => '并发连接数。单位:个。', 'type' => 'number', 'format' => 'float', 'example' => '8'],
+ ],
+ ],
+ ],
+ 'IsTopNOpen' => ['title' => '该实例是否开通TopN功能', 'description' => '是否已开通网络智能服务(NIS)功能,未开通时NatGatewayTopN返回空。'."\n"
+ .'- **true**:已开通。'."\n"
+ .'- **false**:未开通。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalParam.TopN', 'errorMessage' => 'The TopN(%s) should not greater than 100.', 'description' => '最大仅支持Top 100,实际传入为(%s)。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime', 'errorMessage' => 'It only supports querying data for up to 7 days: %s.', 'description' => '最大仅支持查询7天的数据:%s。'],
+ ['errorCode' => 'IllegalParam.ResourceId', 'errorMessage' => 'The specified resourceId (%s) may be not exist.', 'description' => '指定的实例(%s)可能不存在,请检查是否拼写错误。'],
+ ['errorCode' => 'IllegalParam.OrderBy', 'errorMessage' => 'The specified param of orderBy (%s) is invalid.', 'description' => '指定的排序字段(%s)不合法。'],
+ ],
+ ],
+ 'staticInfo' => [
+ 'substitutions' => ['nis::2021-12-16::GetNisNetworkRanking'],
+ ],
+ 'title' => '获取NAT网关SNAT转发实时数据排名',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNatTopN'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:GetNatTopN',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"77C512B5-12f3-f892-BD94-88A98271C1A0\\",\\n \\"NatGatewayTopN\\": [\\n {\\n \\"Ip\\": \\"192.168.156.101\\",\\n \\"InBps\\": 100,\\n \\"OutBps\\": 200,\\n \\"InPps\\": 10,\\n \\"OutPps\\": 20,\\n \\"InFlowPerMinute\\": 10,\\n \\"OutFlowPerMinute\\": 10,\\n \\"NewSessionPerSecond\\": 2,\\n \\"ActiveSessionCount\\": 8\\n }\\n ],\\n \\"IsTopNOpen\\": true\\n}","type":"json"}]',
+ ],
+ 'GetNetworkReachableAnalysis' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1938,30 +2496,754 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '222984',
- 'abilityTreeNodes' => [
- 'FEATUREnetana5MCZ6K',
- 'FEATUREnetanaOV20CD',
- 'FEATUREnetanaB9LIVJ',
- 'FEATUREnetanaCEA895',
+ 'abilityTreeNodes' => ['FEATUREnetana59X9GB', 'FEATUREnetana98CV3P', 'FEATUREnetanaWZGUR4', 'FEATUREnetanaDZZVCZ', 'FEATUREnetana0CBIRP', 'FEATUREnetanaJGHZ2X', 'FEATUREnetanaRD137H', 'FEATUREnetanaCAWHBE', 'FEATUREnetana8JUW6E'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '网络可达性分析任务的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ ],
+ [
+ 'name' => 'NetworkReachableAnalysisId',
+ 'in' => 'query',
+ 'schema' => ['description' => '网络可达性分析任务ID。 您可以通过调用**CreateNetworkRearchableAnalysis**接口获取网络可达性分析ID。', 'type' => 'string', 'required' => true, 'example' => 'nra-90eef36a9e6e4662****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NetworkPathId' => ['description' => '创建的网络实例的路径ID。', 'type' => 'string', 'example' => 'np-2a1332214fa346b6****'],
+ 'NetworkReachableAnalysisId' => ['description' => '网络可达性分析任务ID。', 'type' => 'string', 'example' => 'nra-8607514e71c1484****'],
+ 'NetworkReachableAnalysisStatus' => ['description' => '网络可达性分析任务的状态。取值:'."\n"
+ .'- **init**:初始化。'."\n"
+ .'- **finish**:已完成。'."\n"
+ .'- **error**:分析错误。'."\n"
+ .'- **timeout**:已超时。', 'type' => 'string', 'example' => 'finish'],
+ 'NetworkReachableAnalysisResult' => ['description' => '用于展示网络可达性分析结果,包括网络路径拓扑、网络不可达错误码、网络不可达规则等。', 'type' => 'string', 'example' => '{'."\n"
+ .' "errorCode": "",'."\n"
+ .' "networkAclData": {'."\n"
+ .' "networkAclItems": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "nraId": "nra-f2c8701a36424094****",'."\n"
+ .' "requestId": "B931F8A0-620E-5230-B77F-3BD7F612****",'."\n"
+ .' "routeData": {'."\n"
+ .' "routeItems": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "securityGroupData": {'."\n"
+ .' "policy": "accept",'."\n"
+ .' "securityGroupItems": ['."\n"
+ .' {'."\n"
+ .' "description": "default_sg_access_rule",'."\n"
+ .' "matchedRule": {'."\n"
+ .' "bizProtocol": "ALL",'."\n"
+ .' "creatingTime": "2022-11-10T03:24:49Z",'."\n"
+ .' "description": "",'."\n"
+ .' "destinationCidr": "",'."\n"
+ .' "destinationGroupId": "sg-wz980j96p8y99co5****",'."\n"
+ .' "direction": "egress",'."\n"
+ .' "policy": "Accept",'."\n"
+ .' "portRange": "-1/-1",'."\n"
+ .' "priority": "1",'."\n"
+ .' "sourceCidr": "",'."\n"
+ .' "sourceGroupId": ""'."\n"
+ .' },'."\n"
+ .' "policy": "accept",'."\n"
+ .' "resourceId": "eni-wz92ce4saz1jzazg****",'."\n"
+ .' "securityGroupId": "sg-wz980j96p8y99co5****"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "description": "user_acl_drop_rule",'."\n"
+ .' "matchedRule": {'."\n"
+ .' "bizProtocol": "",'."\n"
+ .' "creatingTime": "",'."\n"
+ .' "description": "",'."\n"
+ .' "destinationCidr": "",'."\n"
+ .' "destinationGroupId": "",'."\n"
+ .' "direction": "",'."\n"
+ .' "policy": "",'."\n"
+ .' "portRange": "",'."\n"
+ .' "priority": "",'."\n"
+ .' "sourceCidr": "",'."\n"
+ .' "sourceGroupId": ""'."\n"
+ .' },'."\n"
+ .' "policy": "",'."\n"
+ .' "resourceId": "eni-wz97vry93t6z4lbd****",'."\n"
+ .' "securityGroupId": "sg-wz980j96p8y99co****"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "securityGroupReportId": "sgr-4479d23bb37241aab****"'."\n"
+ .' },'."\n"
+ .' "status": "security_group_checking_target",'."\n"
+ .' "topologyData": {'."\n"
+ .' "positive": {'."\n"
+ .' "linkList": ['."\n"
+ .' {'."\n"
+ .' "id": "i-wz91dk7bor557hp93zyv-->eni-wz92ce4saz1jzazg****",'."\n"
+ .' "source": "i-wz91dk7bor557hp9****",'."\n"
+ .' "target": "eni-wz92ce4saz1jzazg****"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "id": "eni-wz92ce4saz1jzazgi13d-->vsw-wz9slpwdcppwfrnee****",'."\n"
+ .' "source": "eni-wz92ce4saz1jzazg****",'."\n"
+ .' "target": "vsw-wz9slpwdcppwfrnee****"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "id": "vsw-wz9slpwdcppwfrneebcrp-->eni-wz97vry93t6z4lbd****",'."\n"
+ .' "source": "vsw-wz9slpwdcppwfrnee****",'."\n"
+ .' "target": "eni-wz97vry93t6z4lbd****"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "id": "eni-wz97vry93t6z4lbdgmfi-->i-wz91dk7bor557hp9****",'."\n"
+ .' "source": "eni-wz97vry93t6z4lbd****",'."\n"
+ .' "target": "i-wz91dk7bor557hp9****"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "nodeList": ['."\n"
+ .' {'."\n"
+ .' "aZone": "cn-shenzhen-d",'."\n"
+ .' "bizInsId": "i-wz91dk7bor557hp9****",'."\n"
+ .' "id": "i-wz91dk7bor557hp9****",'."\n"
+ .' "level": 1,'."\n"
+ .' "matchedRoute": {'."\n"
+ .' "nextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "nodeType": "VM",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "trafficLogs": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "aZone": "cn-shenzhen-d",'."\n"
+ .' "bizInsId": "i-wz91dk7bor557hp9****",'."\n"
+ .' "id": "i-wz91dk7bor557hp9****",'."\n"
+ .' "level": 3,'."\n"
+ .' "matchedRoute": {'."\n"
+ .' "nextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "nodeType": "VM",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "trafficLogs": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "aZone": "cn-shenzhen-d",'."\n"
+ .' "bizInsId": "vsw-wz9slpwdcppwfrnee****",'."\n"
+ .' "cidr": "192.168.0.0/24",'."\n"
+ .' "id": "vsw-wz9slpwdcppwfrnee****",'."\n"
+ .' "level": 2,'."\n"
+ .' "matchedRoute": {'."\n"
+ .' "nextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "nodeType": "VSW",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "trafficLogs": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "bizInsId": "eni-wz92ce4saz1jzazg****",'."\n"
+ .' "id": "eni-wz92ce4saz1jzazg****",'."\n"
+ .' "ip": "192.168.0.33",'."\n"
+ .' "mac": "00:XXXX:3e:16:7c:50",'."\n"
+ .' "matchedRoute": {'."\n"
+ .' "nextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "nodeType": "ENI",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "status": "InUse",'."\n"
+ .' "trafficLogs": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "bizInsId": "eni-wz97vry93t6z4lbd****",'."\n"
+ .' "id": "eni-wz97vry93t6z4lbd****",'."\n"
+ .' "ip": "192.168.0.34",'."\n"
+ .' "mac": "00:XXXX:3e:14:70:c2",'."\n"
+ .' "matchedRoute": {'."\n"
+ .' "nextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "nodeType": "ENI",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "status": "InUse",'."\n"
+ .' "trafficLogs": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "reverse": {'."\n"
+ .' "revLinkList": ['."\n"
+ .' {'."\n"
+ .' "id": "i-wz91dk7bor557hp93zys-->eni-wz97vry93t6z4lbd****",'."\n"
+ .' "source": "i-wz91dk7bor557hp9****",'."\n"
+ .' "target": "eni-wz97vry93t6z4lbd****"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "id": "eni-wz97vry93t6z4lbdgmfi-->vsw-wz9slpwdcppwfrnee****",'."\n"
+ .' "source": "eni-wz97vry93t6z4lbd****",'."\n"
+ .' "target": "vsw-wz9slpwdcppwfrnee****"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "id": "vsw-wz9slpwdcppwfrneebcrp-->eni-wz92ce4saz1jzazg****",'."\n"
+ .' "source": "vsw-wz9slpwdcppwfrnee****",'."\n"
+ .' "target": "eni-wz92ce4saz1jzazg****"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "id": "eni-wz92ce4saz1jzazgi13d-->i-wz91dk7bor557hp9****",'."\n"
+ .' "source": "eni-wz92ce4saz1jzazg****",'."\n"
+ .' "target": "i-wz91dk7bor557hp9****"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "revNodeList": ['."\n"
+ .' {'."\n"
+ .' "aZone": "cn-shenzhen-d",'."\n"
+ .' "bizInsId": "i-wz91dk7bor557hp9****",'."\n"
+ .' "id": "i-wz91dk7bor557hp9****",'."\n"
+ .' "level": 1,'."\n"
+ .' "nodeType": "VM",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "revMatchedRoute": {'."\n"
+ .' "revNextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "aZone": "cn-shenzhen-d",'."\n"
+ .' "bizInsId": "i-wz91dk7bor557hp9****",'."\n"
+ .' "id": "i-wz91dk7bor557hp9****",'."\n"
+ .' "level": 3,'."\n"
+ .' "nodeType": "VM",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "revMatchedRoute": {'."\n"
+ .' "revNextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "aZone": "cn-shenzhen-d",'."\n"
+ .' "bizInsId": "vsw-wz9slpwdcppwfrnee****",'."\n"
+ .' "cidr": "192.168.0.0/24",'."\n"
+ .' "id": "vsw-wz9slpwdcppwfrnee****",'."\n"
+ .' "level": 2,'."\n"
+ .' "nodeType": "VSW",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "revMatchedRoute": {'."\n"
+ .' "revNextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "bizInsId": "eni-wz97vry93t6z4lbd****",'."\n"
+ .' "id": "eni-wz97vry93t6z4lbd****",'."\n"
+ .' "ip": "192.168.0.34",'."\n"
+ .' "mac": "00:XXXX:3e:14:70:c2",'."\n"
+ .' "nodeType": "ENI",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "revMatchedRoute": {'."\n"
+ .' "revNextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "status": "InUse"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "bizInsId": "eni-wz92ce4saz1jzazg****",'."\n"
+ .' "id": "eni-wz92ce4saz1jzazg****",'."\n"
+ .' "ip": "192.168.0.33",'."\n"
+ .' "mac": "00:XXXX:3e:16:7c:50",'."\n"
+ .' "nodeType": "ENI",'."\n"
+ .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
+ .' "regionNoAlias": "cn-shenzhen",'."\n"
+ .' "revMatchedRoute": {'."\n"
+ .' "revNextHopSet": ['."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "status": "InUse"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "topologyReportId": "tpr-21cf60002715491b8****"'."\n"
+ .' }'."\n"
+ .'}'],
+ 'Reachable' => ['description' => '网络路径是否可达。取值:'."\n"
+ .'- **true**:可达。'."\n"
+ .'- **false**:不可达。', 'type' => 'boolean', 'example' => 'true'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2023-03-16T07:11:27Z'],
+ 'AliUid' => ['description' => '用户UID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123147627844****'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DEE0FEAF-59AE-5CDD-AA07-626BC365D571'],
+ 'NetworkPathParameter' => ['description' => '网络路径详细参数。', 'type' => 'string', 'example' => '{'."\n"
+ .' "sourceId": "i-bp100g5pbp6kj4p9****",'."\n"
+ .' "sourceType": "ecs",'."\n"
+ .' "targetId": "i-t4n4ltwgbbomzb0g****",'."\n"
+ .' "targetType": "ecs"'."\n"
+ .'}'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'SizeExceeds.Zones', 'errorMessage' => 'The length of the specified available zones exceeds the limit.', 'description' => '指定的可用区列表长度超过限制。'],
+ ['errorCode' => 'SizeExceeds.DiskCategories', 'errorMessage' => 'The length of the specified disk categories exceeds the limit.', 'description' => '指定的磁盘类型列表长度超过限制。'],
+ ['errorCode' => 'OperationDenied.ZonesConflict', 'errorMessage' => 'The specified available zones do not belong to the same region.', 'description' => '指定的可用区不属于同一个地域。'],
+ ['errorCode' => 'IllegalParam.ZoneId', 'errorMessage' => 'The specified available zone (%s) is invalid.', 'description' => '指定的可用区(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.StepMinutes', 'errorMessage' => 'The specified sampling interval (%s) is invalid.', 'description' => '指定的采样间隔(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.BeginTime', 'errorMessage' => 'The specified begin time (%s) is invalid.', 'description' => '指定的开始时间(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.EndTime', 'errorMessage' => 'The specified end time (%s) is invalid.', 'description' => '指定的结束时间(%s)不合法。'],
+ ['errorCode' => 'Mismatch.BeginTimeAndEndTime', 'errorMessage' => 'The specified begin time must be earlier than the end time.', 'description' => '指定的开始时间在结束时间之后。'],
+ ['errorCode' => 'OperationDenied.NetworkReachableAnalysis', 'errorMessage' => 'The operation is not allowed because of invalid parameters.', 'description' => '请求存在非法参数,当前操作不被允许。'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden.NetworkReachableAnalysisId', 'errorMessage' => 'The user does not have permission on the instance parameter (%s).', 'description' => '该用户没有该资源(%s)权限.'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound.NetworkReachableAnalysisId', 'errorMessage' => 'The instance resource (%s) does not exist.', 'description' => '该资源(%s)不存在。'],
+ ['errorCode' => 'ResourceNotFound.NetworkReachableAnalysis', 'errorMessage' => 'The specified resource of %s is not found.', 'description' => '指定的网络路径分析ID %s不存在,可能已删除或者指定的ID错误。'],
+ ],
+ ],
+ 'title' => '获取网络可达性分析任务结果',
+ 'summary' => '调用GetNetworkReachableAnalysis接口,获取网络可达性分析结果。',
+ 'description' => '**GetNetworkReachableAnalysis**接口属于异步接口,即系统会返回一个任务ID,但该网络可达性分析结果尚未成功获取,系统后台的获取任务仍在进行。您可以查询网络可达性分析任务的状态: '."\n"
+ .'- 当网络可达性分析任务处于**init**状态时,表示网络可达性分析任务正在进行中。'."\n"
+ .'- 当网络可达性分析任务处于**finish**状态时,表示网络可达性分析任务已完成,即可获取结果。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNetworkReachableAnalysis'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'nis:GetNetworkReachableAnalysis',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkReachableAnalysis', 'arn' => 'acs:nis:*:{#accountId}:networkreachableanalysis/{#NetworkReachableAnalysisId}'],
+ ],
+ ],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NetworkPathId\\": \\"np-2a1332214fa346b6****\\",\\n \\"NetworkReachableAnalysisId\\": \\"nra-8607514e71c1484****\\",\\n \\"NetworkReachableAnalysisStatus\\": \\"finish\\",\\n \\"NetworkReachableAnalysisResult\\": \\"{\\\\n \\\\\\"errorCode\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"networkAclData\\\\\\": {\\\\n \\\\\\"networkAclItems\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nraId\\\\\\": \\\\\\"nra-f2c8701a36424094****\\\\\\",\\\\n \\\\\\"requestId\\\\\\": \\\\\\"B931F8A0-620E-5230-B77F-3BD7F612****\\\\\\",\\\\n \\\\\\"routeData\\\\\\": {\\\\n \\\\\\"routeItems\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"securityGroupData\\\\\\": {\\\\n \\\\\\"policy\\\\\\": \\\\\\"accept\\\\\\",\\\\n \\\\\\"securityGroupItems\\\\\\": [\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"default_sg_access_rule\\\\\\",\\\\n \\\\\\"matchedRule\\\\\\": {\\\\n \\\\\\"bizProtocol\\\\\\": \\\\\\"ALL\\\\\\",\\\\n \\\\\\"creatingTime\\\\\\": \\\\\\"2022-11-10T03:24:49Z\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"destinationCidr\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"destinationGroupId\\\\\\": \\\\\\"sg-wz980j96p8y99co5****\\\\\\",\\\\n \\\\\\"direction\\\\\\": \\\\\\"egress\\\\\\",\\\\n \\\\\\"policy\\\\\\": \\\\\\"Accept\\\\\\",\\\\n \\\\\\"portRange\\\\\\": \\\\\\"-1/-1\\\\\\",\\\\n \\\\\\"priority\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"sourceCidr\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sourceGroupId\\\\\\": \\\\\\"\\\\\\"\\\\n },\\\\n \\\\\\"policy\\\\\\": \\\\\\"accept\\\\\\",\\\\n \\\\\\"resourceId\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"securityGroupId\\\\\\": \\\\\\"sg-wz980j96p8y99co5****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"user_acl_drop_rule\\\\\\",\\\\n \\\\\\"matchedRule\\\\\\": {\\\\n \\\\\\"bizProtocol\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"creatingTime\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"destinationCidr\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"destinationGroupId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"direction\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"policy\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"portRange\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"priority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sourceCidr\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sourceGroupId\\\\\\": \\\\\\"\\\\\\"\\\\n },\\\\n \\\\\\"policy\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"resourceId\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"securityGroupId\\\\\\": \\\\\\"sg-wz980j96p8y99co****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"securityGroupReportId\\\\\\": \\\\\\"sgr-4479d23bb37241aab****\\\\\\"\\\\n },\\\\n \\\\\\"status\\\\\\": \\\\\\"security_group_checking_target\\\\\\",\\\\n \\\\\\"topologyData\\\\\\": {\\\\n \\\\\\"positive\\\\\\": {\\\\n \\\\\\"linkList\\\\\\": [\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp93zyv-->eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz92ce4saz1jzazgi13d-->vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrneebcrp-->eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz97vry93t6z4lbdgmfi-->i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"nodeList\\\\\\": [\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"level\\\\\\": 1,\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VM\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"level\\\\\\": 3,\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VM\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"cidr\\\\\\": \\\\\\"192.168.0.0/24\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"level\\\\\\": 2,\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VSW\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"192.168.0.33\\\\\\",\\\\n \\\\\\"mac\\\\\\": \\\\\\"00:XXXX:3e:16:7c:50\\\\\\",\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"ENI\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"status\\\\\\": \\\\\\"InUse\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"192.168.0.34\\\\\\",\\\\n \\\\\\"mac\\\\\\": \\\\\\"00:XXXX:3e:14:70:c2\\\\\\",\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"ENI\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"status\\\\\\": \\\\\\"InUse\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"reverse\\\\\\": {\\\\n \\\\\\"revLinkList\\\\\\": [\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp93zys-->eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz97vry93t6z4lbdgmfi-->vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrneebcrp-->eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz92ce4saz1jzazgi13d-->i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"revNodeList\\\\\\": [\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"level\\\\\\": 1,\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VM\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"level\\\\\\": 3,\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VM\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"cidr\\\\\\": \\\\\\"192.168.0.0/24\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"level\\\\\\": 2,\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VSW\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"192.168.0.34\\\\\\",\\\\n \\\\\\"mac\\\\\\": \\\\\\"00:XXXX:3e:14:70:c2\\\\\\",\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"ENI\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"status\\\\\\": \\\\\\"InUse\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"192.168.0.33\\\\\\",\\\\n \\\\\\"mac\\\\\\": \\\\\\"00:XXXX:3e:16:7c:50\\\\\\",\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"ENI\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"status\\\\\\": \\\\\\"InUse\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"topologyReportId\\\\\\": \\\\\\"tpr-21cf60002715491b8****\\\\\\"\\\\n }\\\\n}\\",\\n \\"Reachable\\": true,\\n \\"CreateTime\\": \\"2023-03-16T07:11:27Z\\",\\n \\"AliUid\\": 0,\\n \\"RequestId\\": \\"DEE0FEAF-59AE-5CDD-AA07-626BC365D571\\",\\n \\"NetworkPathParameter\\": \\"{\\\\n \\\\\\"sourceId\\\\\\": \\\\\\"i-bp100g5pbp6kj4p9****\\\\\\",\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"ecs\\\\\\",\\\\n \\\\\\"targetId\\\\\\": \\\\\\"i-t4n4ltwgbbomzb0g****\\\\\\",\\\\n \\\\\\"targetType\\\\\\": \\\\\\"ecs\\\\\\"\\\\n}\\"\\n}","type":"json"}]',
+ ],
+ 'GetNisNetworkMetrics' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '222161',
+ 'abilityTreeNodes' => ['FEATUREnetana5MCZ6K', 'FEATUREnetanaOV20CD', 'FEATUREnetanaB9LIVJ', 'FEATUREnetanaCEA895'],
+ ],
'parameters' => [
[
'name' => 'RegionNo',
'in' => 'query',
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen'],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
'schema' => [
- 'title' => '资源所在地域。',
- 'description' => '资源所在地域。',
+ 'title' => '按流量转发所使用的阿里云网络资源类型进行分析,已支持网络资源类型:'."\n"
+ .'AccessInternetIPV4:所有阿里云公网类型IPV4'."\n"
+ .'AccessInternetIPV4Limited:所有受地域限速的阿里云公网类型IPV4'."\n"
+ .'ElasticIP: 弹性公网EIP(IPV4)'."\n"
+ .'PublicIPEcs: 绑定在ECS的固定公网IP(IPV4)'."\n"
+ .'PublicIPClb: 绑定在CLB的固定公网IP(IPV4)'."\n"
+ .'NAT:通过SNAT的访问公网流量'."\n"
+ .'TR:流经云企业网转发路由器的流量'."\n"
+ .'TRAttachment:流经云企业网连接实例的流量,包括地域内连接和跨地域连接,地域内连接具备出入方向,跨地域连接仅具备出方向'."\n"
+ .'VBR:流经边界路由器的流量'."\n"
+ .'GA:流经全球加速的流量'."\n"
+ .'ECR:流经ECR的流量'."\n"
+ .'VPC:流经VPC的流量'."\n"
+ .'InternetProbing: 公网探测数据'."\n"
+ .'IntranetProbing: 内网探测数据',
+ 'description' => '按流量转发所使用的阿里云网络资源类型进行分析,取值:'."\n"
+ ."\n"
+ .'- AccessInternetIpV4:所有阿里云公网类型IPv4。'."\n"
+ .'- AccessInternetIpV4Limited:所有受地域限速的阿里云公网类型IPv4。'."\n"
+ .'- ElasticIP:弹性公网EIP(IPv4)。'."\n"
+ .'- PublicIpEcs:绑定在ECS的固定公网IP(IPv4)。'."\n"
+ .'- PublicIpClb:绑定在CLB的固定公网IP(IPv4)。'."\n"
+ .'- NAT:通过SNAT的访问公网流量。'."\n"
+ .'- TR:流经云企业网转发路由器的流量。'."\n"
+ .'- TRAttachment:流经云企业网连接实例的流量,包括地域内连接和跨地域连接,地域内连接具备出入方向,跨地域连接仅具备出方向。'."\n"
+ .'- VBR:流经边界路由器的流量。'."\n"
+ .'- GA:流经全球加速的流量。'."\n"
+ .'- InternetProbing:公网质量探测数据。'."\n"
+ .'- IntranetProbing:内网质量探测数据。'."\n"
+ .'- NisInspectionHistoryReportScore:巡检历史评分。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'AccessInternetIPV4',
+ 'enum' => ['AccessInternetIpV4', 'AccessInternetIpV4Limited', 'ElasticIP', 'PublicIpEcs', 'PublicIpClb', 'NAT', 'TR', 'TRAttachment', 'VBR', 'GA', 'InternetProbing', 'IntranetProbing', 'NisInspectionHistoryReportScore'],
+ ],
+ ],
+ [
+ 'name' => 'MetricName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '指标名。'."\n"
+ .'流量分析场景支持的公共参数:'."\n"
+ .' bps:每秒比特数。'."\n"
+ .' pps:每秒包数。'."\n"
+ .'公网场景特有参数:'."\n"
+ .' rtt:tcp协议建立连接时的往返延迟。'."\n"
+ .' RetransmitRate:重传率。'."\n"
+ .'区域级带宽场景特有参数:'."\n"
+ .' RatelimitDropPps:限速丢包速率。'."\n"
+ .' BandwidthUtilization:带宽利用率。'."\n"
+ .'NAT场景特有参数:'."\n"
+ .' ActiveSessionCount:并发会话数。'."\n"
+ .' NewSessionPerSecond:每秒新建会话数。',
+ 'description' => '指标名。取值:'."\n"
+ ."\n"
+ .'- bps:每秒比特数。'."\n"
+ .'- pps:每秒包数。'."\n"
+ .'- rtt:tcp协议建立连接时的往返延迟。'."\n"
+ .'- RetransmitRate:重传率。'."\n"
+ .'- RatelimitDropPps:限速丢包速率。'."\n"
+ .'- ActiveSessionCount:并发会话数。'."\n"
+ .'- NewSessionPerSecond:每秒新建会话数。'."\n"
+ .'- BandwidthUtilization:带宽利用率。'."\n"
+ .'- passRate:巡检通过率。'."\n"
+ .'> 选定时间范围内RTT无数据,是因为该时间段里,此连接是长连接,没有触发首次建连。',
'type' => 'string',
'required' => true,
- 'example' => 'cn-beijing',
+ 'example' => 'bps',
+ 'enum' => ['rtt', 'bps', 'pps', 'RetransmitRate', 'ActiveSessionCount', 'NewSessionPerSecond', 'RatelimitDropPps', 'passRate', 'BandwidthUtilization'],
+ ],
+ ],
+ [
+ 'name' => 'Dimensions',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '具体业务的Metric查询参数。各场景参数说明详见xxx部分。',
+ 'description' => '具体业务的Metric查询参数集合。各场景参数说明,请参见[GetNisNetworkMetrics](~~2833348~~)。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '具体业务的Metric查询参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '过滤条件的名字。', 'type' => 'string', 'required' => false, 'example' => 'instanceId'],
+ 'Value' => ['description' => '过滤条件的值。', 'type' => 'string', 'required' => false, 'example' => 'eip-sample*'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'example' => 'bps',
+ ],
+ ],
+ [
+ 'name' => 'BeginTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '起始时间戳,单位毫秒。未指定时默认查最近1小时。', 'description' => '起始时间,单位**ms**,格式**unix**时间戳。未指定时默认查最近1小时。起始时间最早可选择7天前。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '253402271999000', 'minimum' => '0', 'example' => '1638239092000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束时间戳,单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的一小时。', 'description' => '结束时间,单位**ms**,格式**unix**时间戳。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的一小时。结束时间距起始时间最多24小时。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '253402271999000', 'minimum' => '0', 'example' => '1684373700099'],
+ ],
+ [
+ 'name' => 'ScanBy',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '排序方式,'."\n"
+ .'TimestampAscending:按时间正向排序。'."\n"
+ .'TimestampDescending:按时间逆向排序。',
+ 'description' => '排序方式,默认TimestampAscending,取值:'."\n"
+ ."\n"
+ .'- TimestampAscending:按时间正向排序。'."\n"
+ .'- TimestampDescending:按时间逆向排序。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TimestampAscending',
+ 'default' => 'TimestampAscending',
+ 'enum' => ['TimestampAscending', 'TimestampDescending'],
+ ],
+ ],
+ [
+ 'name' => 'UseCrossAccount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否使用多账号访问模式', 'description' => '是否使用多账号访问模式,保留参数,暂不支持。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'AccountIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '显式传递子账号ID',
+ 'description' => '显式传递子账号ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '成员账号ID列表。', 'type' => 'string', 'required' => false, 'example' => '118639953821****'],
+ 'required' => false,
+ 'maxItems' => 10,
],
],
[
+ 'name' => 'StepMinutes',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>',
+ 'description' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B'],
+ 'Data' => [
+ 'description' => '云网络指标趋势数据对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Unit' => ['description' => '单位。', 'type' => 'string', 'example' => 'Bits/Second'],
+ 'Metrics' => [
+ 'description' => '指标趋势数据集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '指标趋势单时间点数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TimeStamp' => ['description' => '数据的毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1690684091100'],
+ 'Value' => ['description' => '指标值。', 'type' => 'number', 'format' => 'double', 'example' => '88'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime', 'errorMessage' => 'It only supports querying data for up to 24 hours: %s.', 'description' => '最大支持查询24小时数据。'],
+ ['errorCode' => 'OperationFailed.DataTooMuch', 'errorMessage' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.', 'description' => '指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。'],
+ ['errorCode' => 'IllegalParam.Dimensions', 'errorMessage' => 'The specified Dimensions(%s) is illegal.', 'description' => '指定的Dimensions(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.Dimensions.Direction', 'errorMessage' => 'The specified Dimensions.Direction(%s) is illegal.', 'description' => '指定的Dimensions.Direction(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.Dimensions.InstanceId', 'errorMessage' => 'The specified Dimensions.InstanceId(%s) is illegal.', 'description' => '指定的Dimensions.InstanceId(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.MetricName', 'errorMessage' => 'The specified MetricName(%s) is illegal.', 'description' => '指定的MetricName(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.ResourceType', 'errorMessage' => 'The specified resourceType (%s) is invalid.', 'description' => '指定的ResourceType变量值(%s)不存在。'],
+ ['errorCode' => 'IllegalParam.Dimensions.DestinationZone', 'errorMessage' => 'The specified parameter Dimensions.DestinationZone (%s) is illegal.', 'description' => '指定的参数Dimensions.DestinationZone(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.Dimensions.SourceZone', 'errorMessage' => 'The specified parameter Dimensions.SourceZone(%s) is illegal.', 'description' => '指定的参数Dimensions.SourceZone(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.IP', 'errorMessage' => 'The specified IP address (%s) is invalid.', 'description' => '指定的IP地址(%s)无效。'],
+ ['errorCode' => 'IllegalParam.RegionNo', 'errorMessage' => 'The specified parameter RegionNo(%s) is illegal.', 'description' => '指定的参数RegionNo(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.Dimensions.InspectionTaskId', 'errorMessage' => 'The specified argument Dimensions.InspectionTaskId(%s) is illegal.', 'description' => '指定的参数Dimensions.InspectionTaskId(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.Dimensions.DestinationRegionNo', 'errorMessage' => 'The specified parameter Dimensions.DestinationRegionNo(%s) is illegal.', 'description' => '指定的Dimensions.DestinationRegionNo(%s)参数非法。'],
+ ['errorCode' => 'IllegalParam.StepMinutes', 'errorMessage' => 'The specified StepMinutes parameter value is illegal, only %s minutes of data precision is supported.', 'description' => '指定的StepMinutes参数值不合法,仅支持%s分钟的数据精度。'],
+ ['errorCode' => 'IllegalParam.MaxTimeScope', 'errorMessage' => 'The query time range exceeds the limit. You can query up to %s days of data.', 'description' => '查询时间范围超出限制,最大支持查询%s天的数据。'],
+ ['errorCode' => 'IllegalParam.StepMinutesAndTime', 'errorMessage' => 'In the current query time range, data precision of only %s minutes is supported to ensure performance.', 'description' => '当前查询时间范围下,为保证性能,仅支持%s分钟的数据精度。'],
+ ['errorCode' => 'UnsupportedRegion', 'errorMessage' => 'This feature is not supported in the current region.', 'description' => ''],
+ ['errorCode' => 'IllegalParam.SourceRegions', 'errorMessage' => 'SourceRegions Can be wrong.', 'description' => 'Region 参数有误。请确认输入的 Region 数量是否有误(> 1),或输入了错误的 RegionId'],
+ ],
+ 404 => [
+ ['errorCode' => 'ResourceNotFound.InstanceId', 'errorMessage' => 'The specified InstanceId(%s) does not exist.', 'description' => '指定的InstanceId(%s)不存在。'],
+ ['errorCode' => 'ResourceNotFound.IpSets', 'errorMessage' => 'The specified instance does not exist or does not have any acceleration region.', 'description' => '指定的实例不存在或者没有加速区域。'],
+ ['errorCode' => 'ResourceNotFound.InspectionTaskId', 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.', 'description' => '指定的InspectionTaskId(%s)不存在。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取云网络指标趋势',
+ 'summary' => '支持指定NIS网络分析场景,获取详细监控指标趋势数据,包括流量分析场景下的流量指标趋势数据,以及性能观测场景下的性能指标趋势数据等。',
+ 'description' => '数据查询结果同步说明:'."\n"
+ ."\n"
+ .'- API数据跨度6小时同步一次,6小时后才可查询当前网络分析数据。'."\n"
+ ."\n"
+ .'支持分析场景: '."\n"
+ .'- 公网性能观测大盘场景'."\n"
+ .'- 跨可用区内网性能观测大盘场景'."\n"
+ .'- 跨地域内网性能观测大盘场景'."\n"
+ ."\n\n"
+ .'## 公网性能观测大盘场景'."\n"
+ ."\n"
+ .'**说明**'."\n"
+ ."\n"
+ .'支持最大查询时间跨度为24小时,不指定时默认查询最近1小时,查询的数据结果为1分钟1条。'."\n"
+ ."\n"
+ .'### **请求参数**'."\n"
+ ."\n"
+ .'| **名称** | **类型** | **必填** | **描述** |'."\n"
+ .'| --- | --- | --- | --- |'."\n"
+ .'| RegionNo | string | 是 | 探测源所在阿里云地域。 |'."\n"
+ .'| ResourceType | string | 是 | 固定选择**InternetProbing**,表示查询公网性能监控趋势。 |'."\n"
+ .'| MetricName | string | 是 | 指定查询趋势的指标,取值:**rtt**,探测的往返延迟。 |'."\n"
+ .'| Dimensions | object\\[\\] | 是 | 过滤信息。 |'."\n"
+ .'| \\-Name | string | 是 | 过滤条件,取值:<br> - **Country**:探测的国家。<br> - **Province**:探测的省份<br> - **Isp**:探测的运营商。<br> **说明:** 以上参数至少配置其中一个。 |'."\n"
+ .'| \\-Value | string | 是 | 过滤条件对应的过滤值,示例如下:<br> - Country:China<br> - Province:Zhejiang <br>- Isp:阿里巴巴 <br>**说明:** 国家,省份格式为首字母大写,运营商参数与控制台显示名称一致即可。 |'."\n"
+ ."\n"
+ .'### **返回参数**'."\n"
+ ."\n"
+ .'| **名称** | **类型** | **描述** |'."\n"
+ .'| --- | --- | --- |'."\n"
+ .'| RequestId | string | 请求ID。 |'."\n"
+ .'| Data | object | 云网络指标趋势数据对象 |'."\n"
+ .'| Metrics | array | 指标趋势数据集合 |'."\n"
+ .'| \\-TimeStamp | long | 毫秒时间戳。 |'."\n"
+ .'| \\-Value | double | 入参**MetricName**对应的指标值。 |'."\n"
+ .'| Unit | String | 表示**Value**的单位。 |'."\n"
+ ."\n"
+ .'## 跨可用区内网性能观测大盘场景'."\n"
+ ."\n"
+ .'**说明**'."\n"
+ ."\n"
+ .'- 查询时间长度超过5天时,查询数据结果为1天1条。'."\n"
+ .' '."\n"
+ .'- 查询时间长度超过1天时,查询数据结果为1小时1条。'."\n"
+ .' '."\n"
+ .'- 查询时间长度小于1天时,查询数据结果为5分钟1条。'."\n"
+ .' '."\n"
+ ."\n"
+ .'### **请求参数**'."\n"
+ ."\n"
+ .'| **名称** | **类型** | **必填** | **描述** |'."\n"
+ .'| --- | --- | --- | --- |'."\n"
+ .'| RegionNo | string | 是 | 阿里云地域。 |'."\n"
+ .'| ResourceType | string | 是 | 固定选择**IntranetProbing**,表示查询跨可用区性能监控趋势。 |'."\n"
+ .'| MetricName | string | 是 | 指定查询趋势的指标,取值:**rtt**,探测的往返延迟。 |'."\n"
+ .'| Dimensions | object\\[\\] | 是 | 过滤信息。 |'."\n"
+ .'| \\-Name | string | 是 | 过滤条件,取值:<br> - **SourceZone**:探测的源可用区,必须指定。<br> - **DestinationZone**:探测的目的可用区,必须指定。 |'."\n"
+ .'| \\-Value | string | 是 | 过滤条件对应的过滤值,示例如下:<br> - SourceZone:cn-hangzhou-j<br> - DestinationZone:cn-hangzhou-k |'."\n"
+ ."\n"
+ .'### **返回参数**'."\n"
+ ."\n"
+ .'| **名称** | **类型** | **描述** |'."\n"
+ .'| --- | --- | --- |'."\n"
+ .'| RequestId | string | 请求ID。 |'."\n"
+ .'| Data | object | 云网络指标趋势数据对象 |'."\n"
+ .'| Metrics | array | 指标趋势数据集合 |'."\n"
+ .'| \\-TimeStamp | long | 毫秒时间戳。 |'."\n"
+ .'| \\-Value | double | 入参**MetricName**对应的指标值。 |'."\n"
+ .'| Unit | String | 表示**Value**的单位。 |'."\n"
+ ."\n"
+ .'## **跨地域内网性能观测大盘场景**'."\n"
+ ."\n"
+ .'**说明**'."\n"
+ ."\n"
+ .'- 查询时间长度超过5天时,查询数据结果为1天1条。'."\n"
+ .' '."\n"
+ .'- 查询时间长度超过1天时,查询数据结果为1小时1条。'."\n"
+ .' '."\n"
+ .'- 查询时间长度小于1天时,查询数据结果为5分钟1条。'."\n"
+ .' '."\n"
+ ."\n"
+ .'### **请求参数**'."\n"
+ ."\n"
+ .'| **名称** | **类型** | **必填** | **描述** |'."\n"
+ .'| --- | --- | --- | --- |'."\n"
+ .'| RegionNo | string | 是 | 阿里云地域。 |'."\n"
+ .'| ResourceType | string | 是 | 固定选择**IntranetProbing**,表示查询跨地域性能观测排名。 |'."\n"
+ .'| Direction | string | 是 | 探测方向,取值:<br> - **in**:以RegionNo为目的的探测。<br> - **out**:以RegionNo为源的探测。 |'."\n"
+ .'| MetricName | string | 是 | 指定查询趋势的指标,取值:**rtt**,探测的往返延迟。 |'."\n"
+ .'| Dimensions | object\\[\\] | 否 | 过滤信息。 |'."\n"
+ .'| \\-Name | string | 否 | 过滤条件,取值:**DestinationRegionNo**,探测的目的地域,该参数必须指定。 |'."\n"
+ .'| \\-Value | string | 否 | 目的地域ID,示例如下: DestinationRegionNo:cn-shenzhen |'."\n"
+ ."\n"
+ .'### **返回参数**'."\n"
+ ."\n"
+ .'| **名称** | **类型** | **描述** |'."\n"
+ .'| --- | --- | --- |'."\n"
+ .'| RequestId | string | 请求ID。 |'."\n"
+ .'| Data | object | 云网络指标趋势数据对象 |'."\n"
+ .'| Metrics | array | 指标趋势数据集合 |'."\n"
+ .'| \\-TimeStamp | long | 毫秒时间戳。 |'."\n"
+ .'| \\-Value | double | 入参**MetricName**对应的指标值。 |'."\n"
+ .'| Unit | String | 表示**Value**的单位。 |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNisNetworkMetrics'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'nis:GetNisNetworkMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"Data\\": {\\n \\"Unit\\": \\"Bits/Second\\",\\n \\"Metrics\\": [\\n {\\n \\"TimeStamp\\": 1690684091100,\\n \\"Value\\": 88\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetNisNetworkRanking' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '222984',
+ 'abilityTreeNodes' => ['FEATUREnetana5MCZ6K', 'FEATUREnetanaOV20CD', 'FEATUREnetanaB9LIVJ', 'FEATUREnetanaCEA895'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionNo',
+ 'in' => 'query',
+ 'schema' => ['title' => '资源所在地域。', 'description' => '资源所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
+ ],
+ [
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
@@ -1997,20 +3279,7 @@
'type' => 'string',
'required' => true,
'example' => 'AccessInternetIpV4',
- 'enum' => [
- 'AccessInternetIpV4',
- 'AccessInternetIpV4Limited',
- 'ElasticIP',
- 'PublicIpEcs',
- 'PublicIpClb',
- 'NAT',
- 'TR',
- 'TRAttachment',
- 'VBR',
- 'GA',
- 'InternetProbing',
- 'IntranetProbing',
- ],
+ 'enum' => ['AccessInternetIpV4', 'AccessInternetIpV4Limited', 'ElasticIP', 'PublicIpEcs', 'PublicIpClb', 'NAT', 'TR', 'TRAttachment', 'VBR', 'GA', 'InternetProbing', 'IntranetProbing'],
],
],
[
@@ -2032,10 +3301,7 @@
'type' => 'string',
'required' => true,
'example' => 'in',
- 'enum' => [
- 'in',
- 'out',
- ],
+ 'enum' => ['in', 'out'],
],
],
[
@@ -2100,26 +3366,7 @@
'type' => 'string',
'required' => true,
'example' => 'Protocol',
- 'enum' => [
- 'Tuple1',
- 'Tuple2',
- 'Tuple5',
- 'Protocol',
- 'SourcePort',
- 'DestinationPort',
- 'Country',
- 'City',
- 'ASN',
- 'CityASN',
- 'RegionPair',
- 'InstanceId',
- 'CountryIsp',
- 'ZonePair',
- 'ISP',
- 'IpPair',
- 'Province',
- 'ProvinceIsp',
- ],
+ 'enum' => ['Tuple1', 'Tuple2', 'Tuple5', 'Protocol', 'SourcePort', 'DestinationPort', 'Country', 'City', 'ASN', 'CityASN', 'RegionPair', 'InstanceId', 'CountryIsp', 'ZonePair', 'ISP', 'IpPair', 'Province', 'ProvinceIsp'],
],
],
[
@@ -2153,17 +3400,7 @@
'type' => 'string',
'required' => true,
'example' => 'bps',
- 'enum' => [
- 'rtt',
- 'bps',
- 'pps',
- 'RetransmitRate',
- 'ActiveSessionCount',
- 'NewSessionPerSecond',
- 'RatelimitDropPps',
- 'ByteCount',
- 'PacketCount',
- ],
+ 'enum' => ['rtt', 'bps', 'pps', 'RetransmitRate', 'ActiveSessionCount', 'NewSessionPerSecond', 'RatelimitDropPps', 'ByteCount', 'PacketCount'],
],
],
[
@@ -2178,18 +3415,8 @@
'description' => '查询资源时的筛选条件列表。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '过滤条件的名字。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'instanceId',
- ],
- 'Value' => [
- 'description' => '过滤条件的值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'lb-2zxxxxz1d',
- ],
+ 'Name' => ['description' => '过滤条件的名字。', 'type' => 'string', 'required' => false, 'example' => 'instanceId'],
+ 'Value' => ['description' => '过滤条件的值。', 'type' => 'string', 'required' => false, 'example' => 'lb-2zxxxxz1d'],
],
'required' => false,
],
@@ -2199,30 +3426,12 @@
[
'name' => 'BeginTime',
'in' => 'query',
- 'schema' => [
- 'title' => '起始时间戳,单位毫秒。未指定时默认查最近1小时。',
- 'description' => '起始时间戳,单位**ms**。未指定时默认查最近1小时。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '253402271999000',
- 'minimum' => '0',
- 'example' => '1684373600099',
- ],
+ 'schema' => ['title' => '起始时间戳,单位毫秒。未指定时默认查最近1小时。', 'description' => '起始时间戳,单位**ms**。未指定时默认查最近1小时。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '253402271999000', 'minimum' => '0', 'example' => '1684373600099'],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'title' => '结束时间戳,单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。',
- 'description' => '结束时间戳,单位**ms**。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '253402271999000',
- 'minimum' => '0',
- 'example' => '1684379093000',
- ],
+ 'schema' => ['title' => '结束时间戳,单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。', 'description' => '结束时间戳,单位**ms**。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '253402271999000', 'minimum' => '0', 'example' => '1684379093000'],
],
[
'name' => 'Sort',
@@ -2239,38 +3448,18 @@
'required' => false,
'example' => 'desc',
'default' => 'desc',
- 'enum' => [
- 'asc',
- 'desc',
- ],
+ 'enum' => ['asc', 'desc'],
],
],
[
'name' => 'TopN',
'in' => 'query',
- 'schema' => [
- 'title' => '展示排序靠前的数据。默认值:10。表示默认展示排序前 10 的数据。最大值:100。',
- 'description' => '展示排序靠前的数据。默认值:**10**。表示默认展示排序前 10 的数据。最大值:**100**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '展示排序靠前的数据。默认值:10。表示默认展示排序前 10 的数据。最大值:100。', 'description' => '展示排序靠前的数据。默认值:**10**。表示默认展示排序前 10 的数据。最大值:**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'UseCrossAccount',
'in' => 'query',
- 'schema' => [
- 'title' => '是否使用多账号访问模式',
- 'description' => '是否使用多账号访问模式,保留参数,目前不支持。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['title' => '是否使用多账号访问模式', 'description' => '是否使用多账号访问模式,保留参数,目前不支持。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'AccountIds',
@@ -2280,12 +3469,7 @@
'title' => '显式传递子账号ID',
'description' => '显式传递子账号ID。',
'type' => 'array',
- 'items' => [
- 'description' => '成员账号ID列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '118639953821****',
- ],
+ 'items' => ['description' => '成员账号ID列表。', 'type' => 'string', 'required' => false, 'example' => '118639953821****'],
'required' => false,
'maxItems' => 10,
],
@@ -2298,11 +3482,7 @@
'description' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
'Data' => [
'description' => '云网络指标排名数据集合。',
'type' => 'array',
@@ -2310,192 +3490,37 @@
'description' => '云网络指标排名单行数据。',
'type' => 'object',
'properties' => [
- 'RegionNo' => [
- 'title' => '阿里云地域ID。',
- 'description' => '阿里云地域ID。',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
- 'InstanceId' => [
- 'title' => '各场景下表示对应的云上资源实例ID,如跨域流量分析场景表示CenID,公网场景表示EipId、EcsId、ClbId等。',
- 'description' => '各场景下表示对应的云上资源实例ID,如跨域流量分析场景表示CenID,公网场景表示EipId、EcsId、ClbId等。',
- 'type' => 'string',
- 'example' => 'eip-sample*',
- ],
- 'BandwidthPackageId' => [
- 'title' => '带宽包实例ID。',
- 'description' => '带宽包实例ID。',
- 'type' => 'string',
- 'example' => 'cbwp-sample*',
- ],
- 'SourceIp' => [
- 'title' => '源端IP。',
- 'description' => '源端IP。',
- 'type' => 'string',
- 'example' => '42.120.XX.XX',
- ],
- 'SourcePort' => [
- 'title' => '源端端口。',
- 'description' => '源端端口。',
- 'type' => 'string',
- 'example' => '443',
- ],
- 'SourceIsp' => [
- 'title' => '源端运营商。',
- 'description' => '源端运营商。',
- 'type' => 'string',
- 'example' => '移动',
- ],
- 'DestinationIp' => [
- 'title' => '目的端IP。',
- 'description' => '目的端IP。',
- 'type' => 'string',
- 'example' => '2.2.XX.XX',
- ],
- 'DestinationPort' => [
- 'title' => '目的端端口。',
- 'description' => '目的端端口。',
- 'type' => 'string',
- 'example' => '80',
- ],
- 'DestinationIsp' => [
- 'title' => '目的端运营商。',
- 'description' => '目的端运营商。',
- 'type' => 'string',
- 'example' => '阿里云',
- ],
- 'Protocol' => [
- 'title' => '网络协议。',
- 'description' => '网络协议。',
- 'type' => 'string',
- 'example' => '6',
- ],
- 'Country' => [
- 'title' => '客户端所在国家。',
- 'description' => '客户端所在国家。',
- 'type' => 'string',
- 'example' => '中国',
- ],
- 'Province' => [
- 'title' => '客户端所在省份/州。',
- 'description' => '客户端所在省份/州。',
- 'type' => 'string',
- 'example' => '四川省',
- ],
- 'City' => [
- 'title' => '客户端所在的城市。',
- 'description' => '客户端所在的城市。',
- 'type' => 'string',
- 'example' => '成都市',
- ],
- 'Isp' => [
- 'title' => '客户端运营商。',
- 'description' => '客户端运营商。',
- 'type' => 'string',
- 'example' => '移动',
- ],
- 'Asn' => [
- 'title' => '客户端运营商的自治系统编号。',
- 'description' => '客户端运营商的自治系统编号。',
- 'type' => 'string',
- 'example' => '129103',
- ],
- 'IP' => [
- 'title' => 'IP地址。',
- 'description' => 'IP地址。',
- 'type' => 'string',
- 'example' => '120.238.XX.XX',
- ],
- 'DestinationRegionNo' => [
- 'title' => '目的端地域ID。',
- 'description' => '目的端地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'VbrId' => [
- 'title' => '边界路由器实例ID。',
- 'description' => '边界路由器实例ID。',
- 'type' => 'string',
- 'example' => 'vbr-sample*',
- ],
- 'AttachmentId' => [
- 'title' => '转发路由器链接ID。',
- 'description' => '转发路由器链接ID。',
- 'type' => 'string',
- 'example' => 'tr-sample*',
- ],
- 'SourceZone' => [
- 'title' => '探测的源可用区。',
- 'description' => '探测的源可用区。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-a',
- ],
- 'DestinationZone' => [
- 'title' => '探测的目的可用区。',
- 'description' => '探测的目的可用区。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-b',
- ],
- 'ByteCount' => [
- 'description' => '流量数(Byte)。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1024',
- ],
- 'PacketCount' => [
- 'description' => '流量包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '66',
- ],
- 'RTT' => [
- 'description' => '延迟,单位**ms**。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '23',
- ],
- 'RetransmitRate' => [
- 'description' => 'TCP报文的重传率。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.1',
- ],
- 'InBps' => [
- 'description' => '入方向带宽,单位:bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '10',
- ],
- 'InPps' => [
- 'description' => '入方向包速率。单位:个/秒。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '3',
- ],
- 'OutBps' => [
- 'description' => '出方向带宽,单位:bps。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '88',
- ],
- 'OutPps' => [
- 'description' => '出方向包速率。单位:个/秒。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '8',
- ],
- 'NewSessionPerSecond' => [
- 'description' => '新建连接数。单位:个/秒。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '18',
- ],
- 'ActiveSessionCount' => [
- 'description' => '并发连接数。单位:个。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '66',
- ],
+ 'RegionNo' => ['title' => '阿里云地域ID。', 'description' => '阿里云地域ID。', 'type' => 'string', 'example' => 'cn-shenzhen'],
+ 'InstanceId' => ['title' => '各场景下表示对应的云上资源实例ID,如跨域流量分析场景表示CenID,公网场景表示EipId、EcsId、ClbId等。', 'description' => '各场景下表示对应的云上资源实例ID,如跨域流量分析场景表示CenID,公网场景表示EipId、EcsId、ClbId等。', 'type' => 'string', 'example' => 'eip-sample*'],
+ 'BandwidthPackageId' => ['title' => '带宽包实例ID。', 'description' => '带宽包实例ID。', 'type' => 'string', 'example' => 'cbwp-sample*'],
+ 'SourceIp' => ['title' => '源端IP。', 'description' => '源端IP。', 'type' => 'string', 'example' => '42.120.XX.XX'],
+ 'SourcePort' => ['title' => '源端端口。', 'description' => '源端端口。', 'type' => 'string', 'example' => '443'],
+ 'SourceIsp' => ['title' => '源端运营商。', 'description' => '源端运营商。', 'type' => 'string', 'example' => '移动'],
+ 'DestinationIp' => ['title' => '目的端IP。', 'description' => '目的端IP。', 'type' => 'string', 'example' => '2.2.XX.XX'],
+ 'DestinationPort' => ['title' => '目的端端口。', 'description' => '目的端端口。', 'type' => 'string', 'example' => '80'],
+ 'DestinationIsp' => ['title' => '目的端运营商。', 'description' => '目的端运营商。', 'type' => 'string', 'example' => '阿里云'],
+ 'Protocol' => ['title' => '网络协议。', 'description' => '网络协议。', 'type' => 'string', 'example' => '6'],
+ 'Country' => ['title' => '客户端所在国家。', 'description' => '客户端所在国家。', 'type' => 'string', 'example' => '中国'],
+ 'Province' => ['title' => '客户端所在省份/州。', 'description' => '客户端所在省份/州。', 'type' => 'string', 'example' => '四川省'],
+ 'City' => ['title' => '客户端所在的城市。', 'description' => '客户端所在的城市。', 'type' => 'string', 'example' => '成都市'],
+ 'Isp' => ['title' => '客户端运营商。', 'description' => '客户端运营商。', 'type' => 'string', 'example' => '移动'],
+ 'Asn' => ['title' => '客户端运营商的自治系统编号。', 'description' => '客户端运营商的自治系统编号。', 'type' => 'string', 'example' => '129103'],
+ 'IP' => ['title' => 'IP地址。', 'description' => 'IP地址。', 'type' => 'string', 'example' => '120.238.XX.XX'],
+ 'DestinationRegionNo' => ['title' => '目的端地域ID。', 'description' => '目的端地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'VbrId' => ['title' => '边界路由器实例ID。', 'description' => '边界路由器实例ID。', 'type' => 'string', 'example' => 'vbr-sample*'],
+ 'AttachmentId' => ['title' => '转发路由器链接ID。', 'description' => '转发路由器链接ID。', 'type' => 'string', 'example' => 'tr-sample*'],
+ 'SourceZone' => ['title' => '探测的源可用区。', 'description' => '探测的源可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-a'],
+ 'DestinationZone' => ['title' => '探测的目的可用区。', 'description' => '探测的目的可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-b'],
+ 'ByteCount' => ['description' => '流量数(Byte)。', 'type' => 'number', 'format' => 'double', 'example' => '1024'],
+ 'PacketCount' => ['description' => '流量包数。', 'type' => 'number', 'format' => 'double', 'example' => '66'],
+ 'RTT' => ['description' => '延迟,单位**ms**。', 'type' => 'number', 'format' => 'double', 'example' => '23'],
+ 'RetransmitRate' => ['description' => 'TCP报文的重传率。', 'type' => 'number', 'format' => 'double', 'example' => '0.1'],
+ 'InBps' => ['description' => '入方向带宽,单位:bps。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
+ 'InPps' => ['description' => '入方向包速率。单位:个/秒。', 'type' => 'number', 'format' => 'double', 'example' => '3'],
+ 'OutBps' => ['description' => '出方向带宽,单位:bps。', 'type' => 'number', 'format' => 'double', 'example' => '88'],
+ 'OutPps' => ['description' => '出方向包速率。单位:个/秒。', 'type' => 'number', 'format' => 'double', 'example' => '8'],
+ 'NewSessionPerSecond' => ['description' => '新建连接数。单位:个/秒。', 'type' => 'number', 'format' => 'double', 'example' => '18'],
+ 'ActiveSessionCount' => ['description' => '并发连接数。单位:个。', 'type' => 'number', 'format' => 'double', 'example' => '66'],
],
],
],
@@ -2505,59 +3530,26 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime',
- 'errorMessage' => 'It only supports querying data for up to 24 hours: %s.',
- ],
- [
- 'errorCode' => 'OperationFailed.DataTooMuch',
- 'errorMessage' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.',
- ],
- [
- 'errorCode' => 'IllegalParam.OrderBy',
- 'errorMessage' => 'The specified param of orderBy (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.ResourceType',
- 'errorMessage' => 'The specified resourceType (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.GroupBy',
- 'errorMessage' => 'The specified param of GroupBy (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.Direction',
- 'errorMessage' => 'The specified direction (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.Filter.InstanceId',
- 'errorMessage' => 'The specified InstanceId(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime5M',
- 'errorMessage' => 'It only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.',
- ],
- [
- 'errorCode' => 'IllegalParam.ServiceOffline',
- 'errorMessage' => 'The service has been taken offline.',
- ],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime', 'errorMessage' => 'It only supports querying data for up to 24 hours: %s.', 'description' => '最大支持查询24小时数据。'],
+ ['errorCode' => 'OperationFailed.DataTooMuch', 'errorMessage' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.', 'description' => '指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。'],
+ ['errorCode' => 'IllegalParam.OrderBy', 'errorMessage' => 'The specified param of orderBy (%s) is invalid.', 'description' => '指定的排序字段(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.ResourceType', 'errorMessage' => 'The specified resourceType (%s) is invalid.', 'description' => '指定的ResourceType变量值(%s)不存在。'],
+ ['errorCode' => 'IllegalParam.GroupBy', 'errorMessage' => 'The specified param of GroupBy (%s) is invalid.', 'description' => '指定的分组字段(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.Direction', 'errorMessage' => 'The specified direction (%s) is invalid.', 'description' => '指定的Direction参数不合法,请修改。'],
+ ['errorCode' => 'IllegalParam.Filter.InstanceId', 'errorMessage' => 'The specified InstanceId(%s) is illegal.', 'description' => '指定的InstanceId(%s)参数非法。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime5M', 'errorMessage' => 'It only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.', 'description' => '当TupleType=5且CloudIp、OtherIp都是空时,只支持查询最长5分钟范围的数据。'],
+ ['errorCode' => 'IllegalParam.ServiceOffline', 'errorMessage' => 'The service has been taken offline.', 'description' => '该服务已下线。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime1H', 'errorMessage' => 'It only supports querying data for up to 1 hour: %s.', 'description' => '最长支持查询1小时数据: %s。'],
+ ['errorCode' => 'IllegalParam.RegionNo', 'errorMessage' => 'The specified parameter RegionNo(%s) is illegal.', 'description' => '指定的参数RegionNo(%s)不合法。'],
],
404 => [
- [
- 'errorCode' => 'ResourceNotFound.InstanceId',
- 'errorMessage' => 'The specified InstanceId(%s) does not exist.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.IpSets',
- 'errorMessage' => 'The specified instance does not exist or does not have any acceleration region.',
- ],
+ ['errorCode' => 'ResourceNotFound.InstanceId', 'errorMessage' => 'The specified InstanceId(%s) does not exist.', 'description' => '指定的InstanceId(%s)不存在。'],
+ ['errorCode' => 'ResourceNotFound.IpSets', 'errorMessage' => 'The specified instance does not exist or does not have any acceleration region.', 'description' => '指定的实例不存在或者没有加速区域。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"Data\\": [\\n {\\n \\"RegionNo\\": \\"cn-shenzhen\\",\\n \\"InstanceId\\": \\"eip-sample*\\",\\n \\"BandwidthPackageId\\": \\"cbwp-sample*\\",\\n \\"SourceIp\\": \\"42.120.XX.XX\\",\\n \\"SourcePort\\": \\"443\\",\\n \\"SourceIsp\\": \\"移动\\",\\n \\"DestinationIp\\": \\"2.2.XX.XX\\",\\n \\"DestinationPort\\": \\"80\\",\\n \\"DestinationIsp\\": \\"阿里云\\",\\n \\"Protocol\\": \\"6\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"四川省\\",\\n \\"City\\": \\"成都市\\",\\n \\"Isp\\": \\"移动\\",\\n \\"Asn\\": \\"129103\\",\\n \\"IP\\": \\"120.238.XX.XX\\",\\n \\"DestinationRegionNo\\": \\"cn-hangzhou\\",\\n \\"VbrId\\": \\"vbr-sample*\\",\\n \\"AttachmentId\\": \\"tr-sample*\\",\\n \\"SourceZone\\": \\"cn-hangzhou-a\\",\\n \\"DestinationZone\\": \\"cn-hangzhou-b\\",\\n \\"ByteCount\\": 1024,\\n \\"PacketCount\\": 66,\\n \\"RTT\\": 23,\\n \\"RetransmitRate\\": 0.1,\\n \\"InBps\\": 10,\\n \\"InPps\\": 3,\\n \\"OutBps\\": 88,\\n \\"OutPps\\": 8,\\n \\"NewSessionPerSecond\\": 18,\\n \\"ActiveSessionCount\\": 66\\n }\\n ]\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取云网络指标排名',
+ 'summary' => '支持通过排序算法和数据处理能力,对流经不同云网络资源的流量进行排名分析,以及对阿里云性能观测的探测指标进行排序,帮助您快速识别网络瓶颈、优化资源配置和提升整体网络效能。',
'description' => '支持分析场景: '."\n"
.'- 公网性能观测大盘场景'."\n"
."\n"
@@ -2653,17 +3645,30 @@
.'| RegionNo | string | 探测的源地域。 |'."\n"
.'| DestinationRegionNo | string | 探测的目的地域。 |'."\n"
.'| RTT | double | 探测的往返延迟,单位ms。 |',
- ],
- 'GetInternetTuple' => [
- 'summary' => '调用GetInternetTuple接口,获取公网流量详情数据排名,覆盖一元组、二元组、五元组粒度,支持按流量、包数等指标排序。',
- 'methods' => [
- 'get',
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNisNetworkRanking'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'nis:GetNisNetworkRanking',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"Data\\": [\\n {\\n \\"RegionNo\\": \\"cn-shenzhen\\",\\n \\"InstanceId\\": \\"eip-sample*\\",\\n \\"BandwidthPackageId\\": \\"cbwp-sample*\\",\\n \\"SourceIp\\": \\"42.120.XX.XX\\",\\n \\"SourcePort\\": \\"443\\",\\n \\"SourceIsp\\": \\"移动\\",\\n \\"DestinationIp\\": \\"2.2.XX.XX\\",\\n \\"DestinationPort\\": \\"80\\",\\n \\"DestinationIsp\\": \\"阿里云\\",\\n \\"Protocol\\": \\"6\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"四川省\\",\\n \\"City\\": \\"成都市\\",\\n \\"Isp\\": \\"移动\\",\\n \\"Asn\\": \\"129103\\",\\n \\"IP\\": \\"120.238.XX.XX\\",\\n \\"DestinationRegionNo\\": \\"cn-hangzhou\\",\\n \\"VbrId\\": \\"vbr-sample*\\",\\n \\"AttachmentId\\": \\"tr-sample*\\",\\n \\"SourceZone\\": \\"cn-hangzhou-a\\",\\n \\"DestinationZone\\": \\"cn-hangzhou-b\\",\\n \\"ByteCount\\": 1024,\\n \\"PacketCount\\": 66,\\n \\"RTT\\": 23,\\n \\"RetransmitRate\\": 0.1,\\n \\"InBps\\": 10,\\n \\"InPps\\": 3,\\n \\"OutBps\\": 88,\\n \\"OutPps\\": 8,\\n \\"NewSessionPerSecond\\": 18,\\n \\"ActiveSessionCount\\": 66\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetTransitRouterFlowTopN' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2673,552 +3678,198 @@
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '173536',
- 'abilityTreeNodes' => [
- 'FEATUREnetana5MCZ6K',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '174484',
+ 'abilityTreeNodes' => ['FEATUREnetanaB9LIVJ'],
],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '要查询的公网流量的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-shanghai',
- ],
- ],
- [
- 'name' => 'TupleType',
+ 'name' => 'BeginTime',
'in' => 'query',
- 'schema' => [
- 'title' => '查询的元组类型,枚举:1,2,5,分别表示一元组、二元组、五元组',
- 'description' => '查询的元组类型。取值: '."\n"
- .'- **1**:表示一元组。 '."\n"
- .'- **2**:表示二元组。 '."\n"
- .'- **5**:表示五元组。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- '5',
- ],
- ],
+ 'schema' => ['title' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。', 'description' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1684373600099'],
],
[
- 'name' => 'BeginTime',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'title' => '查询起始时间的毫秒时间戳。',
- 'description' => '查询起始时间的毫秒时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '253402271999000',
- 'minimum' => '0',
- 'example' => '1684373600099',
- ],
+ 'schema' => ['title' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。', 'description' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1638239093000'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'TopN',
'in' => 'query',
- 'schema' => [
- 'title' => '查询结束时间的毫秒时间戳。',
- 'description' => '查询结束时间的毫秒时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '253402271999000',
- 'minimum' => '0',
- 'example' => '1684373700099',
- ],
+ 'schema' => ['title' => '取最大多少条数据,默认10,最大100。', 'description' => '取最大多少条数据。默认值:**10**。最大值:**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '10'],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
- 'title' => '查询流量方向,取值:'."\n"
- .'in:入云方向'."\n"
- .'out:出云方向',
- 'description' => '查询流量方向,取值:'."\n"
- ."\n"
- .'- **in**:入云方向。'."\n"
- .'- **out**:出云方向。',
+ 'title' => '对于当前地域或IP的流量方向。'."\n"
+ .'in:入流量 '."\n"
+ .'out:出流量',
+ 'description' => '对于当前地域或IP的流量方向。取值:'."\n"
+ .'- **in**:入流量。'."\n"
+ .'- **out**:出流量。',
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'in' => 'in',
- 'out' => 'out',
- ],
'example' => 'in',
- 'enum' => [
- 'in',
- 'out',
- ],
- ],
- ],
- [
- 'name' => 'OrderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '根据什么指标排序,默认值为ByteCount,即按流量排序。',
- 'description' => '数据排序的指标。默认值:**ByteCount**,表示按流量排序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ByteCount',
- 'enum' => [
- 'Rtt',
- 'ByteCount',
- 'PacketCount',
- 'RetransmitRate',
- ],
- ],
- ],
- [
- 'name' => 'CloudIp',
- 'in' => 'query',
- 'schema' => [
- 'title' => '五元组:云端IP。',
- 'description' => '阿里云端IP。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '112.74.XX.XX',
+ 'enum' => ['in', 'out'],
],
],
[
- 'name' => 'CloudPort',
+ 'name' => 'GroupBy',
'in' => 'query',
'schema' => [
- 'title' => '五元组:云端端口',
- 'description' => '阿里云端端口。 '."\n"
- .'> 仅**TupleType**配置为**5**时,才需要配置该参数。',
+ 'title' => '指定跨域流量排名的维度,大小写敏感。'."\n"
+ .'1Tuple:查询跨域流量中当前地域、CEN、IP维度的排名。'."\n"
+ .'2Tuple:查询跨域流量中两端地域、两端IP对维度的排名。'."\n"
+ .'5Tuple:查询跨域流量中两端IP、两端端口和协议维度的排名。'."\n"
+ .'Cen:查询跨域流量中CEN实例维度的排名。'."\n"
+ .'RegionPair:查询跨域流量中两端地域维度的排名。'."\n"
+ .'Port:查询跨域流量中端口维度的排名。'."\n"
+ .'Protocol:查询跨域流量中协议维度的排名。',
+ 'description' => '指定跨域流量排名的维度,大小写敏感,请注意区分大小写。取值:'."\n"
+ .'- **1Tuple**:查询跨域流量中当前地域、云企业网CEN(Cloud Enterprise Network)、IP维度的排名。'."\n"
+ .'- **2Tuple**:查询跨域流量中两端地域、两端IP维度的排名。'."\n"
+ .'- **5Tuple**:查询跨域流量中两端IP、两端端口和协议维度的排名。'."\n"
+ .'- **Cen**:查询跨域流量中云企业网CEN实例维度的排名。'."\n"
+ .'- **RegionPair**:查询跨域流量中两端地域维度的排名。'."\n"
+ .'- **Port**:查询跨域流量中端口维度的排名。'."\n"
+ .'- **Protocol**:查询跨域流量中协议维度的排名。',
'type' => 'string',
- 'required' => false,
- 'example' => '443',
+ 'required' => true,
+ 'example' => '1Tuple',
+ 'enum' => ['1Tuple', '2Tuple', '5Tuple', 'Cen', 'RegionPair', 'Port', 'Protocol'],
],
],
[
- 'name' => 'OtherIp',
+ 'name' => 'ThisRegion',
'in' => 'query',
- 'schema' => [
- 'title' => '五元组:对端IP',
- 'description' => '对端IP。'."\n"
- .' > 仅**TupleType**配置为**2**或**5**时,才需要配置该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '122.112.XX.XX',
- ],
+ 'schema' => ['title' => '当前地域。', 'description' => '当前地域,即**ThisIp**所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
- 'name' => 'OtherPort',
+ 'name' => 'ThisIp',
'in' => 'query',
- 'schema' => [
- 'title' => '五元组:对端端口',
- 'description' => '对端端口。'."\n"
- .' > 仅**TupleType**配置为**5**时,才需要配置该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '40002',
- ],
+ 'schema' => ['title' => '当前IP地址。', 'description' => '本端IP地址。', 'type' => 'string', 'required' => false, 'example' => '1.8.XX.XX'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ThisPort',
'in' => 'query',
- 'schema' => [
- 'title' => '实例Id',
- 'description' => '阿里云端实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eip-sample*',
- ],
+ 'schema' => ['title' => '当前端口。', 'description' => '本端端口。', 'type' => 'string', 'required' => false, 'example' => '80'],
],
[
- 'name' => 'Protocol',
+ 'name' => 'OtherRegion',
'in' => 'query',
- 'schema' => [
- 'title' => '五元组:协议',
- 'description' => '协议号。 '."\n"
- .'>支持全部协议, 仅**TupleType**配置为**5**时,才需要配置该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6',
- ],
+ 'schema' => ['title' => '对端地域。', 'description' => '对端地域。', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1'],
],
[
- 'name' => 'Sort',
+ 'name' => 'OtherIp',
'in' => 'query',
- 'schema' => [
- 'title' => '排序方向:desc从大到小排序,asc从小到大排序。',
- 'description' => '流量数据的排序方式。 '."\n"
- .'- **desc**:从大到小排序。 '."\n"
- .'- **asc**:从小到大排序',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desc',
- 'default' => 'desc',
- 'enum' => [
- 'desc',
- 'asc',
- ],
- ],
+ 'schema' => ['title' => '对端IP地址。', 'description' => '对端IP地址。', 'type' => 'string', 'required' => false, 'example' => '122.112.XX.XX'],
],
[
- 'name' => 'TopN',
+ 'name' => 'OtherPort',
'in' => 'query',
- 'schema' => [
- 'title' => '默认10',
- 'description' => '展示排序靠前的数据。默认值:**10**。表示默认展示排序前10的数据。最大值:**100**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '对端端口。', 'description' => '对端端口。', 'type' => 'string', 'required' => false, 'example' => '10869'],
],
[
- 'name' => 'CloudIsp',
+ 'name' => 'Protocol',
'in' => 'query',
- 'schema' => [
- 'title' => '云端运营商。',
- 'description' => '云端运营商。'."\n"
- .'> 通常为“阿里巴巴”或“阿里云”。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '阿里巴巴',
- ],
+ 'schema' => ['title' => '协议类型编号。常见协议号如下:'."\n"
+ .'1:ICMP'."\n"
+ .'4:IP'."\n"
+ .'6:TCP'."\n"
+ .'17:UDP'."\n"
+ .'41:IPv6'."\n", 'description' => '协议号。'."\n"
+ ."\n"
+ .'> 支持全部协议,仅**GroupBy**配置为**5Tuple**或**Protocol**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => '6'],
],
[
- 'name' => 'OtherIsp',
+ 'name' => 'OrderBy',
'in' => 'query',
'schema' => [
- 'title' => '对端运营商,查看运营商情况时,请指定此参数。',
- 'description' => '对端运营商。 '."\n"
- .'> 查看运营商情况时,请指定此参数。',
+ 'title' => '按哪个指标排序。',
+ 'description' => '数据排序的指标。默认值:Bytes,表示按流量排序。',
'type' => 'string',
'required' => false,
- 'example' => '移动',
+ 'example' => 'Bytes',
+ 'default' => 'Bytes',
+ 'enum' => ['Bytes', 'Packets'],
],
],
[
- 'name' => 'OtherCountry',
+ 'name' => 'Sort',
'in' => 'query',
'schema' => [
- 'title' => '对端国家。仅TupleType配置为5时,才需要配置该参数。',
- 'description' => '对端国家。'."\n"
- .'>仅**TupleType**配置为**2**或**5**时,才需要配置该参数。',
+ 'title' => '排序方式。'."\n"
+ .'desc:降序'."\n"
+ .'asc:升序',
+ 'description' => '流量数据的排序方式。'."\n"
+ .'- **desc**:降序。'."\n"
+ .'- **asc**:升序。',
'type' => 'string',
'required' => false,
- 'example' => '中国',
+ 'example' => 'desc',
+ 'default' => 'desc',
+ 'enum' => ['desc', 'asc'],
],
],
[
- 'name' => 'OtherCity',
+ 'name' => 'CenId',
'in' => 'query',
- 'schema' => [
- 'title' => '对端城市。仅TupleType配置为5时,才需要配置该参数。',
- 'description' => '对端城市。'."\n"
- .'>仅**TupleType**配置为**2**或**5**时,才需要配置该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '杭州市',
- ],
+ 'schema' => ['title' => 'CEN实例ID。', 'description' => 'CEN实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cen-ia8kw1zjv4hyal****'],
],
[
- 'name' => 'InstanceList',
+ 'name' => 'BandwithPackageId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '批量过滤时的实例ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '批量过滤时的实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[\\"eip-sample*\\"]',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => 'CEN带宽包ID。', 'description' => 'CEN带宽包ID。', 'type' => 'string', 'required' => false, 'example' => 'cenbwp-ia8kw1zjv4hyal****'],
],
[
- 'name' => 'CloudIpList',
+ 'name' => 'AccountIds',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '批量过滤时的云上IP列表。',
+ 'description' => '成员账号ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '批量过滤时的云上IP。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[\\"103.212.XX.XX\\"]',
- ],
+ 'items' => ['description' => '某个成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[\\"118639953821****\\"]'],
'required' => false,
],
],
[
'name' => 'UseMultiAccount',
'in' => 'query',
- 'schema' => [
- 'title' => '是否使用多账号访问模式',
- 'description' => '是否使用多账号管理功能。默认值:**false**。表示不使用。 '."\n"
- .'> 多账号管理功能默认不开放,如需使用,请联系商务经理申请使用权限。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- ],
- [
- 'name' => 'AccountIds',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '显式传递子账号ID',
- 'description' => '成员账号ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '某个成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '[123]',
- ],
- 'required' => false,
- 'maxItems' => 10,
- ],
+ 'schema' => ['description' => '是否使用多账号管理功能。默认值:**false**。表示不使用。 '."\n"
+ .'> 多账号管理功能默认不开放,如需使用,请联系商务经理申请使用权限。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'RpcResponse<ArrayList<PublicFlowTupleModel>>',
- 'description' => 'RpcResponse<ArrayList<PublicFlowTupleModel>>',
+ 'title' => 'RpcResponse<TrFlowlogTopNResponse>',
+ 'description' => 'RpcResponse<TrFlowlogTopNResponse>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B',
- ],
- 'Data' => [
- 'description' => '公网流量详情排名列表。',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B'],
+ 'TransitRouterFlowTopN' => [
+ 'description' => '跨域流量详情排名列表。',
'type' => 'array',
'items' => [
- 'description' => '公网流量单行详情。',
+ 'description' => '跨域流量详情。',
'type' => 'object',
'properties' => [
- 'BeginTime' => [
- 'title' => '数据时间点',
- 'description' => '数据毫秒时间戳。',
- 'type' => 'string',
- 'example' => '1684373600099',
- ],
- 'Direction' => [
- 'title' => '数据方向',
- 'description' => '流量方向。取值:'."\n"
- .' - **in**:入云方向。 '."\n"
- .'- **out**:出云方向。',
- 'type' => 'string',
- 'example' => 'in',
- ],
- 'InstanceId' => [
- 'title' => '阿里侧IP归属的实例。',
- 'description' => '阿里云端IP归属的实例ID。',
- 'type' => 'string',
- 'example' => 'eip-sample*',
- ],
- 'AccessRegion' => [
- 'title' => 'InstanceId为AnyCastEip时,流量进入阿里云的Pop点。',
- 'description' => '流量进入阿里云的接入点。 '."\n"
- .'> 仅**InstanceId**为Anycast弹性公网IP时,该参数有效。',
- 'type' => 'string',
- 'example' => 'cn-hongkong-pop',
- ],
- 'CloudIp' => [
- 'title' => '五元组云端IP',
- 'description' => '阿里云端IP。',
- 'type' => 'string',
- 'example' => '112.74.XX.XX',
- ],
- 'CloudPort' => [
- 'title' => '五元组云端端口',
- 'description' => '阿里云端端口。',
- 'type' => 'string',
- 'example' => '443',
- ],
- 'OtherIp' => [
- 'title' => '五元组对端IP',
- 'description' => '对端IP。',
- 'type' => 'string',
- 'example' => '122.112.XX.XX',
- ],
- 'OtherPort' => [
- 'title' => '五元组对端端口',
- 'description' => '对端端口。',
- 'type' => 'string',
- 'example' => '40002',
- ],
- 'Protocol' => [
- 'title' => '五元组协议',
- 'description' => '协议号。',
- 'type' => 'string',
- 'example' => '6',
- ],
- 'CloudCountry' => [
- 'title' => '云端国家/地区',
- 'description' => '阿里云端国家或地区。',
- 'type' => 'string',
- 'example' => '中国',
- ],
- 'CloudProvince' => [
- 'title' => '云端省份',
- 'description' => '阿里云端省份。',
- 'type' => 'string',
- 'example' => '江苏省',
- ],
- 'CloudCity' => [
- 'title' => '云端城市',
- 'description' => '阿里云端城市。',
- 'type' => 'string',
- 'example' => '南京市',
- ],
- 'CloudIsp' => [
- 'title' => '云端ISP',
- 'description' => '阿里云端运营商。',
- 'type' => 'string',
- 'example' => '移动',
- ],
- 'CloudProduct' => [
- 'title' => '云端ISP',
- 'description' => '阿里云侧IP归属的实例对应的产品Code。',
- 'type' => 'string',
- 'example' => 'EIP',
- ],
- 'OtherCountry' => [
- 'title' => '对端国家/地区',
- 'description' => '对端国家或地区。',
- 'type' => 'string',
- 'example' => '美国',
- ],
- 'OtherProvince' => [
- 'title' => '对端省份',
- 'description' => '对端省份。当**OtherCountry**为国外时,此值多数为空。',
- 'type' => 'string',
- 'example' => '得克萨斯州',
- ],
- 'OtherCity' => [
- 'title' => '对端城市',
- 'description' => '对端城市。当**OtherCountry**为国外时,此值多数为空。',
- 'type' => 'string',
- 'example' => '奥斯汀',
- ],
- 'OtherIsp' => [
- 'title' => '对端ISP',
- 'description' => '对端运营商。',
- 'type' => 'string',
- 'example' => 'amazon.com',
- ],
- 'OtherProduct' => [
- 'title' => '对端ISP',
- 'description' => '对端IP归属的产品。如果非云上IP,则为空。',
- 'type' => 'string',
- 'example' => 'ECS',
- ],
- 'Rtt' => [
- 'title' => 'RTT 指标(us)',
- 'description' => '往返时延RTT(Round Trip Time)。单位:us。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '10000',
- ],
- 'ByteCount' => [
- 'title' => '流量指标(byte)',
- 'description' => '流量数(Byte)。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '88',
- ],
- 'PacketCount' => [
- 'title' => '包数指标(个)',
- 'description' => '流量包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '66',
- ],
- 'OutOrderCount' => [
- 'title' => '包数指标(个)',
- 'description' => '乱序包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'InByteCount' => [
- 'title' => '包数指标(个)',
- 'description' => '入云方向流量数。单位:Byte。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '88',
- ],
- 'OutByteCount' => [
- 'title' => '包数指标(个)',
- 'description' => '出云方向流量数。单位:Byte。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '66',
- ],
- 'InPacketCount' => [
- 'title' => '入方向包数指标(个)',
- 'description' => '入云方向流量包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '33',
- ],
- 'OutPacketCount' => [
- 'title' => '出方向包数指标(个)',
- 'description' => '出云方向流量包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '22',
- ],
- 'InOutOrderCount' => [
- 'title' => '入方向乱序包数指标(个)',
- 'description' => '入云方向乱序包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '2',
- ],
- 'OutOutOrderCount' => [
- 'title' => '出方向乱序包数指标(个)',
- 'description' => '出云方向乱序包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'InRetranCount' => [
- 'title' => '入方向重传包数指标(个)',
- 'description' => '入云方向重传包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0',
- ],
- 'OutRetranCount' => [
- 'title' => '出方向重传包数指标(个)',
- 'description' => '出云方向重传包数。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'RetransmitRate' => [
- 'title' => '重传率。',
- 'description' => 'TCP报文的重传率。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.1',
- ],
+ 'AccountId' => ['title' => '账号ID。', 'description' => '账号ID。', 'type' => 'string', 'example' => '118639953821****'],
+ 'CenId' => ['title' => '跨域ID', 'description' => 'CEN实例ID。', 'type' => 'string', 'example' => 'cen-ia8kw1zjv4hyal****'],
+ 'ThisRegion' => ['title' => '源regionId', 'description' => '本端地域,即**ThisIp**所在地域。', 'type' => 'string', 'example' => 'cn-shanghai'],
+ 'ThisIp' => ['title' => '源IP地址', 'description' => '本端IP地址。', 'type' => 'string', 'example' => '1.8.XX.XX'],
+ 'ThisPort' => ['title' => '源端口号', 'description' => '本端端口号。', 'type' => 'string', 'example' => '80'],
+ 'OtherRegion' => ['title' => '目的regionId', 'description' => '目的地域,即**OtherIp**所在地域。', 'type' => 'string', 'example' => 'ap-southeast-1'],
+ 'OtherIp' => ['title' => '目的IP地址', 'description' => '对端IP地址。', 'type' => 'string', 'example' => '47.216.XX.XX'],
+ 'OtherPort' => ['title' => '目的端口号', 'description' => '对端端口号。', 'type' => 'string', 'example' => '53470'],
+ 'Protocol' => ['title' => '协议号', 'description' => '协议号。', 'type' => 'string', 'example' => '6'],
+ 'StartTime' => ['title' => '开始时间', 'description' => '开始时间。', 'type' => 'string', 'example' => '2023-01-31T05:40:00Z'],
+ 'EndTime' => ['title' => '结束时间', 'description' => '结束时间。', 'type' => 'string', 'example' => '2023-01-31T06:40:00Z'],
+ 'Packets' => ['description' => '指定时间段内的包数总和。', 'type' => 'number', 'format' => 'double', 'example' => '88'],
+ 'Bytes' => ['description' => '指定时间段内的流量总和。', 'type' => 'number', 'format' => 'double', 'example' => '188'],
+ 'BandwithPackageId' => ['title' => '带宽包', 'description' => 'CEN带宽包ID。', 'type' => 'string', 'example' => 'cenbwp-ia8kw1zjv4hyal****'],
],
],
],
@@ -3228,306 +3879,48 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParam.TopN',
- 'errorMessage' => 'The TopN(%s) should not greater than 100.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime1H',
- 'errorMessage' => 'It only supports querying data for up to 1 hour: %s.',
- ],
- [
- 'errorCode' => 'IllegalParam.GroupBy',
- 'errorMessage' => 'The specified param of GroupBy (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.OrderBy',
- 'errorMessage' => 'The specified param of orderBy (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.RegionId',
- 'errorMessage' => 'The specified region ID (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime',
- 'errorMessage' => 'It only supports querying data for up to 24 hours: %s.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime5M',
- 'errorMessage' => 'It only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.',
- ],
- [
- 'errorCode' => 'OperationFailed.DbConcurrentTooHigh',
- 'errorMessage' => 'The operation failed due to too many concurrent queries. Please try again later.',
- ],
- [
- 'errorCode' => 'OperationFailed.DataTooMuch',
- 'errorMessage' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'ResourceNotFound.InstanceId',
- 'errorMessage' => 'The specified InstanceId(%s) does not exist.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.IpSets',
- 'errorMessage' => 'The specified instance does not exist or does not have any acceleration region.',
- ],
+ ['errorCode' => 'IllegalParam.TopN', 'errorMessage' => 'The TopN(%s) should not greater than 100.', 'description' => '最大仅支持Top 100,实际传入为(%s)。'],
+ ['errorCode' => 'IllegalParam.BeginTime', 'errorMessage' => 'The specified begin time (%s) is invalid.', 'description' => '指定的开始时间(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime', 'errorMessage' => 'It only supports querying data for up to 7 days: %s.', 'description' => '最大仅支持查询7天的数据:%s。'],
+ ['errorCode' => 'IllegalParam.OrderBy', 'errorMessage' => 'The specified param of orderBy (%s) is invalid.', 'description' => '指定的排序字段(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.Sort', 'errorMessage' => 'The specified Sort(%s) is invalid.', 'description' => '排序字段必须为(\'desc\',\'asc\')其中之一'],
+ ['errorCode' => 'IllegalParam.AccountIds', 'errorMessage' => 'The specified parameter accountId (%s) is invalid.', 'description' => '指定的AccountId (%s)不在用户可选范围内。'],
+ ['errorCode' => 'IllegalParam.inOrOut', 'errorMessage' => 'Valid values for the inOrOut parameter: in and out.', 'description' => '参数inOrOut必须为i(\'in\',\'out\')之一。'],
+ ['errorCode' => 'IllegalParam.EndTime', 'errorMessage' => 'The specified end time (%s) is invalid.', 'description' => '指定的结束时间(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.ThisRegion', 'errorMessage' => 'The specified parameter thisRegion(%s) is illegal.', 'description' => 'ThisRegion不合法'],
+ ['errorCode' => 'QuotaExceeded.CheckRowReadLimit', 'errorMessage' => 'The query time range (%s) exceeds the number of data rows limit. Shorten the query interval.', 'description' => ''],
],
],
'staticInfo' => [
- 'substitutions' => [
- 'nis::2021-12-16::GetNisNetworkRanking',
- ],
+ 'substitutions' => ['nis::2021-12-16::GetNisNetworkRanking'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"Data\\": [\\n {\\n \\"BeginTime\\": \\"1684373600099\\",\\n \\"Direction\\": \\"in\\",\\n \\"InstanceId\\": \\"eip-sample*\\",\\n \\"AccessRegion\\": \\"cn-hongkong-pop\\",\\n \\"CloudIp\\": \\"112.74.XX.XX\\",\\n \\"CloudPort\\": \\"443\\",\\n \\"OtherIp\\": \\"122.112.XX.XX\\",\\n \\"OtherPort\\": \\"40002\\",\\n \\"Protocol\\": \\"6\\",\\n \\"CloudCountry\\": \\"中国\\",\\n \\"CloudProvince\\": \\"江苏省\\",\\n \\"CloudCity\\": \\"南京市\\",\\n \\"CloudIsp\\": \\"移动\\",\\n \\"CloudProduct\\": \\"EIP\\",\\n \\"OtherCountry\\": \\"美国\\",\\n \\"OtherProvince\\": \\"得克萨斯州\\",\\n \\"OtherCity\\": \\"奥斯汀\\",\\n \\"OtherIsp\\": \\"amazon.com\\",\\n \\"OtherProduct\\": \\"ECS\\",\\n \\"Rtt\\": 10000,\\n \\"ByteCount\\": 88,\\n \\"PacketCount\\": 66,\\n \\"OutOrderCount\\": 1,\\n \\"InByteCount\\": 88,\\n \\"OutByteCount\\": 66,\\n \\"InPacketCount\\": 33,\\n \\"OutPacketCount\\": 22,\\n \\"InOutOrderCount\\": 2,\\n \\"OutOutOrderCount\\": 1,\\n \\"InRetranCount\\": 0,\\n \\"OutRetranCount\\": 1,\\n \\"RetransmitRate\\": 0.1\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取公网流量详情数据排名',
- ],
- 'GetNatTopN' => [
- 'summary' => '调用GetNatTopN接口,获取NAT网关的SNAT转发实时数据排名。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '116918',
- 'abilityTreeNodes' => [
- 'FEATUREnetana5MCZ6K',
+ 'title' => '获取跨域流量详情数据排名',
+ 'summary' => '调用GetTransitRouterFlowTopN接口,获取跨域流量详情数据排名,覆盖一元组、二元组、五元组粒度,支持按流量、包数等指标排序。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTransitRouterFlowTopN'],
],
],
- 'parameters' => [
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'Nat网关实例所属地域',
- 'description' => 'NAT网关实例所属地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
- ],
- [
- 'name' => 'NatGatewayId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'Nat网关实例ID',
- 'description' => 'NAT网关实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ngw-sample***',
- ],
- ],
- [
- 'name' => 'BeginTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '查询指标的开始毫秒时间戳。如果不指定EndTime,则查询的是BeginTime指定的时间点的TopN情况。',
- 'description' => '查询指标的开始毫秒时间戳。如果不指定**EndTime**,则查询的是**BeginTime**指定的时间点的情况。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1638239092000',
- ],
- ],
- [
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '查询指标的结束毫秒时间戳。BeginTime和EndTime的最大差距不能超过24小时,即86400000。',
- 'description' => '查询指标的结束毫秒时间戳。**BeginTime**和**EndTime**的最大差距不能超过24小时,即**86400000**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1638239093000',
- ],
- ],
- [
- 'name' => 'OrderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '按哪个指标倒叙排序取TopN。',
- 'description' => '对NAT网关进行SNAT转发实时数据排名的指标。取值:'."\n"
- .'- **InBps**:入方向流量。单位:bps。'."\n"
- .'- **OutBps**:出方向流量。单位:bps。'."\n"
- .'- **InPps**:入方向包速率。单位:个/秒。'."\n"
- .'- **OutPps**:出方向包速率。单位:个/秒。'."\n"
- .'- **NewSessionPerSecond**:新建连接数。单位:个/秒。'."\n"
- .'- **ActiveSessionCount**:并发连接数。单位:个。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'InBps',
- ],
- ],
- [
- 'name' => 'TopN',
- 'in' => 'query',
- 'schema' => [
- 'title' => '取最大多少条数据,默认10,最大100。',
- 'description' => '查询NAT网关的SNAT转发实时数据排名的条目数。取值范围:**1~100**。默认值:**10**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'Ip',
- 'in' => 'query',
- 'schema' => [
- 'title' => '查指定ip的指标,此时无需传topN和orderBy',
- 'description' => '查询指定IP地址的监控指标。当输入Ip参数时,无需输入**TopN**和**OrderBy**。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.156.101',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '77C512B5-12f3-f892-BD94-88A98271C1A0',
- ],
- 'NatGatewayTopN' => [
- 'title' => '以下指标取BeginTime到EndTime的均值。',
- 'description' => 'NAT网关SNAT转发实时数据排名数组。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'NAT网关SNAT转发实时数据排名对象。以下指标取**BeginTime**到**EndTime**的均值。',
- 'type' => 'object',
- 'properties' => [
- 'Ip' => [
- 'title' => 'IP地址',
- 'description' => 'IP地址。',
- 'type' => 'string',
- 'example' => '192.168.156.101',
- ],
- 'InBps' => [
- 'title' => '入方向流量,单位bps',
- 'description' => '入方向流量。单位:bps。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '100',
- ],
- 'OutBps' => [
- 'title' => '出方向流量,单位bps',
- 'description' => '出方向流量。单位:bps。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '200',
- ],
- 'InPps' => [
- 'title' => '入方向包速率(个/秒)',
- 'description' => '入方向包速率。单位:个/秒。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '10',
- ],
- 'OutPps' => [
- 'title' => '出方向包速率',
- 'description' => '出方向包速率。单位:个/秒。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '20',
- ],
- 'InFlowPerMinute' => [
- 'description' => '保留字段,暂未使用。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '10',
- ],
- 'OutFlowPerMinute' => [
- 'description' => '保留字段,暂未使用。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '10',
- ],
- 'NewSessionPerSecond' => [
- 'title' => '新建连接数(个/秒)',
- 'description' => '新建连接数。单位:个/秒。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '2',
- ],
- 'ActiveSessionCount' => [
- 'title' => '并发连接数(个)',
- 'description' => '并发连接数。单位:个。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '8',
- ],
- ],
- ],
- ],
- 'IsTopNOpen' => [
- 'title' => '该实例是否开通TopN功能',
- 'description' => '是否已开通网络智能服务(NIS)功能,未开通时NatGatewayTopN返回空。'."\n"
- .'- **true**:已开通。'."\n"
- .'- **false**:未开通。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:GetTransitRouterFlowTopN',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalParam.TopN',
- 'errorMessage' => 'The TopN(%s) should not greater than 100.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime',
- 'errorMessage' => 'It only supports querying data for up to 7 days: %s.',
- ],
- [
- 'errorCode' => 'IllegalParam.ResourceId',
- 'errorMessage' => 'The specified resourceId (%s) may be not exist.',
- ],
- [
- 'errorCode' => 'IllegalParam.OrderBy',
- 'errorMessage' => 'The specified param of orderBy (%s) is invalid.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'substitutions' => [
- 'nis::2021-12-16::GetNisNetworkRanking',
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"77C512B5-12f3-f892-BD94-88A98271C1A0\\",\\n \\"NatGatewayTopN\\": [\\n {\\n \\"Ip\\": \\"192.168.156.101\\",\\n \\"InBps\\": 100,\\n \\"OutBps\\": 200,\\n \\"InPps\\": 10,\\n \\"OutPps\\": 20,\\n \\"InFlowPerMinute\\": 10,\\n \\"OutFlowPerMinute\\": 10,\\n \\"NewSessionPerSecond\\": 2,\\n \\"ActiveSessionCount\\": 8\\n }\\n ],\\n \\"IsTopNOpen\\": true\\n}","type":"json"}]',
- 'title' => '获取NAT网关SNAT转发实时数据排名',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"TransitRouterFlowTopN\\": [\\n {\\n \\"AccountId\\": \\"118639953821****\\",\\n \\"CenId\\": \\"cen-ia8kw1zjv4hyal****\\",\\n \\"ThisRegion\\": \\"cn-shanghai\\",\\n \\"ThisIp\\": \\"1.8.XX.XX\\",\\n \\"ThisPort\\": \\"80\\",\\n \\"OtherRegion\\": \\"ap-southeast-1\\",\\n \\"OtherIp\\": \\"47.216.XX.XX\\",\\n \\"OtherPort\\": \\"53470\\",\\n \\"Protocol\\": \\"6\\",\\n \\"StartTime\\": \\"2023-01-31T05:40:00Z\\",\\n \\"EndTime\\": \\"2023-01-31T06:40:00Z\\",\\n \\"Packets\\": 88,\\n \\"Bytes\\": 188,\\n \\"BandwithPackageId\\": \\"cenbwp-ia8kw1zjv4hyal****\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetVbrFlowTopN' => [
'summary' => '调用GetVbrFlowTopN接口,获取混合云流量详情数据排名,覆盖一元组、二元组、五元组粒度,支持按流量、包数等指标排序。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3540,45 +3933,23 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '178894',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaOV20CD',
- ],
+ 'abilityTreeNodes' => ['FEATUREnetanaOV20CD'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'title' => '云端地域。',
- 'description' => '云端地域。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['title' => '云端地域。', 'description' => '云端地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'BeginTime',
'in' => 'query',
- 'schema' => [
- 'title' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。',
- 'description' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1638239092000',
- ],
+ 'schema' => ['title' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。', 'description' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1638239092000'],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'title' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。',
- 'description' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1638239093000',
- ],
+ 'schema' => ['title' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。', 'description' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1638239093000'],
],
[
'name' => 'Direction',
@@ -3593,10 +3964,7 @@
'type' => 'string',
'required' => true,
'example' => 'in',
- 'enum' => [
- 'in',
- 'out',
- ],
+ 'enum' => ['in', 'out'],
],
],
[
@@ -3620,14 +3988,7 @@
'type' => 'string',
'required' => true,
'example' => '1Tuple',
- 'enum' => [
- '1Tuple',
- '2Tuple',
- '5Tuple',
- 'CloudPort',
- 'OtherPort',
- 'Protocol',
- ],
+ 'enum' => ['1Tuple', '2Tuple', '5Tuple', 'CloudPort', 'OtherPort', 'Protocol'],
],
],
[
@@ -3640,10 +4001,7 @@
'required' => false,
'example' => 'Bytes',
'default' => 'Bytes',
- 'enum' => [
- 'Bytes',
- 'Packets',
- ],
+ 'enum' => ['Bytes', 'Packets'],
],
],
[
@@ -3660,122 +4018,61 @@
'required' => false,
'example' => 'desc',
'default' => 'desc',
- 'enum' => [
- 'asc',
- 'desc',
- ],
+ 'enum' => ['asc', 'desc'],
],
],
[
'name' => 'TopN',
'in' => 'query',
- 'schema' => [
- 'title' => '取最大多少条数据,默认10,最大100。',
- 'description' => '展示排序靠前的数据。默认值:**10**。表示默认展示排序前10的数据。最大**100**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '取最大多少条数据,默认10,最大100。', 'description' => '展示排序靠前的数据。默认值:**10**。表示默认展示排序前10的数据。最大**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'CenId',
'in' => 'query',
- 'schema' => [
- 'title' => 'CEN实例ID。',
- 'description' => 'CEN实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cen-ia8kw1zjv4hyal****',
- ],
+ 'schema' => ['title' => 'CEN实例ID。', 'description' => 'CEN实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cen-ia8kw1zjv4hyal****'],
],
[
'name' => 'VirtualBorderRouterId',
'in' => 'query',
- 'schema' => [
- 'title' => '专线ID。',
- 'description' => '专线VBR实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vbr-k1atj46citwuek42j****',
- ],
+ 'schema' => ['title' => '专线ID。', 'description' => '专线VBR实例ID。', 'type' => 'string', 'required' => false, 'example' => 'vbr-k1atj46citwuek42j****'],
],
[
'name' => 'AttachmentId',
'in' => 'query',
- 'schema' => [
- 'title' => 'CEN的连接ID。',
- 'description' => 'CEN的连接ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tr-attach-dnv870gmqzmb5u****',
- ],
+ 'schema' => ['title' => 'CEN的连接ID。', 'description' => 'CEN的连接ID。', 'type' => 'string', 'required' => false, 'example' => 'tr-attach-dnv870gmqzmb5u****'],
],
[
'name' => 'Protocol',
'in' => 'query',
- 'schema' => [
- 'title' => '协议类型编号。常见协议号如下:'."\n"
- .'1:ICMP'."\n"
- .'4:IP'."\n"
- .'6:TCP'."\n"
- .'17:UDP'."\n"
- .'41:IPv6',
- 'description' => '协议号。'."\n"
- .'> 支持全部协议,仅**GroupBy**配置为**5Tuple**或**Protocol**时,才需要配置该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6',
- ],
+ 'schema' => ['title' => '协议类型编号。常见协议号如下:'."\n"
+ .'1:ICMP'."\n"
+ .'4:IP'."\n"
+ .'6:TCP'."\n"
+ .'17:UDP'."\n"
+ .'41:IPv6', 'description' => '协议号。'."\n"
+ .'> 支持全部协议,仅**GroupBy**配置为**5Tuple**或**Protocol**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => '6'],
],
[
'name' => 'CloudIp',
'in' => 'query',
- 'schema' => [
- 'title' => '云端IP',
- 'description' => '云端IP。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '112.74.XX.XX',
- ],
+ 'schema' => ['title' => '云端IP', 'description' => '云端IP。', 'type' => 'string', 'required' => false, 'example' => '112.74.XX.XX'],
],
[
'name' => 'OtherIp',
'in' => 'query',
- 'schema' => [
- 'title' => 'IDC侧IP',
- 'description' => 'IDC侧IP。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '122.112.XX.XX',
- ],
+ 'schema' => ['title' => 'IDC侧IP', 'description' => 'IDC侧IP。', 'type' => 'string', 'required' => false, 'example' => '122.112.XX.XX'],
],
[
'name' => 'CloudPort',
'in' => 'query',
- 'schema' => [
- 'title' => '云端端口号',
- 'description' => '云端端口号。'."\n"
- .'> 仅**GroupBy**配置为**CloudPort**时,才需要配置该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '443',
- ],
+ 'schema' => ['title' => '云端端口号', 'description' => '云端端口号。'."\n"
+ .'> 仅**GroupBy**配置为**CloudPort**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => '443'],
],
[
'name' => 'OtherPort',
'in' => 'query',
- 'schema' => [
- 'title' => 'IDC侧端口号',
- 'description' => 'IDC侧端口号。'."\n"
- .'> 仅**GroupBy**配置为**OtherPort**时,才需要配置该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '40002',
- ],
+ 'schema' => ['title' => 'IDC侧端口号', 'description' => 'IDC侧端口号。'."\n"
+ .'> 仅**GroupBy**配置为**OtherPort**时,才需要配置该参数。', 'type' => 'string', 'required' => false, 'example' => '40002'],
],
[
'name' => 'AccountIds',
@@ -3785,13 +4082,7 @@
'title' => '子账号ID',
'description' => '成员账号ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '某个成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '[\\"118639953821****\\"]',
- ],
+ 'items' => ['description' => '某个成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[\\"118639953821****\\"]'],
'required' => false,
'maxItems' => 10,
],
@@ -3799,13 +4090,8 @@
[
'name' => 'UseMultiAccount',
'in' => 'query',
- 'schema' => [
- 'description' => '是否使用多账号管理功能。默认值:**false**。表示不使用。 '."\n"
- .'> 多账号管理功能默认不开放,如需使用,请联系商务经理申请使用权限。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '是否使用多账号管理功能。默认值:**false**。表示不使用。 '."\n"
+ .'> 多账号管理功能默认不开放,如需使用,请联系商务经理申请使用权限。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
@@ -3815,11 +4101,7 @@
'description' => 'RpcResponse<ArrayList>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
'VirtualBorderRouterFlowlogTopN' => [
'description' => '混合云流量详情排名列表。',
'type' => 'array',
@@ -3827,72 +4109,17 @@
'description' => '混合云流量详情。',
'type' => 'object',
'properties' => [
- 'CloudRegion' => [
- 'title' => 'region',
- 'description' => '云端IP对应的云端地域。',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- 'CloudIp' => [
- 'title' => '源IP',
- 'description' => '云端IP。',
- 'type' => 'string',
- 'example' => '120.24.X.X',
- ],
- 'OtherIp' => [
- 'title' => '目的IP',
- 'description' => 'IDC侧IP。',
- 'type' => 'string',
- 'example' => '222.85.X.X',
- ],
- 'CloudPort' => [
- 'title' => '源端口',
- 'description' => '云端端口。',
- 'type' => 'string',
- 'example' => '80',
- ],
- 'OtherPort' => [
- 'title' => '目的端口',
- 'description' => 'IDC侧端口。',
- 'type' => 'string',
- 'example' => '10965',
- ],
- 'Protocol' => [
- 'title' => '协议',
- 'description' => '协议号。',
- 'type' => 'string',
- 'example' => '6',
- ],
- 'AttachmentId' => [
- 'title' => 'attachmentId',
- 'description' => 'CEN的连接ID。',
- 'type' => 'string',
- 'example' => 'tr-attach-u6v1j3jre0fe9h****',
- ],
- 'VirtualBorderRouterId' => [
- 'title' => '专线Id',
- 'description' => '专线ID。',
- 'type' => 'string',
- 'example' => 'vbr-k1atj46citwuek42j****',
- ],
- 'Bytes' => [
- 'description' => '指定时间段内的流量总和。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '108',
- ],
- 'Packets' => [
- 'description' => '指定时间段内的发包数总和。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '66',
- ],
- 'AccountId' => [
- 'title' => '子账号ID',
- 'description' => '账号ID。',
- 'type' => 'string',
- 'example' => '156237031628****',
- ],
+ 'CloudRegion' => ['title' => 'region', 'description' => '云端IP对应的云端地域。', 'type' => 'string', 'example' => 'cn-shanghai'],
+ 'CloudIp' => ['title' => '源IP', 'description' => '云端IP。', 'type' => 'string', 'example' => '120.24.X.X'],
+ 'OtherIp' => ['title' => '目的IP', 'description' => 'IDC侧IP。', 'type' => 'string', 'example' => '222.85.X.X'],
+ 'CloudPort' => ['title' => '源端口', 'description' => '云端端口。', 'type' => 'string', 'example' => '80'],
+ 'OtherPort' => ['title' => '目的端口', 'description' => 'IDC侧端口。', 'type' => 'string', 'example' => '10965'],
+ 'Protocol' => ['title' => '协议', 'description' => '协议号。', 'type' => 'string', 'example' => '6'],
+ 'AttachmentId' => ['title' => 'attachmentId', 'description' => 'CEN的连接ID。', 'type' => 'string', 'example' => 'tr-attach-u6v1j3jre0fe9h****'],
+ 'VirtualBorderRouterId' => ['title' => '专线Id', 'description' => '专线ID。', 'type' => 'string', 'example' => 'vbr-k1atj46citwuek42j****'],
+ 'Bytes' => ['description' => '指定时间段内的流量总和。', 'type' => 'number', 'format' => 'double', 'example' => '108'],
+ 'Packets' => ['description' => '指定时间段内的发包数总和。', 'type' => 'number', 'format' => 'double', 'example' => '66'],
+ 'AccountId' => ['title' => '子账号ID', 'description' => '账号ID。', 'type' => 'string', 'example' => '156237031628****'],
],
],
],
@@ -3902,2682 +4129,1136 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParam.TopN',
- 'errorMessage' => 'The TopN(%s) should not greater than 100.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTime',
- 'errorMessage' => 'The specified begin time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime',
- 'errorMessage' => 'It only supports querying data for up to 7 days: %s.',
- ],
- [
- 'errorCode' => 'IllegalParam.Sort',
- 'errorMessage' => 'The specified Sort(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.OrderBy',
- 'errorMessage' => 'The specified param of orderBy (%s) is invalid.',
- ],
- [
- 'errorCode' => 'OperationFailed.DataTooMuch',
- 'errorMessage' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.',
- ],
- [
- 'errorCode' => 'IllegalParam.RegionId',
- 'errorMessage' => 'The specified region ID (%s) is invalid.',
- ],
+ ['errorCode' => 'IllegalParam.TopN', 'errorMessage' => 'The TopN(%s) should not greater than 100.', 'description' => '最大仅支持Top 100,实际传入为(%s)。'],
+ ['errorCode' => 'IllegalParam.BeginTime', 'errorMessage' => 'The specified begin time (%s) is invalid.', 'description' => '指定的开始时间(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime', 'errorMessage' => 'It only supports querying data for up to 7 days: %s.', 'description' => '最大仅支持查询7天的数据:%s。'],
+ ['errorCode' => 'IllegalParam.Sort', 'errorMessage' => 'The specified Sort(%s) is invalid.', 'description' => '排序字段必须为(\'desc\',\'asc\')其中之一'],
+ ['errorCode' => 'IllegalParam.OrderBy', 'errorMessage' => 'The specified param of orderBy (%s) is invalid.', 'description' => '指定的排序字段(%s)不合法。'],
+ ['errorCode' => 'OperationFailed.DataTooMuch', 'errorMessage' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.', 'description' => '指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。'],
+ ['errorCode' => 'IllegalParam.RegionId', 'errorMessage' => 'The specified region ID (%s) is invalid.', 'description' => '指定的地域(%s)不合法。'],
+ ['errorCode' => 'QuotaExceeded.CheckRowReadLimit', 'errorMessage' => 'The query time range (%s) exceeds the number of data rows limit. Shorten the query interval.', 'description' => ''],
],
],
'staticInfo' => [
- 'substitutions' => [
- 'nis::2021-12-16::GetNisNetworkRanking',
- ],
+ 'substitutions' => ['nis::2021-12-16::GetNisNetworkRanking'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"VirtualBorderRouterFlowlogTopN\\": [\\n {\\n \\"CloudRegion\\": \\"cn-shanghai\\",\\n \\"CloudIp\\": \\"120.24.X.X\\",\\n \\"OtherIp\\": \\"222.85.X.X\\",\\n \\"CloudPort\\": \\"80\\",\\n \\"OtherPort\\": \\"10965\\",\\n \\"Protocol\\": \\"6\\",\\n \\"AttachmentId\\": \\"tr-attach-u6v1j3jre0fe9h****\\",\\n \\"VirtualBorderRouterId\\": \\"vbr-k1atj46citwuek42j****\\",\\n \\"Bytes\\": 108,\\n \\"Packets\\": 66,\\n \\"AccountId\\": \\"156237031628****\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取混合云流量详情数据排名',
- ],
- 'GetTransitRouterFlowTopN' => [
- 'summary' => '调用GetTransitRouterFlowTopN接口,获取跨域流量详情数据排名,覆盖一元组、二元组、五元组粒度,支持按流量、包数等指标排序。',
- 'methods' => [
- 'get',
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetVbrFlowTopN'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:GetVbrFlowTopN',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"VirtualBorderRouterFlowlogTopN\\": [\\n {\\n \\"CloudRegion\\": \\"cn-shanghai\\",\\n \\"CloudIp\\": \\"120.24.X.X\\",\\n \\"OtherIp\\": \\"222.85.X.X\\",\\n \\"CloudPort\\": \\"80\\",\\n \\"OtherPort\\": \\"10965\\",\\n \\"Protocol\\": \\"6\\",\\n \\"AttachmentId\\": \\"tr-attach-u6v1j3jre0fe9h****\\",\\n \\"VirtualBorderRouterId\\": \\"vbr-k1atj46citwuek42j****\\",\\n \\"Bytes\\": 108,\\n \\"Packets\\": 66,\\n \\"AccountId\\": \\"156237031628****\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListNisInspectionResourceType' => [
+ 'summary' => '查询巡检对象产品类型列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => true,
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '174484',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaB9LIVJ',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'BeginTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。',
- 'description' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1684373600099',
- ],
- ],
- [
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。',
- 'description' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1638239093000',
- ],
- ],
- [
- 'name' => 'TopN',
- 'in' => 'query',
- 'schema' => [
- 'title' => '取最大多少条数据,默认10,最大100。',
- 'description' => '取最大多少条数据。默认值:**10**。最大值:**100**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '10',
- ],
- ],
- [
- 'name' => 'Direction',
- 'in' => 'query',
- 'schema' => [
- 'title' => '对于当前地域或IP的流量方向。'."\n"
- .'in:入流量 '."\n"
- .'out:出流量',
- 'description' => '对于当前地域或IP的流量方向。取值:'."\n"
- .'- **in**:入流量。'."\n"
- .'- **out**:出流量。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'in',
- 'enum' => [
- 'in',
- 'out',
- ],
- ],
- ],
- [
- 'name' => 'GroupBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '指定跨域流量排名的维度,大小写敏感。'."\n"
- .'1Tuple:查询跨域流量中当前地域、CEN、IP维度的排名。'."\n"
- .'2Tuple:查询跨域流量中两端地域、两端IP对维度的排名。'."\n"
- .'5Tuple:查询跨域流量中两端IP、两端端口和协议维度的排名。'."\n"
- .'Cen:查询跨域流量中CEN实例维度的排名。'."\n"
- .'RegionPair:查询跨域流量中两端地域维度的排名。'."\n"
- .'Port:查询跨域流量中端口维度的排名。'."\n"
- .'Protocol:查询跨域流量中协议维度的排名。',
- 'description' => '指定跨域流量排名的维度,大小写敏感,请注意区分大小写。取值:'."\n"
- .'- **1Tuple**:查询跨域流量中当前地域、云企业网CEN(Cloud Enterprise Network)、IP维度的排名。'."\n"
- .'- **2Tuple**:查询跨域流量中两端地域、两端IP维度的排名。'."\n"
- .'- **5Tuple**:查询跨域流量中两端IP、两端端口和协议维度的排名。'."\n"
- .'- **Cen**:查询跨域流量中云企业网CEN实例维度的排名。'."\n"
- .'- **RegionPair**:查询跨域流量中两端地域维度的排名。'."\n"
- .'- **Port**:查询跨域流量中端口维度的排名。'."\n"
- .'- **Protocol**:查询跨域流量中协议维度的排名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1Tuple',
- 'enum' => [
- '1Tuple',
- '2Tuple',
- '5Tuple',
- 'Cen',
- 'RegionPair',
- 'Port',
- 'Protocol',
- ],
- ],
- ],
- [
- 'name' => 'ThisRegion',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前地域。',
- 'description' => '当前地域,即**ThisIp**所在地域。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
- ],
- [
- 'name' => 'ThisIp',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前IP地址。',
- 'description' => '本端IP地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.8.XX.XX',
- ],
- ],
- [
- 'name' => 'ThisPort',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前端口。',
- 'description' => '本端端口。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '80',
- ],
- ],
- [
- 'name' => 'OtherRegion',
- 'in' => 'query',
- 'schema' => [
- 'title' => '对端地域。',
- 'description' => '对端地域。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ap-southeast-1',
- ],
- ],
- [
- 'name' => 'OtherIp',
- 'in' => 'query',
- 'schema' => [
- 'title' => '对端IP地址。',
- 'description' => '对端IP地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '122.112.XX.XX',
- ],
- ],
- [
- 'name' => 'OtherPort',
- 'in' => 'query',
- 'schema' => [
- 'title' => '对端端口。',
- 'description' => '对端端口。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10869',
- ],
- ],
- [
- 'name' => 'Protocol',
- 'in' => 'query',
- 'schema' => [
- 'title' => '协议类型编号。常见协议号如下:'."\n"
- .'1:ICMP'."\n"
- .'4:IP'."\n"
- .'6:TCP'."\n"
- .'17:UDP'."\n"
- .'41:IPv6'."\n",
- 'description' => '协议号。'."\n"
- ."\n"
- .'> 支持全部协议,仅**GroupBy**配置为**5Tuple**或**Protocol**时,才需要配置该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6',
- ],
- ],
- [
- 'name' => 'OrderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '按哪个指标排序。',
- 'description' => '数据排序的指标。默认值:Bytes,表示按流量排序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Bytes',
- 'default' => 'Bytes',
- 'enum' => [
- 'Bytes',
- 'Packets',
- ],
- ],
- ],
- [
- 'name' => 'Sort',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序方式。'."\n"
- .'desc:降序'."\n"
- .'asc:升序',
- 'description' => '流量数据的排序方式。'."\n"
- .'- **desc**:降序。'."\n"
- .'- **asc**:升序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desc',
- 'default' => 'desc',
- 'enum' => [
- 'desc',
- 'asc',
- ],
- ],
- ],
- [
- 'name' => 'CenId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'CEN实例ID。',
- 'description' => 'CEN实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cen-ia8kw1zjv4hyal****',
- ],
- ],
- [
- 'name' => 'BandwithPackageId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'CEN带宽包ID。',
- 'description' => 'CEN带宽包ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cenbwp-ia8kw1zjv4hyal****',
- ],
- ],
- [
- 'name' => 'AccountIds',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '成员账号ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '某个成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '[\\"118639953821****\\"]',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'UseMultiAccount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否使用多账号管理功能。默认值:**false**。表示不使用。 '."\n"
- .'> 多账号管理功能默认不开放,如需使用,请联系商务经理申请使用权限。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
+ 'abilityTreeCode' => '226557',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
+ 'tenantRelevance' => 'publicInformation',
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'RpcResponse<TrFlowlogTopNResponse>',
- 'description' => 'RpcResponse<TrFlowlogTopNResponse>',
+ 'title' => 'RpcResponse<ListNisInspectionResourceTypeResponse>',
+ 'description' => 'RpcResponse<ListNisInspectionResourceTypeResponse>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B',
- ],
- 'TransitRouterFlowTopN' => [
- 'description' => '跨域流量详情排名列表。',
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B'],
+ 'ResourceTypeList' => [
+ 'description' => '巡检资源类型',
'type' => 'array',
'items' => [
- 'description' => '跨域流量详情。',
'type' => 'object',
'properties' => [
- 'AccountId' => [
- 'title' => '账号ID。',
- 'description' => '账号ID。',
- 'type' => 'string',
- 'example' => '118639953821****',
- ],
- 'CenId' => [
- 'title' => '跨域ID',
- 'description' => 'CEN实例ID。',
- 'type' => 'string',
- 'example' => 'cen-ia8kw1zjv4hyal****',
- ],
- 'ThisRegion' => [
- 'title' => '源regionId',
- 'description' => '本端地域,即**ThisIp**所在地域。',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- 'ThisIp' => [
- 'title' => '源IP地址',
- 'description' => '本端IP地址。',
- 'type' => 'string',
- 'example' => '1.8.XX.XX',
- ],
- 'ThisPort' => [
- 'title' => '源端口号',
- 'description' => '本端端口号。',
- 'type' => 'string',
- 'example' => '80',
- ],
- 'OtherRegion' => [
- 'title' => '目的regionId',
- 'description' => '目的地域,即**OtherIp**所在地域。',
- 'type' => 'string',
- 'example' => 'ap-southeast-1',
- ],
- 'OtherIp' => [
- 'title' => '目的IP地址',
- 'description' => '对端IP地址。',
- 'type' => 'string',
- 'example' => '47.216.XX.XX',
- ],
- 'OtherPort' => [
- 'title' => '目的端口号',
- 'description' => '对端端口号。',
- 'type' => 'string',
- 'example' => '53470',
- ],
- 'Protocol' => [
- 'title' => '协议号',
- 'description' => '协议号。',
- 'type' => 'string',
- 'example' => '6',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '开始时间。',
- 'type' => 'string',
- 'example' => '2023-01-31T05:40:00Z',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '结束时间。',
- 'type' => 'string',
- 'example' => '2023-01-31T06:40:00Z',
- ],
- 'Packets' => [
- 'description' => '指定时间段内的包数总和。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '88',
- ],
- 'Bytes' => [
- 'description' => '指定时间段内的流量总和。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '188',
- ],
- 'BandwithPackageId' => [
- 'title' => '带宽包',
- 'description' => 'CEN带宽包ID。',
- 'type' => 'string',
- 'example' => 'cenbwp-ia8kw1zjv4hyal****',
- ],
+ 'ResourceType' => ['description' => '资源类型', 'type' => 'string', 'example' => 'EIP'],
],
+ 'description' => '',
],
],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalParam.TopN',
- 'errorMessage' => 'The TopN(%s) should not greater than 100.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTime',
- 'errorMessage' => 'The specified begin time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime',
- 'errorMessage' => 'It only supports querying data for up to 7 days: %s.',
- ],
- [
- 'errorCode' => 'IllegalParam.OrderBy',
- 'errorMessage' => 'The specified param of orderBy (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.Sort',
- 'errorMessage' => 'The specified Sort(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.AccountIds',
- 'errorMessage' => 'The specified parameter accountId (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.inOrOut',
- 'errorMessage' => 'Valid values for the inOrOut parameter: in and out.',
- ],
- [
- 'errorCode' => 'IllegalParam.EndTime',
- 'errorMessage' => 'The specified end time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.ThisRegion',
- 'errorMessage' => 'The specified parameter thisRegion(%s) is illegal.',
+ 'title' => '查询巡检对象产品类型列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:ListNisInspectionResourceType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'nis::2021-12-16::GetNisNetworkRanking',
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"TransitRouterFlowTopN\\": [\\n {\\n \\"AccountId\\": \\"118639953821****\\",\\n \\"CenId\\": \\"cen-ia8kw1zjv4hyal****\\",\\n \\"ThisRegion\\": \\"cn-shanghai\\",\\n \\"ThisIp\\": \\"1.8.XX.XX\\",\\n \\"ThisPort\\": \\"80\\",\\n \\"OtherRegion\\": \\"ap-southeast-1\\",\\n \\"OtherIp\\": \\"47.216.XX.XX\\",\\n \\"OtherPort\\": \\"53470\\",\\n \\"Protocol\\": \\"6\\",\\n \\"StartTime\\": \\"2023-01-31T05:40:00Z\\",\\n \\"EndTime\\": \\"2023-01-31T06:40:00Z\\",\\n \\"Packets\\": 88,\\n \\"Bytes\\": 188,\\n \\"BandwithPackageId\\": \\"cenbwp-ia8kw1zjv4hyal****\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取跨域流量详情数据排名',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"ResourceTypeList\\": [\\n {\\n \\"ResourceType\\": \\"EIP\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'CreateNetworkReachableAnalysis' => [
- 'summary' => '调用CreateNetworkReachableAnalysis接口,创建网络可达性分析任务。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListNisInspectionTaskReports' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226119',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'InspectionTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '要创建网络可达性分析的地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['title' => '巡检任务id', 'description' => '巡检任务id', 'type' => 'string', 'required' => true, 'example' => 'ni-8svmpe0yso2bhzr7fh79', 'maxLength' => 23, 'minLength' => 1],
],
[
- 'name' => 'NetworkPathId',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '网络路径ID。 您可以通过调用[CreateNetworkPath](~~2366522~~)接口获取网络路径ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'np-b2f618ceb2c84057****',
- ],
+ 'schema' => ['description' => '上一页的查询返回的值,首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj'],
],
[
- 'name' => 'Tag',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签信息。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。最多支持128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或`https://`。'."\n"
- ."\n"
- .'一次调用最多支持添加20个标签。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Team',
- ],
- 'Value' => [
- 'description' => '标签值。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。一旦输入该值,可以为空字符串。'."\n"
- ."\n"
- .'一次调用最多支持添加20个标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ops',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 21,
- ],
+ 'schema' => ['description' => '分页大小,取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'RpcResponse<NextTokenResult<ListNisInspectionTaskReportsResponse>>',
+ 'description' => 'RpcResponse<NextTokenResult<ListNisInspectionTaskReportsResponse>>',
'type' => 'object',
'properties' => [
- 'NetworkReachableAnalysisId' => [
- 'description' => '网络可达性分析任务ID。',
- 'type' => 'string',
- 'example' => 'nra-2fede05617494417****',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0D213AF9-7B8A-51A8-B411-2D797A1A447B'],
+ 'InspectionReportList' => [
+ 'description' => '巡检报告列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InspectionReportId' => ['description' => '巡检报告ID。', 'type' => 'string', 'example' => 'nir-7c3dd178738a429abe6d'],
+ ],
+ 'description' => '',
+ ],
],
+ 'TotalCount' => ['description' => '返回的条目总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '34'],
+ 'NextToken' => ['description' => '是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。', 'type' => 'string', 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj'],
+ 'MaxResults' => ['description' => '分页大小,取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IncorrectStatus.NetworkPath',
- 'errorMessage' => 'The last analysis status of %s is %s. Please try again later.',
- ],
- [
- 'errorCode' => 'QuotaExceeded.ParallelNraLimit',
- 'errorMessage' => 'The maximum number of parallel reachability analysis task is exceeded.',
- ],
- [
- 'errorCode' => 'QuotaExceeded.MaxNraCount',
- 'errorMessage' => 'The maximum number of reachability analysis task is exceeded.',
- ],
- [
- 'errorCode' => 'IllegalParam.ZoneId',
- 'errorMessage' => 'The specified available zone (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.StepMinutes',
- 'errorMessage' => 'The specified sampling interval (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTime',
- 'errorMessage' => 'The specified begin time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.EndTime',
- 'errorMessage' => 'The specified end time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'Mismatch.BeginTimeAndEndTime',
- 'errorMessage' => 'The specified begin time must be earlier than the end time.',
- ],
- [
- 'errorCode' => 'MissingParameter.TagValue',
- 'errorMessage' => 'You must specify Tag.N.Value.',
- ],
- [
- 'errorCode' => 'NumberExceed.Tags',
- 'errorMessage' => 'The maximum number of Tags is exceeded.',
- ],
- [
- 'errorCode' => 'MissingParameter.TagKey',
- 'errorMessage' => 'You must specify Tag.N.Key.',
- ],
- [
- 'errorCode' => 'Duplicate.TagKey',
- 'errorMessage' => 'The Tag.N.Key contains duplicate keys.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagKey',
- 'errorMessage' => 'The Tag.N.Key parameter is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagValue',
- 'errorMessage' => 'The Tag.N.Value parameter is invalid.',
- ],
+ ['errorCode' => 'IllegalParam.NextToken', 'errorMessage' => 'The specified nextToken(%s) is invalid.', 'description' => '指定的NextToken(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.InspectionTaskId', 'errorMessage' => 'The specified argument InspectionTaskId(%s) is illegal.', 'description' => '指定参数InspectionTaskId(%s)不合法。'],
],
404 => [
- [
- 'errorCode' => 'ResourceNotFound.NetworkPath',
- 'errorMessage' => 'The specified resource of %s is not found.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NetworkReachableAnalysisId\\": \\"nra-2fede05617494417****\\",\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\"\\n}","type":"json"}]',
- 'title' => '创建网络可达性分析任务',
- 'description' => '- **CreateNetworkReachableAnalysis**接口是对**CreateNetworkPath**接口中返回的网络路径创建可达性分析任务,并记录分析结果。'."\n"
- .' - **CreateNetworkReachableAnalysis**接口支持对同一网络路径进行多次分析。'."\n"
- .' - 一个阿里云账号(主账号)最多支持创建1000条可达性分析记录。',
- ],
- 'CreateNetworkPath' => [
- 'summary' => '调用CreateNetworkPath接口,创建网络分析路径,用于云上网络路径可达性分析。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ ['errorCode' => 'ResourceNotFound.InspectionTaskId', 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.', 'description' => '指定的InspectionTaskId(%s)不存在。'],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '116922',
- 'abilityTreeNodes' => [
- 'FEATUREnetana59X9GB',
- 'FEATUREnetana98CV3P',
- 'FEATUREnetanaWZGUR4',
- 'FEATUREnetanaDZZVCZ',
- 'FEATUREnetana0CBIRP',
- 'FEATUREnetanaJGHZ2X',
- 'FEATUREnetanaRD137H',
- 'FEATUREnetanaCAWHBE',
- 'FEATUREnetana8JUW6E',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '要创建网络分析路径的地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- 'maxLength' => 64,
- ],
- ],
- [
- 'name' => 'NetworkPathName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '路径名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs2PublicIp',
- 'maxLength' => 128,
- ],
- ],
- [
- 'name' => 'SourceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '源资源ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-2zef4ngqfarepyun****',
- ],
- ],
- [
- 'name' => 'SourceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '源资源类型。'."\n"
- ."\n"
- .' - **ecs**:云服务器ECS(Elastic Compute Service)。'."\n"
- .' - **internetIp**:公网IP地址。'."\n"
- .' - **vsw**:交换机(vSwitch)。'."\n"
- .' - **vpn**:VPN网关。'."\n"
- .' - **vbr**:边界路由器VBR(Virtual Border Router)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs',
- ],
- ],
- [
- 'name' => 'SourceIpAddress',
- 'in' => 'query',
- 'schema' => [
- 'description' => '源IP地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '172.17.XX.XX',
- ],
- ],
- [
- 'name' => 'SourcePort',
- 'in' => 'query',
- 'schema' => [
- 'description' => '源端口。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '443',
- ],
- ],
- [
- 'name' => 'TargetId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目的资源ID。'."\n"
- .'>调用该API时,TargetId参数必须输入。',
- 'type' => 'string',
- 'required' => false,
- 'minimum' => '0',
- 'example' => 'i-bp13d0e064gubm****',
- 'maxItems' => 24,
- ],
- ],
- [
- 'name' => 'TargetType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目的资源类型。'."\n"
- .' - **ecs**:云服务器ECS(Elastic Compute Service)。 '."\n"
- .'- **internetIp**:公网IP地址。'."\n"
- .' - **vsw**:交换机(vSwitch)。'."\n"
- .' - **vpn**:VPN网关。'."\n"
- .' - **vbr**:边界路由器VBR(Virtual Border Router)。'."\n"
- .' - **clb**:传统型负载均衡CLB(Classic Load Balancer)。'."\n"
- ."\n"
- .'> 调用该API时,TargetType参数必须输入。',
- 'type' => 'string',
- 'required' => false,
- 'minimum' => '0',
- 'example' => 'ecs',
- 'maxItems' => 24,
- ],
- ],
- [
- 'name' => 'TargetIpAddress',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目的IP地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.XX.XX',
- ],
- ],
- [
- 'name' => 'TargetPort',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目的端口。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '80',
- ],
- ],
- [
- 'name' => 'Protocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协议类型。取值:'."\n"
- ."\n"
- .' - **tcp**:传输控制协议。'."\n"
- .' - **udp**:用户数据报协议。'."\n"
- .' - **icmp**:网络控制报文协议。'."\n"
- .'> 调用该API时,Protocol参数必须输入。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tcp',
- 'maxLength' => 16,
- ],
- ],
- [
- 'name' => 'NetworkPathDescription',
- 'in' => 'query',
- 'schema' => [
- 'description' => '网络路径的描述信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '分析ECS到ECS路径',
- ],
- ],
- [
- 'name' => 'Tag',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签信息。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签键。最多支持128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或`https://`。'."\n"
- ."\n"
- .'一次调用最多支持添加20个标签。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'role',
- ],
- 'Value' => [
- 'description' => '标签值。最多支持输入20个标签值。一旦输入该值,可以为空字符串。'."\n"
- ."\n"
- .'最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ops',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 21,
- ],
- ],
- [
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '路径所属的资源组。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfm27qsxjj****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'NetworkPathId' => [
- 'description' => '网络路径ID。',
- 'type' => 'string',
- 'example' => 'np-4cbf598673d14d27****',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '92DD9FFB-06FB-56F7-83EF-5CEF98F5562A',
- ],
+ 'title' => '查询巡检任务报告列表',
+ 'summary' => '查询巡检任务报告列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:ListNisInspectionTaskReports',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalParam.InternetIP',
- 'errorMessage' => 'The specified IP address (%s) is not an internet IP address.',
- ],
- [
- 'errorCode' => 'IllegalParam.IP',
- 'errorMessage' => 'The specified IP address (%s) is invalid.',
- ],
- [
- 'errorCode' => 'QuotaExceeded.NetworkPath',
- 'errorMessage' => 'The quota of %s is exceeded, usage %s/%s.',
- ],
- [
- 'errorCode' => 'ResourceAlreadyExist.NetworkPath',
- 'errorMessage' => 'The specified resource of %s already exists.',
- ],
- [
- 'errorCode' => 'Mismatch.SourceIdAndTargetId',
- 'errorMessage' => 'Reachability Analyzer does not support the scenario in which source and target Internet IP addresses and ECS instance ID (%s and %s) are bound.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceAndTargetInternetIp',
- 'errorMessage' => 'Both source ID and target ID are IP addresses, but are not Internet IP addresses. Reachability Analyzer does not support the scenario.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourcePort',
- 'errorMessage' => 'The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536].',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetPort',
- 'errorMessage' => 'The specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536].',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceId',
- 'errorMessage' => 'The specified SourceId(%s) may be not exist.',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetId',
- 'errorMessage' => 'The specified TargetId(%s) may be not exist.',
- ],
- [
- 'errorCode' => 'MissingParameter.TagValue',
- 'errorMessage' => 'You must specify Tag.N.Value.',
- ],
- [
- 'errorCode' => 'NumberExceed.Tags',
- 'errorMessage' => 'The maximum number of Tags is exceeded.',
- ],
- [
- 'errorCode' => 'Duplicate.TagKey',
- 'errorMessage' => 'The Tag.N.Key contains duplicate keys.',
- ],
- [
- 'errorCode' => 'MissingParameter.TagKey',
- 'errorMessage' => 'You must specify Tag.N.Key.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagKey',
- 'errorMessage' => 'The Tag.N.Key parameter is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter.TagValue',
- 'errorMessage' => 'The Tag.N.Value parameter is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceIp',
- 'errorMessage' => 'Please enter a valid source IP.',
- ],
- [
- 'errorCode' => 'IllegalParam.Protocol',
- 'errorMessage' => 'The specified Protocol(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetType',
- 'errorMessage' => 'The specified target type (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceType',
- 'errorMessage' => 'The specified source type (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetIp',
- 'errorMessage' => 'The specified target ip (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.NotSupportHaVpn',
- 'errorMessage' => 'The specified VPN(%s), which is not currently supported for such instances.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceNotBound',
- 'errorMessage' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetNotBound',
- 'errorMessage' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.',
- ],
- [
- 'errorCode' => 'IllegalParam.NotPublicIp',
- 'errorMessage' => 'The specified (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceEqualTarget',
- 'errorMessage' => 'The specified source and destination are identical, which is not supported for analysis.',
- ],
- [
- 'errorCode' => 'IllegalParam.TypeAndIdMismatch',
- 'errorMessage' => 'The specified instanceId (%s) and type do not match.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden.NetworkPath',
- 'errorMessage' => 'The current user has not activated NIS and is not authorized to use the path analysis interface.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NetworkPathId\\": \\"np-4cbf598673d14d27****\\",\\n \\"RequestId\\": \\"92DD9FFB-06FB-56F7-83EF-5CEF98F5562A\\"\\n}","type":"json"}]',
- 'title' => '创建网络分析路径',
- 'description' => '- **CreateNetworkPath**接口支持多种组网场景以及多种资源间的路径创建,路径创建后,路径参数将被保存,便于重复分析。'."\n"
- .' - 一个阿里云账号(主账号)最多支持创建100条路径。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D213AF9-7B8A-51A8-B411-2D797A1A447B\\",\\n \\"InspectionReportList\\": [\\n {\\n \\"InspectionReportId\\": \\"nir-7c3dd178738a429abe6d\\"\\n }\\n ],\\n \\"TotalCount\\": 34,\\n \\"NextToken\\": \\"hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
- 'CreateAndAnalyzeNetworkPath' => [
- 'summary' => '调用CreateAndAnalyzeNetworkPath接口,发起网络可达性分析任务。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListNisInspectionTasks' => [
+ 'summary' => '网络巡检任务列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '178742',
- 'abilityTreeNodes' => [
- 'FEATUREnetana59X9GB',
- 'FEATUREnetana98CV3P',
- 'FEATUREnetanaWZGUR4',
- 'FEATUREnetanaDZZVCZ',
- 'FEATUREnetana0CBIRP',
- 'FEATUREnetanaJGHZ2X',
- 'FEATUREnetanaRD137H',
- 'FEATUREnetanaCAWHBE',
- 'FEATUREnetana8JUW6E',
- ],
+ 'abilityTreeCode' => '226558',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'SourceId',
+ 'name' => 'InspectionTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '源资源ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i-uf62y8khhbkbdrp6****',
- ],
+ 'schema' => ['description' => '巡检任务ID', 'type' => 'string', 'required' => false, 'example' => 'ni-8svm******hzr7fh79', 'maxLength' => 128, 'minLength' => 1],
],
[
- 'name' => 'SourceIpAddress',
+ 'name' => 'InspectionName',
'in' => 'query',
- 'schema' => [
- 'description' => '源IP地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.XX.XX',
- ],
+ 'schema' => ['description' => '巡检任务名称', 'type' => 'string', 'required' => false, 'example' => 'NIS inspection', 'maxLength' => 128, 'minLength' => 1],
],
[
- 'name' => 'TargetIpAddress',
+ 'name' => 'InspectionProject',
'in' => 'query',
'schema' => [
- 'description' => '目的IP地址。',
+ 'description' => '巡检任务采用的巡检方案类别:基础(basic)/自定义场景(customized)',
'type' => 'string',
'required' => false,
- 'example' => '172.50.XX.XX',
+ 'enumValueTitles' => ['customized' => 'customized', 'basic' => 'basic'],
+ 'example' => 'basic',
+ 'maxLength' => 64,
+ 'minLength' => 1,
],
],
[
- 'name' => 'SourceType',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'description' => '源资源类型。'."\n"
+ 'description' => '任务运行状态:'."\n"
."\n"
- .' - **ecs**:云服务器ECS(Elastic Compute Service)。'."\n"
- .' - **internetIp**:公网IP地址。'."\n"
- .' - **vsw**:交换机(vSwitch)。'."\n"
- .' - **vpn**:VPN网关。'."\n"
- .' - **vbr**:边界路由器VBR(Virtual Border Router)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs',
- ],
- ],
- [
- 'name' => 'SourcePort',
- 'in' => 'query',
- 'schema' => [
- 'description' => '源端口。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'TargetId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目的资源ID。'."\n"
+ .'Creating: 创建中'."\n"
."\n"
- .'> 调用该API时,TargetId参数必须输入。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'i-m5eactvw7wtpktv5****',
- ],
- ],
- [
- 'name' => 'TargetType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目的资源类型。'."\n"
- .' - **ecs**:云服务器ECS(Elastic Compute Service)。 '."\n"
- .'- **internetIp**:公网IP地址。'."\n"
- .' - **vsw**:交换机(vSwitch)。'."\n"
- .' - **vpn**:VPN网关。'."\n"
- .' - **vbr**:边界路由器VBR(Virtual Border Router)。'."\n"
- .' - **clb**:传统型负载均衡CLB(Classic Load Balancer)。'."\n"
+ .'Active: 已开启'."\n"
+ ."\n"
+ .'Running: 执行中'."\n"
."\n"
- .'>调用该API时,TargetType参数必须输入。',
+ .'Inactive:已关闭',
'type' => 'string',
'required' => false,
- 'example' => 'ecs',
- ],
- ],
- [
- 'name' => 'TargetPort',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目的端口。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '80',
+ 'enumValueTitles' => ['Creating' => 'Creating', 'Active' => 'Active', 'Running' => 'Running', 'Inactive' => 'Inactive'],
+ 'example' => 'Active',
+ 'maxLength' => 50,
+ 'minLength' => 1,
],
],
[
- 'name' => 'Protocol',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '协议类型。取值:'."\n"
- ."\n"
- .' - **tcp**:传输控制协议。'."\n"
- .' - **udp**:用户数据报协议。'."\n"
- .' - **icmp**:网络控制报文协议。'."\n"
- ."\n"
- .'> 调用该API时,Protocol参数必须输入。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tcp',
- ],
+ 'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'hKrS+MVXkuOgztXnvdml1/R9jhHkiH8eW3CfaOYU0CEL7yiT0zae6J8v1zYNg+d1'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '要发起网络可达性分析任务的地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => '分页大小,取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'RpcResponse<ListNisInspectTasksResponse>',
+ 'description' => 'RpcResponse<ListNisInspectTasksResponse>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B',
- ],
- 'NetworkReachableAnalysisId' => [
- 'description' => '发起的网络可达性分析任务ID。',
- 'type' => 'string',
- 'example' => 'nra-dfe9e53d2b524568****',
- ],
- 'SourceId' => [
- 'description' => '源资源ID。',
- 'type' => 'string',
- 'example' => 'i-uf62y8khhbkbdrp6****',
- ],
- 'TargetId' => [
- 'description' => '目的资源ID。',
- 'type' => 'string',
- 'example' => 'i-m5eactvw7wtpktv5****',
- ],
- 'SourceType' => [
- 'description' => '源资源类型。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'TargetType' => [
- 'description' => '目的资源类型。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'SourcePort' => [
- 'description' => '源端口。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'TargetPort' => [
- 'description' => '目的端口。',
- 'type' => 'string',
- 'example' => '80',
- ],
- 'Protocol' => [
- 'description' => '协议类型。',
- 'type' => 'string',
- 'example' => 'tcp',
- ],
- 'SourceIpAddress' => [
- 'description' => '源IP地址。',
- 'type' => 'string',
- 'example' => '192.168.XX.XX',
- ],
- 'TargetIpAddress' => [
- 'description' => '目的IP地址。',
- 'type' => 'string',
- 'example' => '172.50.XX.XX',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
+ 'InspectionTaskList' => [
+ 'description' => '巡检任务列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InspectionTaskId' => ['description' => '巡检任务ID', 'type' => 'string', 'example' => 'ni-8svm******hzr7fh79'],
+ 'InspectionName' => ['description' => '巡检任务名称', 'type' => 'string', 'example' => 'NIS inspection'],
+ 'Status' => ['description' => '任务运行状态:'."\n"
+ ."\n"
+ .'Creating: 创建中'."\n"
+ ."\n"
+ .'Active: 已开启'."\n"
+ ."\n"
+ .'Running: 执行中'."\n"
+ ."\n"
+ .'Inactive:已关闭', 'type' => 'string', 'example' => 'Active'],
+ 'InspectionProject' => ['description' => '巡检任务采用的巡检方案类别:基础(basic)/自定义场景(customized)', 'type' => 'string', 'example' => 'basic'],
+ 'CreateTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2024-06-18 00:14:46'],
+ 'LastUpdateReportId' => ['description' => '最新报告ID', 'type' => 'string', 'example' => 'nir-b4c4c9******8a25e'],
+ ],
+ 'description' => '',
+ ],
],
+ 'NextToken' => ['description' => '是否拥有下一次查询的令牌(Token)。取值:如果NextToken为空表示没有下一次查询。 如果NextToken有返回值,该取值表示下一次查询开始的令牌。', 'type' => 'string', 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj'],
+ 'MaxResults' => ['description' => '分页大小,取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['description' => '返回的条目总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParam.InternetIP',
- 'errorMessage' => 'The specified IP address (%s) is not an internet IP address.',
- ],
- [
- 'errorCode' => 'IllegalParam.IP',
- 'errorMessage' => 'The specified IP address (%s) is invalid.',
- ],
- [
- 'errorCode' => 'Mismatch.SourceIdAndTargetId',
- 'errorMessage' => 'Reachability Analyzer does not support the scenario in which source and target Internet IP addresses and ECS instance ID (%s and %s) are bound.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceAndTargetInternetIp',
- 'errorMessage' => 'Both source ID and target ID are IP addresses, but are not Internet IP addresses. Reachability Analyzer does not support the scenario.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourcePort',
- 'errorMessage' => 'The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536].',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetPort',
- 'errorMessage' => 'The specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536].',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceId',
- 'errorMessage' => 'The specified SourceId(%s) may be not exist.',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetId',
- 'errorMessage' => 'The specified TargetId(%s) may be not exist.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceIp',
- 'errorMessage' => 'Please enter a valid source IP.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceType',
- 'errorMessage' => 'The specified source type (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.Protocol',
- 'errorMessage' => 'The specified Protocol(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetType',
- 'errorMessage' => 'The specified target type (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetIp',
- 'errorMessage' => 'The specified target ip (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.NotSupportHaVpn',
- 'errorMessage' => 'The specified VPN(%s), which is not currently supported for such instances.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceNotBound',
- 'errorMessage' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.',
- ],
- [
- 'errorCode' => 'IllegalParam.TargetNotBound',
- 'errorMessage' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.',
- ],
- [
- 'errorCode' => 'IllegalParam.NotPublicIp',
- 'errorMessage' => 'The specified (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.SourceEqualTarget',
- 'errorMessage' => 'The specified source and destination are identical, which is not supported for analysis.',
- ],
- [
- 'errorCode' => 'IllegalParam.TypeAndIdMismatch',
- 'errorMessage' => 'The specified instanceId (%s) and type do not match.',
- ],
+ ['errorCode' => 'IllegalParam.NextToken', 'errorMessage' => 'The specified argument NextToken(%s) is illegal.', 'description' => '指定的参数NextToken(%s)不合法。'."\n"],
+ ['errorCode' => 'IllegalParam.Status', 'errorMessage' => 'The specified Status(%s) parameter is illegal.', 'description' => '指定的Status(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.InspectionProject', 'errorMessage' => 'The specified argument InspectionProject(%s) is illegal.', 'description' => '指定的参数InspectionProject不合法。'],
],
- 403 => [
- [
- 'errorCode' => 'Forbidden.NetworkPath',
- 'errorMessage' => 'The current user has not activated NIS and is not authorized to use the path analysis interface.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"InspectionTaskList\\": [\\n {\\n \\"InspectionTaskId\\": \\"ni-8svm******hzr7fh79\\",\\n \\"InspectionName\\": \\"NIS inspection\\",\\n \\"Status\\": \\"Active\\",\\n \\"InspectionProject\\": \\"basic\\",\\n \\"CreateTime\\": \\"2024-06-18 00:14:46\\",\\n \\"LastUpdateReportId\\": \\"nir-b4c4c9******8a25e\\"\\n }\\n ],\\n \\"NextToken\\": \\"hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 5\\n}","type":"json"}]',
+ 'title' => '查询巡检任务列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:ListNisInspectionTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"NetworkReachableAnalysisId\\": \\"nra-dfe9e53d2b524568****\\",\\n \\"SourceId\\": \\"i-uf62y8khhbkbdrp6****\\",\\n \\"TargetId\\": \\"i-m5eactvw7wtpktv5****\\",\\n \\"SourceType\\": \\"ecs\\",\\n \\"TargetType\\": \\"ecs\\",\\n \\"SourcePort\\": \\"0\\",\\n \\"TargetPort\\": \\"80\\",\\n \\"Protocol\\": \\"tcp\\",\\n \\"SourceIpAddress\\": \\"192.168.XX.XX\\",\\n \\"TargetIpAddress\\": \\"172.50.XX.XX\\"\\n}","type":"json"}]',
- 'title' => '发起网络可达性分析任务',
- 'description' => '该接口根据输入的源和目的信息,无需创建网络分析路径,直接发起可达性分析任务。返回分析结果后,将不在系统中记录,如需在NIS中留存网络路径或可达性分析任务结果,建议使用**createNetworkReachableAnalysis**接口。',
],
- 'DeleteNetworkPath' => [
- 'summary' => '删除网络分析路径。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartNisInspectionTask' => [
+ 'summary' => '触发一次巡检任务,产生巡检报告。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '116931',
- 'abilityTreeNodes' => [
- 'FEATUREnetana59X9GB',
- 'FEATUREnetana98CV3P',
- 'FEATUREnetanaWZGUR4',
- 'FEATUREnetanaDZZVCZ',
- 'FEATUREnetana0CBIRP',
- 'FEATUREnetanaJGHZ2X',
- 'FEATUREnetanaRD137H',
- 'FEATUREnetanaCAWHBE',
- 'FEATUREnetana8JUW6E',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '227070',
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '要删除的网络分析路径的地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
- ],
- [
- 'name' => 'NetworkPathIds',
+ 'name' => 'InspectionTaskId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '网络分析路径集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '您可以通过调用[CreateNetworkPath](~~2366522~~)接口获取网络分析路径ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'np-10c31b7aca0e4486****',
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '巡检任务id', 'description' => '巡检任务ID。', 'type' => 'string', 'required' => true, 'example' => 'ni-8svmpe0yso****r7fh79', 'maxLength' => 128, 'minLength' => 1],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'RpcResponse<StartNisInspectionTaskResponse>',
+ 'description' => 'RpcResponse<StartNisInspectionTaskResponse>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C4331873-C534-590F-A905-F66C53B88A47',
- ],
- 'Data' => [
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
+ 'InspectionReportId' => ['description' => '巡检报告ID。', 'type' => 'string', 'example' => 'nir-9923e262c106461d****'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParam.DiskCategory',
- 'errorMessage' => 'The specified disk category (%s) is invalid.',
- ],
- [
- 'errorCode' => 'SizeExceeds.Zones',
- 'errorMessage' => 'The length of the specified available zones exceeds the limit.',
- ],
- [
- 'errorCode' => 'SizeExceeds.DiskCategories',
- 'errorMessage' => 'The length of the specified disk categories exceeds the limit.',
- ],
- [
- 'errorCode' => 'OperationDenied.ZonesConflict',
- 'errorMessage' => 'The specified available zones do not belong to the same region.',
- ],
- [
- 'errorCode' => 'IllegalParam.ZoneId',
- 'errorMessage' => 'The specified available zone (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.StepMinutes',
- 'errorMessage' => 'The specified sampling interval (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTime',
- 'errorMessage' => 'The specified begin time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.EndTime',
- 'errorMessage' => 'The specified end time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'Mismatch.BeginTimeAndEndTime',
- 'errorMessage' => 'The specified begin time must be earlier than the end time.',
- ],
- [
- 'errorCode' => 'IllegalParam.NetworkPathId',
- 'errorMessage' => 'The parameter (%s) cannot be empty.',
- ],
+ ['errorCode' => 'IncorrectStatus.InspectionTaskNotActive', 'errorMessage' => 'The specified task InspectionTaskId(%s) is not active and cannot be executed.', 'description' => '指定的任务InspectionTaskId(%s)不是开启状态不支持执行'],
+ ['errorCode' => 'DuplicatedParam.InspectionReportId', 'errorMessage' => 'Specified InspectionReportId(%s) duplicated in task.', 'description' => '指定的InspectionReportId(%s)在任务中重复.'],
],
- 403 => [
- [
- 'errorCode' => 'Forbidden.NetworkPathId',
- 'errorMessage' => 'The user does not have permission on the instance parameter (%s).',
- ],
+ 404 => [
+ ['errorCode' => 'ResourceNotFound.InspectionTaskId', 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.', 'description' => '指定的InspectionTaskId(%s)不存在。'],
+ ['errorCode' => 'ResourceNotFound.InspectionResource', 'errorMessage' => 'The specified InspectionTaskId(%s) resource does not exist.', 'description' => '指定的InspectionTaskId(%s)资源不存在.'],
],
- [
- [
- 'errorCode' => 'ResourceNotFound.NetworkPathId',
- 'errorMessage' => 'The instance resource (%s) does not exist.',
+ ],
+ 'title' => '发起巡检任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:StartNisInspectionTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4331873-C534-590F-A905-F66C53B88A47\\",\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '删除网络分析路径',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"InspectionReportId\\": \\"nir-9923e262c106461d****\\"\\n}","type":"json"}]',
],
- 'DeleteNetworkReachableAnalysis' => [
- 'summary' => '调用DeleteNetworkReachableAnalysis接口,删除网络可达性分析任务。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartNisTrafficRanking' => [
+ 'summary' => '触发NIS流量分析器执行指定范围内的流量排序任务。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '116935',
- 'abilityTreeNodes' => [
- 'FEATUREnetana59X9GB',
- 'FEATUREnetana98CV3P',
- 'FEATUREnetanaWZGUR4',
- 'FEATUREnetanaDZZVCZ',
- 'FEATUREnetana0CBIRP',
- 'FEATUREnetanaJGHZ2X',
- 'FEATUREnetanaRD137H',
- 'FEATUREnetanaCAWHBE',
- 'FEATUREnetana8JUW6E',
- ],
+ 'abilityTreeCode' => '222984',
+ 'abilityTreeNodes' => ['FEATUREnetana5MCZ6K', 'FEATUREnetanaOV20CD', 'FEATUREnetanaB9LIVJ', 'FEATUREnetanaCEA895'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'RegionNo',
'in' => 'query',
- 'schema' => [
- 'description' => '网络可达性分析任务的地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['title' => '资源所在地域。', 'description' => '资源所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
],
[
- 'name' => 'NetworkReachableAnalysisIds',
+ 'name' => 'TrafficAnalyzerId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '网络可达性分析任务ID集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '网络可达性分析任务ID。您可以通过调用[CreateNetworkReachableAnalysis](~~2366521~~)接口获取网络可达性分析任务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[\\"nra-be3cff6bed3049f5****\\"]',
- ],
- 'required' => true,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '4838F3F2-30E1-5D82-B25A-B9FE33BC3E25',
- ],
- 'Data' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalParam.DiskCategory',
- 'errorMessage' => 'The specified disk category (%s) is invalid.',
- ],
- [
- 'errorCode' => 'SizeExceeds.Zones',
- 'errorMessage' => 'The length of the specified available zones exceeds the limit.',
- ],
- [
- 'errorCode' => 'SizeExceeds.DiskCategories',
- 'errorMessage' => 'The length of the specified disk categories exceeds the limit.',
- ],
- [
- 'errorCode' => 'OperationDenied.ZonesConflict',
- 'errorMessage' => 'The specified available zones do not belong to the same region.',
- ],
- [
- 'errorCode' => 'IllegalParam.ZoneId',
- 'errorMessage' => 'The specified available zone (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.StepMinutes',
- 'errorMessage' => 'The specified sampling interval (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTime',
- 'errorMessage' => 'The specified begin time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.EndTime',
- 'errorMessage' => 'The specified end time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'Mismatch.BeginTimeAndEndTime',
- 'errorMessage' => 'The specified begin time must be earlier than the end time.',
- ],
- [
- 'errorCode' => 'IllegalParam.NetworkReachableAnalysisId',
- 'errorMessage' => 'The parameter (%s) cannot be empty.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden.NetworkReachableAnalysisId',
- 'errorMessage' => 'The user does not have permission on the instance parameter (%s).',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound.NetworkReachableAnalysisId',
- 'errorMessage' => 'The instance resource (%s) does not exist.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4838F3F2-30E1-5D82-B25A-B9FE33BC3E25\\",\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '删除网络可达性分析任务',
- ],
- 'GetNetworkReachableAnalysis' => [
- 'summary' => '调用GetNetworkReachableAnalysis接口,获取网络可达性分析结果。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'schema' => ['title' => '资源所在地域。', 'description' => '流量分析器ID。', 'type' => 'string', 'required' => true, 'example' => 'nta-262****ca07f'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREnetana59X9GB',
- 'FEATUREnetana98CV3P',
- 'FEATUREnetanaWZGUR4',
- 'FEATUREnetanaDZZVCZ',
- 'FEATUREnetana0CBIRP',
- 'FEATUREnetanaJGHZ2X',
- 'FEATUREnetanaRD137H',
- 'FEATUREnetanaCAWHBE',
- 'FEATUREnetana8JUW6E',
- ],
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'TupleDimension',
'in' => 'query',
+ 'allowEmptyValue' => true,
'schema' => [
- 'description' => '网络可达性分析任务的地域ID。',
+ 'title' => '资源所在地域。',
+ 'description' => '流量存储聚合维度。'."\n"
+ ."\n"
+ .'根据TraffficScenario场景:'."\n"
+ ."\n"
+ .'- VpcFlowLogAll/VpcFlowLog:必传,用于指定查询特定的存储聚合视图,和流量分析器中配置的存储聚合属性对应。'."\n"
+ ."\n"
+ .'- TRFlowLog/CbwpMetric:非必传,根据流量分析器存储聚合属性自适应。',
'type' => 'string',
'required' => false,
- 'example' => 'cn-shanghai',
+ 'enumValueTitles' => ['Tuple5' => '五元组', 'Tuple1' => '一元组', 'Tuple2' => '二元组'],
+ 'example' => 'Tuple1',
+ 'enum' => ['Tuple1', 'Tuple2', 'Tuple5'],
],
],
[
- 'name' => 'NetworkReachableAnalysisId',
+ 'name' => 'TrafficScenario',
'in' => 'query',
'schema' => [
- 'description' => '网络可达性分析任务ID。 您可以通过调用**CreateNetworkRearchableAnalysis**接口获取网络可达性分析ID。',
+ 'title' => '按流量转发所使用的阿里云网络资源类型进行分析,枚举如下:'."\n"
+ .'AccessInternetIPV4:所有阿里云公网类型IPV4。'."\n"
+ .'AccessInternetIPV4Limited:所有受地域限速的阿里云公网类型IPV4。'."\n"
+ .'ElasticIP: 弹性公网EIP(IPV4)。'."\n"
+ .'PublicIpEcs: 绑定在ECS的固定公网IP(IPV4)。'."\n"
+ .'PublicIpClb: 绑定在CLB的固定公网IP(IPV4)。'."\n"
+ .'GA:全球加速。'."\n"
+ .'NAT:通过SNAT的访问公网流量。'."\n"
+ .'TR:流经云企业网转发路由器的流量。'."\n"
+ .'TRAttachment:流经云企业网连接实例的流量,包括地域内连接和跨地域连接。'."\n"
+ .'VBR:流经边界路由器的流量。'."\n"
+ .'GA:流经全球加速的流量。'."\n"
+ .'ECR:流经ECR的流量。'."\n"
+ .'VPC:流经VPC的流量。'."\n"
+ .'InternetProbing: 公网探测数据。'."\n"
+ .'IntranetProbing: 内网探测数据。',
+ 'description' => '支持分析场景: '."\n"
+ ."\n"
+ .'- 全部VPC流日志分析'."\n"
+ .'- 公网VPC流日志分析'."\n"
+ .'- 全部TR流日志分析'."\n"
+ .'- 共享带宽指标分析',
'type' => 'string',
'required' => true,
- 'example' => 'nra-90eef36a9e6e4662****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'NetworkPathId' => [
- 'description' => '创建的网络实例的路径ID。',
- 'type' => 'string',
- 'example' => 'np-2a1332214fa346b6****',
- ],
- 'NetworkReachableAnalysisId' => [
- 'description' => '网络可达性分析任务ID。',
- 'type' => 'string',
- 'example' => 'nra-8607514e71c1484****',
- ],
- 'NetworkReachableAnalysisStatus' => [
- 'description' => '网络可达性分析任务的状态。取值:'."\n"
- .'- **init**:初始化。'."\n"
- .'- **finish**:已完成。'."\n"
- .'- **error**:分析错误。'."\n"
- .'- **timeout**:已超时。',
- 'type' => 'string',
- 'example' => 'finish',
- ],
- 'NetworkReachableAnalysisResult' => [
- 'description' => '用于展示网络可达性分析结果,包括网络路径拓扑、网络不可达错误码、网络不可达规则等。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "errorCode": "",'."\n"
- .' "networkAclData": {'."\n"
- .' "networkAclItems": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "nraId": "nra-f2c8701a36424094****",'."\n"
- .' "requestId": "B931F8A0-620E-5230-B77F-3BD7F612****",'."\n"
- .' "routeData": {'."\n"
- .' "routeItems": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "securityGroupData": {'."\n"
- .' "policy": "accept",'."\n"
- .' "securityGroupItems": ['."\n"
- .' {'."\n"
- .' "description": "default_sg_access_rule",'."\n"
- .' "matchedRule": {'."\n"
- .' "bizProtocol": "ALL",'."\n"
- .' "creatingTime": "2022-11-10T03:24:49Z",'."\n"
- .' "description": "",'."\n"
- .' "destinationCidr": "",'."\n"
- .' "destinationGroupId": "sg-wz980j96p8y99co5****",'."\n"
- .' "direction": "egress",'."\n"
- .' "policy": "Accept",'."\n"
- .' "portRange": "-1/-1",'."\n"
- .' "priority": "1",'."\n"
- .' "sourceCidr": "",'."\n"
- .' "sourceGroupId": ""'."\n"
- .' },'."\n"
- .' "policy": "accept",'."\n"
- .' "resourceId": "eni-wz92ce4saz1jzazg****",'."\n"
- .' "securityGroupId": "sg-wz980j96p8y99co5****"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "description": "user_acl_drop_rule",'."\n"
- .' "matchedRule": {'."\n"
- .' "bizProtocol": "",'."\n"
- .' "creatingTime": "",'."\n"
- .' "description": "",'."\n"
- .' "destinationCidr": "",'."\n"
- .' "destinationGroupId": "",'."\n"
- .' "direction": "",'."\n"
- .' "policy": "",'."\n"
- .' "portRange": "",'."\n"
- .' "priority": "",'."\n"
- .' "sourceCidr": "",'."\n"
- .' "sourceGroupId": ""'."\n"
- .' },'."\n"
- .' "policy": "",'."\n"
- .' "resourceId": "eni-wz97vry93t6z4lbd****",'."\n"
- .' "securityGroupId": "sg-wz980j96p8y99co****"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "securityGroupReportId": "sgr-4479d23bb37241aab****"'."\n"
- .' },'."\n"
- .' "status": "security_group_checking_target",'."\n"
- .' "topologyData": {'."\n"
- .' "positive": {'."\n"
- .' "linkList": ['."\n"
- .' {'."\n"
- .' "id": "i-wz91dk7bor557hp93zyv-->eni-wz92ce4saz1jzazg****",'."\n"
- .' "source": "i-wz91dk7bor557hp9****",'."\n"
- .' "target": "eni-wz92ce4saz1jzazg****"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "id": "eni-wz92ce4saz1jzazgi13d-->vsw-wz9slpwdcppwfrnee****",'."\n"
- .' "source": "eni-wz92ce4saz1jzazg****",'."\n"
- .' "target": "vsw-wz9slpwdcppwfrnee****"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "id": "vsw-wz9slpwdcppwfrneebcrp-->eni-wz97vry93t6z4lbd****",'."\n"
- .' "source": "vsw-wz9slpwdcppwfrnee****",'."\n"
- .' "target": "eni-wz97vry93t6z4lbd****"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "id": "eni-wz97vry93t6z4lbdgmfi-->i-wz91dk7bor557hp9****",'."\n"
- .' "source": "eni-wz97vry93t6z4lbd****",'."\n"
- .' "target": "i-wz91dk7bor557hp9****"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "nodeList": ['."\n"
- .' {'."\n"
- .' "aZone": "cn-shenzhen-d",'."\n"
- .' "bizInsId": "i-wz91dk7bor557hp9****",'."\n"
- .' "id": "i-wz91dk7bor557hp9****",'."\n"
- .' "level": 1,'."\n"
- .' "matchedRoute": {'."\n"
- .' "nextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "nodeType": "VM",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "trafficLogs": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "aZone": "cn-shenzhen-d",'."\n"
- .' "bizInsId": "i-wz91dk7bor557hp9****",'."\n"
- .' "id": "i-wz91dk7bor557hp9****",'."\n"
- .' "level": 3,'."\n"
- .' "matchedRoute": {'."\n"
- .' "nextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "nodeType": "VM",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "trafficLogs": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "aZone": "cn-shenzhen-d",'."\n"
- .' "bizInsId": "vsw-wz9slpwdcppwfrnee****",'."\n"
- .' "cidr": "192.168.0.0/24",'."\n"
- .' "id": "vsw-wz9slpwdcppwfrnee****",'."\n"
- .' "level": 2,'."\n"
- .' "matchedRoute": {'."\n"
- .' "nextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "nodeType": "VSW",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "trafficLogs": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "bizInsId": "eni-wz92ce4saz1jzazg****",'."\n"
- .' "id": "eni-wz92ce4saz1jzazg****",'."\n"
- .' "ip": "192.168.0.33",'."\n"
- .' "mac": "00:XXXX:3e:16:7c:50",'."\n"
- .' "matchedRoute": {'."\n"
- .' "nextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "nodeType": "ENI",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "status": "InUse",'."\n"
- .' "trafficLogs": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "bizInsId": "eni-wz97vry93t6z4lbd****",'."\n"
- .' "id": "eni-wz97vry93t6z4lbd****",'."\n"
- .' "ip": "192.168.0.34",'."\n"
- .' "mac": "00:XXXX:3e:14:70:c2",'."\n"
- .' "matchedRoute": {'."\n"
- .' "nextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "nodeType": "ENI",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "status": "InUse",'."\n"
- .' "trafficLogs": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "reverse": {'."\n"
- .' "revLinkList": ['."\n"
- .' {'."\n"
- .' "id": "i-wz91dk7bor557hp93zys-->eni-wz97vry93t6z4lbd****",'."\n"
- .' "source": "i-wz91dk7bor557hp9****",'."\n"
- .' "target": "eni-wz97vry93t6z4lbd****"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "id": "eni-wz97vry93t6z4lbdgmfi-->vsw-wz9slpwdcppwfrnee****",'."\n"
- .' "source": "eni-wz97vry93t6z4lbd****",'."\n"
- .' "target": "vsw-wz9slpwdcppwfrnee****"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "id": "vsw-wz9slpwdcppwfrneebcrp-->eni-wz92ce4saz1jzazg****",'."\n"
- .' "source": "vsw-wz9slpwdcppwfrnee****",'."\n"
- .' "target": "eni-wz92ce4saz1jzazg****"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "id": "eni-wz92ce4saz1jzazgi13d-->i-wz91dk7bor557hp9****",'."\n"
- .' "source": "eni-wz92ce4saz1jzazg****",'."\n"
- .' "target": "i-wz91dk7bor557hp9****"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "revNodeList": ['."\n"
- .' {'."\n"
- .' "aZone": "cn-shenzhen-d",'."\n"
- .' "bizInsId": "i-wz91dk7bor557hp9****",'."\n"
- .' "id": "i-wz91dk7bor557hp9****",'."\n"
- .' "level": 1,'."\n"
- .' "nodeType": "VM",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "revMatchedRoute": {'."\n"
- .' "revNextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' }'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "aZone": "cn-shenzhen-d",'."\n"
- .' "bizInsId": "i-wz91dk7bor557hp9****",'."\n"
- .' "id": "i-wz91dk7bor557hp9****",'."\n"
- .' "level": 3,'."\n"
- .' "nodeType": "VM",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "revMatchedRoute": {'."\n"
- .' "revNextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' }'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "aZone": "cn-shenzhen-d",'."\n"
- .' "bizInsId": "vsw-wz9slpwdcppwfrnee****",'."\n"
- .' "cidr": "192.168.0.0/24",'."\n"
- .' "id": "vsw-wz9slpwdcppwfrnee****",'."\n"
- .' "level": 2,'."\n"
- .' "nodeType": "VSW",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "revMatchedRoute": {'."\n"
- .' "revNextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' }'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "bizInsId": "eni-wz97vry93t6z4lbd****",'."\n"
- .' "id": "eni-wz97vry93t6z4lbd****",'."\n"
- .' "ip": "192.168.0.34",'."\n"
- .' "mac": "00:XXXX:3e:14:70:c2",'."\n"
- .' "nodeType": "ENI",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "revMatchedRoute": {'."\n"
- .' "revNextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "status": "InUse"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "bizInsId": "eni-wz92ce4saz1jzazg****",'."\n"
- .' "id": "eni-wz92ce4saz1jzazg****",'."\n"
- .' "ip": "192.168.0.33",'."\n"
- .' "mac": "00:XXXX:3e:16:7c:50",'."\n"
- .' "nodeType": "ENI",'."\n"
- .' "regionNo": "cn-shenzhen-st3-a01",'."\n"
- .' "regionNoAlias": "cn-shenzhen",'."\n"
- .' "revMatchedRoute": {'."\n"
- .' "revNextHopSet": ['."\n"
- .' '."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "status": "InUse"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "topologyReportId": "tpr-21cf60002715491b8****"'."\n"
- .' }'."\n"
- .'}',
- ],
- 'Reachable' => [
- 'description' => '网络路径是否可达。取值:'."\n"
- .'- **true**:可达。'."\n"
- .'- **false**:不可达。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2023-03-16T07:11:27Z',
- ],
- 'AliUid' => [
- 'description' => '用户UID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123147627844****',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DEE0FEAF-59AE-5CDD-AA07-626BC365D571',
- ],
- 'NetworkPathParameter' => [
- 'description' => '网络路径详细参数。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "sourceId": "i-bp100g5pbp6kj4p9****",'."\n"
- .' "sourceType": "ecs",'."\n"
- .' "targetId": "i-t4n4ltwgbbomzb0g****",'."\n"
- .' "targetType": "ecs"'."\n"
- .'}',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'SizeExceeds.Zones',
- 'errorMessage' => 'The length of the specified available zones exceeds the limit.',
- ],
- [
- 'errorCode' => 'SizeExceeds.DiskCategories',
- 'errorMessage' => 'The length of the specified disk categories exceeds the limit.',
- ],
- [
- 'errorCode' => 'OperationDenied.ZonesConflict',
- 'errorMessage' => 'The specified available zones do not belong to the same region.',
- ],
- [
- 'errorCode' => 'IllegalParam.ZoneId',
- 'errorMessage' => 'The specified available zone (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.StepMinutes',
- 'errorMessage' => 'The specified sampling interval (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.BeginTime',
- 'errorMessage' => 'The specified begin time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.EndTime',
- 'errorMessage' => 'The specified end time (%s) is invalid.',
- ],
- [
- 'errorCode' => 'Mismatch.BeginTimeAndEndTime',
- 'errorMessage' => 'The specified begin time must be earlier than the end time.',
- ],
- [
- 'errorCode' => 'OperationDenied.NetworkReachableAnalysis',
- 'errorMessage' => 'The operation is not allowed because of invalid parameters.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden.NetworkReachableAnalysisId',
- 'errorMessage' => 'The user does not have permission on the instance parameter (%s).',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound.NetworkReachableAnalysisId',
- 'errorMessage' => 'The instance resource (%s) does not exist.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.NetworkReachableAnalysis',
- 'errorMessage' => 'The specified resource of %s is not found.',
+ 'example' => 'VpcFlowLogAll',
+ 'enum' => ['VpcFlowLogAll', 'VpcFlowLogInternet', 'TRFlowLog', 'CbwpMetric'],
],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NetworkPathId\\": \\"np-2a1332214fa346b6****\\",\\n \\"NetworkReachableAnalysisId\\": \\"nra-8607514e71c1484****\\",\\n \\"NetworkReachableAnalysisStatus\\": \\"finish\\",\\n \\"NetworkReachableAnalysisResult\\": \\"{\\\\n \\\\\\"errorCode\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"networkAclData\\\\\\": {\\\\n \\\\\\"networkAclItems\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nraId\\\\\\": \\\\\\"nra-f2c8701a36424094****\\\\\\",\\\\n \\\\\\"requestId\\\\\\": \\\\\\"B931F8A0-620E-5230-B77F-3BD7F612****\\\\\\",\\\\n \\\\\\"routeData\\\\\\": {\\\\n \\\\\\"routeItems\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"securityGroupData\\\\\\": {\\\\n \\\\\\"policy\\\\\\": \\\\\\"accept\\\\\\",\\\\n \\\\\\"securityGroupItems\\\\\\": [\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"default_sg_access_rule\\\\\\",\\\\n \\\\\\"matchedRule\\\\\\": {\\\\n \\\\\\"bizProtocol\\\\\\": \\\\\\"ALL\\\\\\",\\\\n \\\\\\"creatingTime\\\\\\": \\\\\\"2022-11-10T03:24:49Z\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"destinationCidr\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"destinationGroupId\\\\\\": \\\\\\"sg-wz980j96p8y99co5****\\\\\\",\\\\n \\\\\\"direction\\\\\\": \\\\\\"egress\\\\\\",\\\\n \\\\\\"policy\\\\\\": \\\\\\"Accept\\\\\\",\\\\n \\\\\\"portRange\\\\\\": \\\\\\"-1/-1\\\\\\",\\\\n \\\\\\"priority\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"sourceCidr\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sourceGroupId\\\\\\": \\\\\\"\\\\\\"\\\\n },\\\\n \\\\\\"policy\\\\\\": \\\\\\"accept\\\\\\",\\\\n \\\\\\"resourceId\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"securityGroupId\\\\\\": \\\\\\"sg-wz980j96p8y99co5****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"user_acl_drop_rule\\\\\\",\\\\n \\\\\\"matchedRule\\\\\\": {\\\\n \\\\\\"bizProtocol\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"creatingTime\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"destinationCidr\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"destinationGroupId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"direction\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"policy\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"portRange\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"priority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sourceCidr\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sourceGroupId\\\\\\": \\\\\\"\\\\\\"\\\\n },\\\\n \\\\\\"policy\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"resourceId\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"securityGroupId\\\\\\": \\\\\\"sg-wz980j96p8y99co****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"securityGroupReportId\\\\\\": \\\\\\"sgr-4479d23bb37241aab****\\\\\\"\\\\n },\\\\n \\\\\\"status\\\\\\": \\\\\\"security_group_checking_target\\\\\\",\\\\n \\\\\\"topologyData\\\\\\": {\\\\n \\\\\\"positive\\\\\\": {\\\\n \\\\\\"linkList\\\\\\": [\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp93zyv-->eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz92ce4saz1jzazgi13d-->vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrneebcrp-->eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz97vry93t6z4lbdgmfi-->i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"nodeList\\\\\\": [\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"level\\\\\\": 1,\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VM\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"level\\\\\\": 3,\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VM\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"cidr\\\\\\": \\\\\\"192.168.0.0/24\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"level\\\\\\": 2,\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VSW\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"192.168.0.33\\\\\\",\\\\n \\\\\\"mac\\\\\\": \\\\\\"00:XXXX:3e:16:7c:50\\\\\\",\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"ENI\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"status\\\\\\": \\\\\\"InUse\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"192.168.0.34\\\\\\",\\\\n \\\\\\"mac\\\\\\": \\\\\\"00:XXXX:3e:14:70:c2\\\\\\",\\\\n \\\\\\"matchedRoute\\\\\\": {\\\\n \\\\\\"nextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"ENI\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"status\\\\\\": \\\\\\"InUse\\\\\\",\\\\n \\\\\\"trafficLogs\\\\\\": [\\\\n \\\\n ]\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"reverse\\\\\\": {\\\\n \\\\\\"revLinkList\\\\\\": [\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp93zys-->eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz97vry93t6z4lbdgmfi-->vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrneebcrp-->eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz92ce4saz1jzazgi13d-->i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"revNodeList\\\\\\": [\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"level\\\\\\": 1,\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VM\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"i-wz91dk7bor557hp9****\\\\\\",\\\\n \\\\\\"level\\\\\\": 3,\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VM\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"aZone\\\\\\": \\\\\\"cn-shenzhen-d\\\\\\",\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"cidr\\\\\\": \\\\\\"192.168.0.0/24\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"vsw-wz9slpwdcppwfrnee****\\\\\\",\\\\n \\\\\\"level\\\\\\": 2,\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"VSW\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz97vry93t6z4lbd****\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"192.168.0.34\\\\\\",\\\\n \\\\\\"mac\\\\\\": \\\\\\"00:XXXX:3e:14:70:c2\\\\\\",\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"ENI\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"status\\\\\\": \\\\\\"InUse\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"bizInsId\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"eni-wz92ce4saz1jzazg****\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"192.168.0.33\\\\\\",\\\\n \\\\\\"mac\\\\\\": \\\\\\"00:XXXX:3e:16:7c:50\\\\\\",\\\\n \\\\\\"nodeType\\\\\\": \\\\\\"ENI\\\\\\",\\\\n \\\\\\"regionNo\\\\\\": \\\\\\"cn-shenzhen-st3-a01\\\\\\",\\\\n \\\\\\"regionNoAlias\\\\\\": \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"revMatchedRoute\\\\\\": {\\\\n \\\\\\"revNextHopSet\\\\\\": [\\\\n \\\\n ]\\\\n },\\\\n \\\\\\"status\\\\\\": \\\\\\"InUse\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"topologyReportId\\\\\\": \\\\\\"tpr-21cf60002715491b8****\\\\\\"\\\\n }\\\\n}\\",\\n \\"Reachable\\": true,\\n \\"CreateTime\\": \\"2023-03-16T07:11:27Z\\",\\n \\"AliUid\\": 0,\\n \\"RequestId\\": \\"DEE0FEAF-59AE-5CDD-AA07-626BC365D571\\",\\n \\"NetworkPathParameter\\": \\"{\\\\n \\\\\\"sourceId\\\\\\": \\\\\\"i-bp100g5pbp6kj4p9****\\\\\\",\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"ecs\\\\\\",\\\\n \\\\\\"targetId\\\\\\": \\\\\\"i-t4n4ltwgbbomzb0g****\\\\\\",\\\\n \\\\\\"targetType\\\\\\": \\\\\\"ecs\\\\\\"\\\\n}\\"\\n}","type":"json"}]',
- 'title' => '获取网络可达性分析任务结果',
- 'description' => '**GetNetworkReachableAnalysis**接口属于异步接口,即系统会返回一个任务ID,但该网络可达性分析结果尚未成功获取,系统后台的获取任务仍在进行。您可以查询网络可达性分析任务的状态: '."\n"
- .'- 当网络可达性分析任务处于**init**状态时,表示网络可达性分析任务正在进行中。'."\n"
- .'- 当网络可达性分析任务处于**finish**状态时,表示网络可达性分析任务已完成,即可获取结果。',
- ],
- 'GetNisNetworkMetrics' => [
- 'summary' => '支持指定NIS网络分析场景,获取详细监控指标趋势数据,包括流量分析场景下的流量指标趋势数据,以及性能观测场景下的性能指标趋势数据等。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '222161',
- 'abilityTreeNodes' => [
- 'FEATUREnetana5MCZ6K',
- 'FEATUREnetanaOV20CD',
- 'FEATUREnetanaB9LIVJ',
- 'FEATUREnetanaCEA895',
- ],
- ],
- 'parameters' => [
[
- 'name' => 'RegionNo',
+ 'name' => 'Direction',
'in' => 'query',
'schema' => [
- 'description' => '地域ID。',
+ 'title' => '基于阿里云资源的网络流量方向:'."\n"
+ .'in:流入资源的流量方向。'."\n"
+ .'out:流出资源的流量方向。'."\n"
+ .'跨域流量分析因只采集出向流量,所以传入in也以out处理。'."\n"
+ .'地域内性能观测和地域间性能观测因需在Filter内指定源或目的,所以可以任意指定Direction。',
+ 'description' => '基于阿里云资源的网络流量方向'."\n"
+ ."\n"
+ .'In:流入目标资源的流量方向。'."\n"
+ .'Out:流出目标资源的流量方向。'."\n"
+ ."\n"
+ .'- VPC 流日志场景(`TraffficScenario = VpcFlowLogAll` / `VpcFlowLogInternet `)'."\n"
+ .' - In:流入 ENI 的流量。'."\n"
+ .' - Out:流出 ENI 的流量。'."\n"
+ ."\n"
+ .'- TR 流日志场景(`TraffficScenario = TRFlowlog`)'."\n"
+ .' - In:流入 TR 的流量。'."\n"
+ .' - Out:流出 TR 的流量。'."\n"
+ ."\n"
+ .'- 共享带宽指标分析场景(`TraffficScenario = CbwpMetric`)'."\n"
+ .' - In:流入 EIP 的流量。'."\n"
+ .' - Out:流出 EIP 的流量。',
'type' => 'string',
'required' => true,
- 'example' => 'cn-shenzhen',
+ 'example' => 'Out',
+ 'enum' => ['In', 'Out'],
],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'GroupBy',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '按流量转发所使用的阿里云网络资源类型进行分析,已支持网络资源类型:'."\n"
- .'AccessInternetIPV4:所有阿里云公网类型IPV4'."\n"
- .'AccessInternetIPV4Limited:所有受地域限速的阿里云公网类型IPV4'."\n"
- .'ElasticIP: 弹性公网EIP(IPV4)'."\n"
- .'PublicIPEcs: 绑定在ECS的固定公网IP(IPV4)'."\n"
- .'PublicIPClb: 绑定在CLB的固定公网IP(IPV4)'."\n"
- .'NAT:通过SNAT的访问公网流量'."\n"
- .'TR:流经云企业网转发路由器的流量'."\n"
- .'TRAttachment:流经云企业网连接实例的流量,包括地域内连接和跨地域连接,地域内连接具备出入方向,跨地域连接仅具备出方向'."\n"
- .'VBR:流经边界路由器的流量'."\n"
- .'GA:流经全球加速的流量'."\n"
- .'ECR:流经ECR的流量'."\n"
- .'VPC:流经VPC的流量'."\n"
- .'InternetProbing: 公网探测数据'."\n"
- .'IntranetProbing: 内网探测数据',
- 'description' => '按流量转发所使用的阿里云网络资源类型进行分析,取值:'."\n"
- ."\n"
- .'- AccessInternetIpV4:所有阿里云公网类型IPv4。'."\n"
- .'- AccessInternetIpV4Limited:所有受地域限速的阿里云公网类型IPv4。'."\n"
- .'- ElasticIP:弹性公网EIP(IPv4)。'."\n"
- .'- PublicIpEcs:绑定在ECS的固定公网IP(IPv4)。'."\n"
- .'- PublicIpClb:绑定在CLB的固定公网IP(IPv4)。'."\n"
- .'- NAT:通过SNAT的访问公网流量。'."\n"
- .'- TR:流经云企业网转发路由器的流量。'."\n"
- .'- TRAttachment:流经云企业网连接实例的流量,包括地域内连接和跨地域连接,地域内连接具备出入方向,跨地域连接仅具备出方向。'."\n"
- .'- VBR:流经边界路由器的流量。'."\n"
- .'- GA:流经全球加速的流量。'."\n"
- .'- InternetProbing:公网质量探测数据。'."\n"
- .'- IntranetProbing:内网质量探测数据。'."\n"
- .'- NisInspectionHistoryReportScore:巡检历史评分。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AccessInternetIPV4',
- 'enum' => [
- 'AccessInternetIpV4',
- 'AccessInternetIpV4Limited',
- 'ElasticIP',
- 'PublicIpEcs',
- 'PublicIpClb',
- 'NAT',
- 'TR',
- 'TRAttachment',
- 'VBR',
- 'GA',
- 'InternetProbing',
- 'IntranetProbing',
- 'NisInspectionHistoryReportScore',
+ 'description' => '支持基于指定的多项流量维度进行聚合排序。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '根据 `TupleDimension` 字段和 `TrafficScenario` 字段,可以指定流量的聚合维度如下:'."\n"
+ ."\n"
+ .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet `(VPC 流日志场景):'."\n"
+ ."\n"
+ .' - `TupleDimension = Tuple1` 时,支持:'."\n"
+ .' - `VpcId`:VPC ID'."\n"
+ .' - `VSwitchId`:交换机 ID'."\n"
+ .' - `CloudIp`:云端 IP'."\n"
+ ."\n"
+ .' - `TupleDimension = Tuple2` 时,支持:'."\n"
+ .' - `VpcId`:VPC ID'."\n"
+ .' - `VSwitchId`:交换机 ID'."\n"
+ .' - `SourceIp`:源端 IP'."\n"
+ .' - `DestinationIp`:目的端 IP'."\n"
+ .' - `TrafficPath`:流量路径'."\n"
+ ."\n"
+ .' - `TupleDimension = Tuple5` 时,支持:'."\n"
+ .' - `VpcId`:VPC ID'."\n"
+ .' - `VSwitchId`:交换机 ID'."\n"
+ .' - `SourceIp`:源端 IP'."\n"
+ .' - `DestinationIp`:目的端 IP'."\n"
+ .' - `TrafficPath`:流量路径'."\n"
+ .' - `SourcePort`:源端端口'."\n"
+ .' - `DestinationPort`:目的端端口'."\n"
+ .' - `Protocol`:网络协议'."\n"
+ ."\n"
+ .' - 统计 VPC 公网场景(`TrafficScenario = VpcFlowLogInternet`)时,额外支持:'."\n"
+ .' - `Country`:客户端国家'."\n"
+ .' - `Province`:客户端省份'."\n"
+ .' - `City`:客户端城市'."\n"
+ .' - `Isp`:网络服务提供商'."\n"
+ .' - `Asn`:自治系统号码'."\n"
+ ."\n"
+ .'- `TrafficScenario = TRFlowlog`(TR 流日志场景,元组自适应,`TupleDimension` 非必填)支持:'."\n"
+ .' - `TransitRouterAttachmentId`: 网络实例连接 ID(必填)'."\n"
+ .' - `TransitRouterId`:转发路由器实例 ID'."\n"
+ .' - `SourceIp`:源端 IP'."\n"
+ .' - `DestinationIp`:目的端 IP'."\n"
+ .' - `Dscp`:区分服务代码点'."\n"
+ .' - `Protocol`:网络协议'."\n"
+ .' - `SourcePort`:源端端口'."\n"
+ .' - `DestinationPort`:目的端端口'."\n"
+ .' - `非TR跨地域场景` 下,额外支持:'."\n"
+ .' - `TransitRouterSourceResourceId`:源网络实例 ID'."\n"
+ .' - `TransitRouterDestinationResourceId`:目的网络实例 ID'."\n"
+ .' - `VPC连接流量场景` 下,额外支持:'."\n"
+ .' - `TransitRouterSourceNetworkInterface`:源TR ENI'."\n"
+ .' - `TransitRouterDestinationNetworkInterface`:目的TR ENI'."\n"
+ ."\n"
+ .'- `TrafficScenario = CbwpMetric`(CBWP 指标分析场景,`TupleDimension` 非必填)支持:'."\n"
+ .' - `PublicIpAddress`:绑定的 EIP 的公网 IP 地址'."\n"
+ .' - `BindingResourceType`:EIP 所绑定的实例资源类型'."\n"
+ .' - `BindingResourceId`:EIP 所绑定的实例资源 ID'."\n"
+ .' - `CbwpId`:共享带宽包 ID',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '["VpcId"]',
+ 'enum' => [
+ 'VpcId', 'VSwitchId', 'CloudIp', 'SourceIp', 'DestinationIp', 'Protocol', 'SourcePort', 'DestinationPort', 'TrafficPath', 'Country', 'Province', 'City', 'Isp', 'Asn', 'TransitRouterAttachmentId', 'Dscp', 'TransitRouterPairAttachmentId', 'TransitRouterSourceResourceId', 'TransitRouterDestinationResourceId', 'TransitRouterSourceNetworkInterface',
+ 'TransitRouterDestinationNetworkInterface', 'TransitRouterId', 'BindingResourceId', 'BindingResourceType', 'CbwpId', 'PublicIpAddress',
+ ],
],
+ 'required' => false,
],
],
[
- 'name' => 'MetricName',
+ 'name' => 'OrderBy',
'in' => 'query',
'schema' => [
- 'title' => '指标名。'."\n"
- .'流量分析场景支持的公共参数:'."\n"
+ 'title' => '指定公网流量进行排名的指标。大小写敏感。'."\n"
.' bps:每秒比特数。'."\n"
.' pps:每秒包数。'."\n"
+ .' ByteCount:累计字节数。'."\n"
+ .' PacketCount:累计包数。'."\n"
.'公网场景特有参数:'."\n"
.' rtt:tcp协议建立连接时的往返延迟。'."\n"
.' RetransmitRate:重传率。'."\n"
- .'区域级带宽场景特有参数:'."\n"
+ .'区域级限速场景特有参数:'."\n"
.' RatelimitDropPps:限速丢包速率。'."\n"
- .' BandwidthUtilization:带宽利用率。'."\n"
.'NAT场景特有参数:'."\n"
.' ActiveSessionCount:并发会话数。'."\n"
.' NewSessionPerSecond:每秒新建会话数。',
- 'description' => '指标名。取值:'."\n"
+ 'description' => '根据 `TrafficScenario` 字段,支持按以下指标对流量进行排名:'."\n"
."\n"
- .'- bps:每秒比特数。'."\n"
- .'- pps:每秒包数。'."\n"
- .'- rtt:tcp协议建立连接时的往返延迟。'."\n"
- .'- RetransmitRate:重传率。'."\n"
- .'- RatelimitDropPps:限速丢包速率。'."\n"
- .'- ActiveSessionCount:并发会话数。'."\n"
- .'- NewSessionPerSecond:每秒新建会话数。'."\n"
- .'- BandwidthUtilization:带宽利用率。'."\n"
- .'- passRate:巡检通过率。'."\n"
- .'> 选定时间范围内RTT无数据,是因为该时间段里,此连接是长连接,没有触发首次建连。',
+ .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet `(VPC 流日志场景):'."\n"
+ .' - `Bytes`:带宽'."\n"
+ .' - `Packets`:包数'."\n"
+ .' - `RoundTripTime`:TCP RTT'."\n"
+ ."\n"
+ .'- `TrafficScenario = TRFlowlog`(TR 流日志场景):'."\n"
+ .' - `Bytes`:带宽'."\n"
+ .' - `Packets`:包数'."\n"
+ .' - `PacketsLostNoRoute`:无路由丢包数'."\n"
+ .' - `PacketsLostBlackhole`:黑洞路由丢包数'."\n"
+ .' - `PacketsLostTTLExpired`:TTL 超时丢包数'."\n"
+ .' - `BytesIncrease`:带宽增长量'."\n"
+ .' - `BytesIncreaseRatio`:带宽增长率'."\n"
+ ."\n"
+ .'- `TrafficScenario = CbwpMetric`(共享带宽指标分析场景):'."\n"
+ .' - `Bytes`:带宽'."\n"
+ .' - `Packets`:包数',
'type' => 'string',
'required' => true,
- 'example' => 'bps',
- 'enum' => [
- 'rtt',
- 'bps',
- 'pps',
- 'RetransmitRate',
- 'ActiveSessionCount',
- 'NewSessionPerSecond',
- 'RatelimitDropPps',
- 'passRate',
- 'BandwidthUtilization',
- ],
+ 'example' => 'Bytes',
+ 'enum' => ['Bytes', 'Packets', 'RoundTripTime', 'PacketsLostNoRoute', 'PacketsLostBlackhole', 'PacketsLostTTLExpired', 'BytesIncrease', 'BytesIncreaseRatio'],
],
],
[
- 'name' => 'Dimensions',
+ 'name' => 'Filter',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '具体业务的Metric查询参数。各场景参数说明详见xxx部分。',
- 'description' => '具体业务的Metric查询参数集合。各场景参数说明,请参见[GetNisNetworkMetrics](~~2833348~~)。',
+ 'title' => '支持进一步指定流量的过滤条件,进行聚焦性流量分析。',
+ 'description' => '支持进一步指定流量的过滤条件,进行聚焦性流量分析。',
'type' => 'array',
'items' => [
- 'description' => '具体业务的Metric查询参数。',
+ 'description' => '指定流量的过滤条件,Key-Value-Operator对象。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '过滤条件的名字。',
+ 'Key' => [
+ 'description' => '根据 TupleDimension 字段和 TrafficScenario 字段,支持过滤的条件标签键,如下所示:'."\n"
+ ."\n"
+ .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet`(VPC 流日志场景):'."\n"
+ ."\n"
+ .' - `TupleDimension` 为一元组时,支持:'."\n"
+ .' - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填,对应value值不可多选)'."\n"
+ .' - `VpcId`:VPC ID(对应value值可多选)'."\n"
+ .' - `VSwitchId`:交换机 ID(对应value值可多选)'."\n"
+ .' - `NetworkInterfaceId`:弹性网卡 ID(对应value值可多选)'."\n"
+ .' - `EcsId`:云服务器 ECS ID(对应value值可多选)'."\n"
+ .' - `CloudIp`:云端 IP(对应value值可多选)'."\n"
+ ."\n"
+ .' - `TupleDimension` 为二元组时,支持:'."\n"
+ .' - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填,对应value值不可多选)'."\n"
+ .' - `VpcId`:VPC ID(对应value值可多选)'."\n"
+ .' - `VSwitchId`:交换机 ID(对应value值可多选)'."\n"
+ .' - `NetworkInterfaceId`:弹性网卡 ID(对应value值可多选)'."\n"
+ .' - `EcsId`:云服务器 ECS ID(对应value值可多选)'."\n"
+ .' - `SourceIp`:源端 IP(对应value值可多选)'."\n"
+ .' - `DestinationIp`:目的端 IP(对应value值可多选)'."\n"
+ .' - `TrafficPath`:流量路径(对应value值可多选)'."\n"
+ ."\n"
+ .' - `TupleDimension` 为五元组时,支持:'."\n"
+ .' - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填,对应value值不可多选)'."\n"
+ .' - `VpcId`:VPC ID(对应value值可多选)'."\n"
+ .' - `VSwitchId`:交换机 ID(对应value值可多选)'."\n"
+ .' - `NetworkInterfaceId`:弹性网卡 ID(对应value值可多选)'."\n"
+ .' - `EcsId`:云服务器 ECS ID(对应value值可多选)'."\n"
+ .' - `SourceIp`:源端 IP'."\n"
+ .' - `DestinationIp`:目的端 IP'."\n"
+ .' - `TrafficPath`:流量路径(对应value值可多选)'."\n"
+ .' - `SourcePort`:源端口(对应value值可多选)'."\n"
+ .' - `DestinationPort`:目的端口(对应value值可多选)'."\n"
+ .' - `Protocol`:网络协议(对应value值可多选)'."\n"
+ ."\n"
+ .' - VPC 公网场景(`TrafficScenario = VpcFlowLogInternet`)下,按互联网位置进行过滤时,额外支持:'."\n"
+ .' - `ClientCountry`:按国家过滤流量分析范围(对应value值可多选)'."\n"
+ .' - `ClientCity`:按城市过滤流量分析范围(对应value值可多选)'."\n"
+ .' - `ClientAsn`:按 ASN 过滤流量分析范围(对应value值可多选)'."\n"
+ .' - `ClientIsp`:按客户端运营商过滤流量分析范围(对应value值可多选)'."\n"
+ ."\n"
+ .' - VPC 场景下,均可按流量指标过滤:'."\n"
+ .' - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应value值不可多选)'."\n"
+ .' - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应value值不可多选)'."\n"
+ .' - `MinRoundTripTime`:指定参与排序的最小 RTT,单位 ms(对应value值不可多选)'."\n"
+ .' - `MaxRoundTripTime`:指定参与排序的最大 RTT,单位 ms(对应value值不可多选)'."\n"
+ .' - `MinPackages`:指定参与排序的最小包数,单位个(对应value值不可多选)'."\n"
+ .' - `MaxPackages`:指定参与排序的最大包数,单位个(对应value值不可多选)'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'- `TrafficScenario = TRFlowlog`(TR 流日志场景):'."\n"
+ ."\n"
+ .' - 查询二元组或自适应为二元组时,支持:'."\n"
+ .' - `TransitRouterAttachmentId`:网络实例连接 ID(必填,对应value值不可多选)'."\n"
+ .' - `TransitRouterPairAttachmentId`:对端TR连接ID(对应value值可多选)'."\n"
+ .' - `TransitRouterId`:转发路由器实例 ID(对应value值可多选)'."\n"
+ .' - `SourceIp`:源端 IP(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)'."\n"
+ .' - `DestinationIp`:目的端 IP(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)'."\n"
+ .' - `Dscp`:区分服务代码点(对应value值可多选)'."\n"
+ ."\n"
+ .' - 查询五元组或自适应为五元组时,在二元组支持的基础上,额外支持:'."\n"
+ .' - `Protocol`:网络协议(对应value值可多选)'."\n"
+ .' - `SourcePort`:源端端口(对应value值可多选)'."\n"
+ .' - `DestinationPort`:目的端端口(对应value值可多选)'."\n"
+ .' - `非TR跨地域场景` 下,额外支持:'."\n"
+ .' - `TransitRouterSourceResourceId`:源网络实例 ID(对应value值可多选)'."\n"
+ .' - `TransitRouterDestinationResourceId`:目的网络实例 ID(对应value值可多选)'."\n"
+ .' - `VPC连接流量场景` 下,额外支持:'."\n"
+ .' - `TransitRouterSourceNetworkInterface`:源TR ENI(对应value值可多选)'."\n"
+ .' - `TransitRouterDestinationNetworkInterface`:目的TR ENI(对应value值可多选)'."\n"
+ ."\n"
+ .' - TR 场景下,均可按流量指标过滤:'."\n"
+ .' - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应value值不可多选)'."\n"
+ .' - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应value值不可多选)'."\n"
+ .' - `MinPackages`:指定参与排序的最小包数,单位个(对应value值不可多选)'."\n"
+ .' - `MaxPackages`:指定参与排序的最大包数,单位个(对应value值不可多选)'."\n"
+ .' - `MinPacketsLostNoRoute`:最小无路由丢包数,单位个(对应value值不可多选)'."\n"
+ .' - `MinPacketsLostBlackhole`:最小黑洞路由丢包数,单位个(对应value值不可多选)'."\n"
+ .' - `MinPacketsLostTTLExpired`:最小 TTL 超时丢包数,单位个(对应value值不可多选)'."\n"
+ .' - `MaxPacketsLostNoRoute`:最大无路由丢包数,单位个(对应value值不可多选)'."\n"
+ .' - `MaxPacketsLostBlackhole`:最大黑洞路由丢包数,单位个(对应value值不可多选)'."\n"
+ .' - `MaxPacketsLostTTLExpired`:最大 TTL 超时丢包数,单位个(对应value值不可多选)'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'- `TrafficScenario = CbwpMetric`(共享带宽指标分析场景):'."\n"
+ ."\n"
+ .' - 按条件过滤,支持:'."\n"
+ .' - `PublicIpAddress`:绑定的 EIP 的公网 IP 地址(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)'."\n"
+ .' - `BindingResourceType`:EIP 所绑定的实例资源类型(对应value值可多选)'."\n"
+ .' - `BindingResourceId`:EIP 所绑定的实例资源 ID(对应value值可多选)'."\n"
+ .' - `CbwpId`:共享带宽包 ID(必填,对应value值不可多选)'."\n"
+ .' - `InstanceId`:共享带宽包所绑定的 EIP ID(对应value值可多选)'."\n"
+ ."\n"
+ .' - CBWP 场景下,均可按流量指标过滤:'."\n"
+ .' - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应value值不可多选)'."\n"
+ .' - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应value值不可多选)'."\n"
+ .' - `MinPackages`:指定参与排序的最小包数,单位个(对应value值不可多选)'."\n"
+ .' - `MaxPackages`:指定参与排序的最大包数,单位个(对应value值不可多选)',
'type' => 'string',
'required' => false,
- 'example' => 'instanceId',
+ 'example' => 'FlowAction',
+ 'enum' => [
+ 'FlowAction', 'VpcId', 'VSwitchId', 'NetworkInterfaceId', 'CloudIp', 'DestinationIp', 'SourceIp', 'EcsId', 'TrafficPath', 'ClientCountry', 'ClientCity', 'ClientAsn', 'ClientIsp', 'SourcePort', 'DestinationPort', 'Protocol', 'MinBytes', 'MaxBytes', 'MinRoundTripTime', 'MaxRoundTripTime',
+ 'MinPackages', 'MaxPackages', 'TransitRouterAttachmentId', 'Dscp', 'TransitRouterPairAttachmentId', 'MinPacketsLostBlackhole', 'MaxPacketsLostBlackhole', 'MinPacketsLostNoRoute', 'MaxPacketsLostNoRoute', 'MinPacketsLostTTLExpired', 'MaxPacketsLostTTLExpired', 'TransitRouterSourceResourceId', 'TransitRouterSourceNetworkInterface', 'TransitRouterDestinationResourceId', 'TransitRouterDestinationNetworkInterface', 'TransitRouterId', 'PublicIpAddress', 'InstanceId', 'BindingResourceType', 'BindingResourceId',
+ 'CbwpId', 'AttachmentType',
+ ],
],
'Value' => [
'description' => '过滤条件的值。',
+ 'type' => 'array',
+ 'items' => ['description' => '根据过滤的key类型,传入对应的过滤值。'."\n"
+ ."\n"
+ .'根据 `TupleDimension` 字段和 `TrafficScenario` 字段,支持情况如下:'."\n"
+ ."\n"
+ .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet`(VPC 流日志场景)'."\n"
+ ."\n"
+ .' - 当 key 为 `FlowAction` 时,value 枚举为:'."\n"
+ .' - `ACCEPT`(默认传 `Accept`):安全组和网络 ACL 允许的流量'."\n"
+ .' - `REJECT`:安全组和网络 ACL 拒绝的流量'."\n"
+ ."\n"
+ .'- `TrafficScenario = TRFlowlog`(TR 流日志场景)'."\n"
+ ."\n"
+ .' - key 为 `TransitRouterAttachmentId` 时为必传项,对应的 value 同为必填(指定具体的 VPC 连接 / VPN 连接 / VBR 连接 / ECR 连接 / 跨地域连接或网络实例连接 ID)。'."\n"
+ ."\n"
+ .'- `TrafficScenario = CbwpMetric`(共享带宽指标分析场景)'."\n"
+ ."\n"
+ .' - key 为 `CbwpId` 时为必传项,对应的 value 同为必填(指定具体的共享带宽包 ID)。', 'type' => 'string', 'required' => false, 'example' => 'Accept'],
+ 'required' => false,
+ ],
+ 'Operator' => [
+ 'description' => '针对指定的key类型,部分支持使用操作符,对传入的value进行字符串匹配,支持的枚举如下(默认值为 `in`):'."\n"
+ ."\n"
+ .'- `in`:等于'."\n"
+ .'- `not in`:不等于'."\n"
+ .'- `like`:包含'."\n"
+ ."\n"
+ .'根据 `TupleDimension` 字段和 `TrafficScenario` 字段,`like` 的支持情况如下:'."\n"
+ ."\n"
+ .'- `TrafficScenario = VpcFlowLogAll` / `VpcFlowLogInternet`(VPC 流日志场景):'."\n"
+ .' - 当 key 为以下字段时,支持 `like`:'."\n"
+ .' - `CloudIp`'."\n"
+ .' - `SourceIp`'."\n"
+ .' - `DestinationIp`'."\n"
+ ."\n"
+ .'- `TrafficScenario = TRFlowlog`(TR 流日志场景):'."\n"
+ .' - 当 key 为以下字段时,支持 `like`:'."\n"
+ .' - `SourceIp`'."\n"
+ .' - `DestinationIp`'."\n"
+ ."\n"
+ .'- `TrafficScenario = CbwpMetric`(共享带宽指标分析场景):'."\n"
+ .' - 当 key 为以下字段时,支持 `like`:'."\n"
+ .' - `PublicIpAddress`'."\n"
+ ."\n"
+ .'除以上字段外,其余字段仅支持 `in` 和 `not in` 操作符。',
'type' => 'string',
'required' => false,
- 'example' => 'eip-sample*',
+ 'enumValueTitles' => ['not in' => 'not in', 'in' => 'in', 'like' => 'like'],
+ 'example' => 'in',
],
],
'required' => false,
],
- 'required' => true,
- 'example' => 'bps',
+ 'required' => false,
],
],
[
'name' => 'BeginTime',
'in' => 'query',
- 'schema' => [
- 'title' => '起始时间戳,单位毫秒。未指定时默认查最近1小时。',
- 'description' => '起始时间,单位**ms**,格式**unix**时间戳。未指定时默认查最近1小时。起始时间最早可选择7天前。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '253402271999000',
- 'minimum' => '0',
- 'example' => '1638239092000',
- ],
+ 'schema' => ['title' => '起始时间戳,单位毫秒。未指定时默认查最近1小时。', 'description' => '查询起始时间的毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1638239092000'],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'title' => '结束时间戳,单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的一小时。',
- 'description' => '结束时间,单位**ms**,格式**unix**时间戳。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的一小时。结束时间距起始时间最多24小时。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '253402271999000',
- 'minimum' => '0',
- 'example' => '1684373700099',
- ],
+ 'schema' => ['title' => '结束时间戳,单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。', 'description' => '查询结束时间的毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1684373700099'],
],
[
- 'name' => 'ScanBy',
+ 'name' => 'Sort',
'in' => 'query',
'schema' => [
'title' => '排序方式,'."\n"
- .'TimestampAscending:按时间正向排序。'."\n"
- .'TimestampDescending:按时间逆向排序。',
- 'description' => '排序方式,默认TimestampAscending,取值:'."\n"
- ."\n"
- .'- TimestampAscending:按时间正向排序。'."\n"
- .'- TimestampDescending:按时间逆向排序。',
+ .'asc:按正序排序。'."\n"
+ .'desc:按逆序排序。',
+ 'description' => '指定流量分析的排序方式'."\n"
+ .'- ASC:按正序排序。'."\n"
+ .'- DESC:按逆序排序。',
'type' => 'string',
'required' => false,
- 'example' => 'TimestampAscending',
- 'default' => 'TimestampAscending',
- 'enum' => [
- 'TimestampAscending',
- 'TimestampDescending',
- ],
+ 'example' => 'Desc',
+ 'default' => 'Desc',
+ 'enum' => ['Desc', 'Asc'],
],
],
[
- 'name' => 'UseCrossAccount',
+ 'name' => 'TopN',
'in' => 'query',
- 'schema' => [
- 'title' => '是否使用多账号访问模式',
- 'description' => '是否使用多账号访问模式,保留参数,暂不支持。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['title' => '展示排序靠前的数据。默认值:10。表示默认展示排序前 10 的数据。最大值:100。', 'description' => '指定流量排序查询的条目数。'."\n"
+ ."\n"
+ .'支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'AccountIds',
+ 'name' => 'Language',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'title' => '显式传递子账号ID',
- 'description' => '显式传递子账号ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '成员账号ID列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '118639953821****',
- ],
+ 'description' => '语言,枚举:zh-CN,en-US',
+ 'type' => 'string',
'required' => false,
- 'maxItems' => 10,
+ 'example' => 'zh-CN',
+ 'enum' => ['zh-CN', 'en-US'],
],
],
[
- 'name' => 'StepMinutes',
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。', 'type' => 'string', 'required' => false, 'example' => '2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小,取值范围:1~100,默认值:20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
+ ],
+ [
+ 'name' => 'StorageInterval',
'in' => 'query',
'schema' => [
+ 'description' => '存储桶精度属性。'."\n"
+ ."\n"
+ .'存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。'."\n"
+ ."\n"
+ .'- 流量分析器对应元组支持的存储精度为:'."\n"
+ .' - `1`:单位分钟(1 分钟)'."\n"
+ .' - `10`:单位分钟(10 分钟)'."\n"
+ .' - `60`:单位分钟(60 分钟,即 1 小时)'."\n"
+ .' - `1440`:单位分钟(1440 分钟,即 1 天)'."\n"
+ ."\n"
+ .'- 存储桶精度可用于两类典型用途:'."\n"
+ .' - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合'."\n"
+ .' - 长周期流量统计:如 1440 分钟(1 天)聚合'."\n"
+ ."\n"
+ .'- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:'."\n"
+ .' - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据'."\n"
+ .' - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据',
'type' => 'integer',
'format' => 'int32',
'required' => false,
+ 'enumValueTitles' => [1 => '1', 10 => '10', 60 => '60', 1440 => '1440'],
+ 'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>',
- 'description' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>',
+ 'title' => 'RpcResponse<ArrayList<NtaNetworkRankingResponse>>',
+ 'description' => 'RpcResponse<ArrayList<NtaNetworkRankingResponse>>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B',
- ],
- 'Data' => [
- 'description' => '云网络指标趋势数据对象。',
- 'type' => 'object',
- 'properties' => [
- 'Unit' => [
- 'description' => '单位。',
- 'type' => 'string',
- 'example' => 'Bits/Second',
- ],
- 'Metrics' => [
- 'description' => '指标趋势数据集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '指标趋势单时间点数据。',
- 'type' => 'object',
- 'properties' => [
- 'TimeStamp' => [
- 'description' => '数据的毫秒时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1690684091100',
- ],
- 'Value' => [
- 'description' => '指标值。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '88',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941'],
+ 'NisTrafficRankingId' => ['description' => '返回本次流量排序分析的结果ID,需调用DescribeNisTrafficRanking接口获取最终分析结果。', 'type' => 'string', 'example' => 'task-6462a7b4c4a54b****'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParam.BeginTimeAndEndTime',
- 'errorMessage' => 'It only supports querying data for up to 24 hours: %s.',
- ],
- [
- 'errorCode' => 'OperationFailed.DataTooMuch',
- 'errorMessage' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.',
- ],
- [
- 'errorCode' => 'IllegalParam.Dimensions',
- 'errorMessage' => 'The specified Dimensions(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.Dimensions.Direction',
- 'errorMessage' => 'The specified Dimensions.Direction(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.Dimensions.InstanceId',
- 'errorMessage' => 'The specified Dimensions.InstanceId(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.MetricName',
- 'errorMessage' => 'The specified MetricName(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.ResourceType',
- 'errorMessage' => 'The specified resourceType (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.Dimensions.DestinationZone',
- 'errorMessage' => 'The specified parameter Dimensions.DestinationZone (%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.Dimensions.SourceZone',
- 'errorMessage' => 'The specified parameter Dimensions.SourceZone(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.IP',
- 'errorMessage' => 'The specified IP address (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.RegionNo',
- 'errorMessage' => 'The specified parameter RegionNo(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.Dimensions.InspectionTaskId',
- 'errorMessage' => 'The specified argument Dimensions.InspectionTaskId(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.Dimensions.DestinationRegionNo',
- 'errorMessage' => 'The specified parameter Dimensions.DestinationRegionNo(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.StepMinutes',
- 'errorMessage' => 'The specified StepMinutes parameter value is illegal, only %s minutes of data precision is supported.',
- ],
- [
- 'errorCode' => 'IllegalParam.MaxTimeScope',
- 'errorMessage' => 'The query time range exceeds the limit. You can query up to %s days of data.',
- ],
- [
- 'errorCode' => 'IllegalParam.StepMinutesAndTime',
- 'errorMessage' => 'In the current query time range, data precision of only %s minutes is supported to ensure performance.',
- ],
- [
- 'errorCode' => 'UnsupportedRegion',
- 'errorMessage' => 'This feature is not supported in the current region.',
- ],
+ ['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'The authentication result is successful but the verification fails.', 'description' => '鉴权结果成功但验证未通过。'],
+ ['errorCode' => 'IllegalParam.RegionNo', 'errorMessage' => 'The specified parameter RegionNo(%s) is illegal.', 'description' => '指定的参数RegionNo(%s)不合法。'],
+ ['errorCode' => 'DuplicatedParam.GroupBy', 'errorMessage' => 'Duplicate data exists for the specified GroupBy(%s) parameter.', 'description' => '指定的GroupBy(%s)参数存在重复数据。'],
+ ['errorCode' => 'IllegalParam.GroupBy', 'errorMessage' => 'The specified param of GroupBy (%s) is invalid.', 'description' => '指定的分组字段(%s)不合法。'],
+ ['errorCode' => 'DuplicatedParam.Filter', 'errorMessage' => 'The specified Filter(%s) parameter has a duplicate Key.', 'description' => '指定的Filter(%s)参数存在重复Key。'."\n"],
+ ['errorCode' => 'IllegalParam.UserOwesFees', 'errorMessage' => 'User (%s) is overdue.', 'description' => '用户(%s)已欠费.'],
+ ['errorCode' => 'IllegalParam.UserNotActivated', 'errorMessage' => 'User (%s) did not provision service.', 'description' => '用户(%s)未开通服务。'],
+ ['errorCode' => 'IncorrectStatus.TrafficAnalyzerId', 'errorMessage' => 'TrafficAnalyzerId (%s) is not in a valid status.', 'description' => 'TrafficAnalyzerId(%s)非有效状态.'],
+ ['errorCode' => 'IllegalParam.CloudIp', 'errorMessage' => 'The specified CloudIp(%s) is invalid.', 'description' => '指定的CloudIp(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.SourceIp', 'errorMessage' => 'Please enter a valid source IP.', 'description' => '请输入合法的源IP'],
+ ['errorCode' => 'IllegalParam.SourcePort', 'errorMessage' => 'The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536].', 'description' => 'SourcePort参数不合法,必须介于0到65536(含)之间。'],
+ ['errorCode' => 'IllegalParam.DestinationPort', 'errorMessage' => 'The specified DestinationPort(%s) is invalid.', 'description' => '指定的DestinationPort(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.Protocol', 'errorMessage' => 'The specified Protocol(%s) is invalid.', 'description' => '指定的Protocol(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MinBytes', 'errorMessage' => 'The format of the specified parameter MinBytes(%s) is not legal.', 'description' => '指定的参数MinBytes(%s)格式不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MaxBytes', 'errorMessage' => 'The format of the specified parameter MaxBytes(%s) is not legal.', 'description' => '指定的参数MaxBytes(%s)格式不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MinRoundTripTime', 'errorMessage' => 'The format of the specified parameter MinRoundTripTime(%s) is not legal.', 'description' => '指定的参数MinRoundTripTime(%s)格式不合法。'."\n"],
+ ['errorCode' => 'IllegalParamFormat.MaxRoundTripTime', 'errorMessage' => 'The format of the specified parameter MaxRoundTripTime(%s) is not legal.', 'description' => '指定的参数MaxRoundTripTime(%s)格式不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MinPackages', 'errorMessage' => 'The format of the specified parameter MinPackages(%s) is not legal.', 'description' => '指定的参数MinPackages(%s)格式不合法。'."\n"],
+ ['errorCode' => 'IllegalParamFormat.MaxPackages', 'errorMessage' => 'The format of the specified parameter MaxPackages(%s) is not legal.', 'description' => '指定的参数MaxPackages(%s)格式不合法。'],
+ ['errorCode' => 'IllegalParam.TupleDimension', 'errorMessage' => 'The specified TupleDimension(%s) argument is illegal.', 'description' => '指定的TupleDimension(%s)参数不合法。'],
+ ['errorCode' => 'IllegalParam.OrderBy', 'errorMessage' => 'The specified param of orderBy (%s) is invalid.', 'description' => '指定的排序字段(%s)不合法。'],
+ ['errorCode' => 'IllegalParam.BeginTimeAndEndTime', 'errorMessage' => 'The param of BeginTimeAndEndTime is illegal.', 'description' => '开始结束时间错误。可能是因为开始时间大于结束时间,或范围超出最大限制'],
+ ['errorCode' => 'IllegalParam.DestinationIp', 'errorMessage' => 'The specified ip(%s) is illegal.', 'description' => '指定的ip(%s)不合法。'],
+ ['errorCode' => 'IllegalParamFormat.MaxPacketsLostTTLExpired', 'errorMessage' => 'The format of the specified parameter MaxPacketsLostTTLExpired(%s) is not legal.', 'description' => ''],
+ ['errorCode' => 'IllegalParamFormat.MinPacketsLostTTLExpired', 'errorMessage' => 'The format of the specified parameter MinPacketsLostTTLExpired(%s) is not legal.', 'description' => ''],
+ ['errorCode' => 'IllegalParamFormat.MaxPacketsLostNoRoute', 'errorMessage' => 'The format of the specified parameter MaxPacketsLostNoRoute(%s) is not legal.', 'description' => ''],
+ ['errorCode' => 'IllegalParamFormat.MinPacketsLostNoRoute', 'errorMessage' => 'The format of the specified parameter MinPacketsLostNoRoute(%s) is not legal.', 'description' => ''],
+ ['errorCode' => 'IllegalParamFormat.MaxPacketsLostBlackhole', 'errorMessage' => 'The format of the specified parameter MaxPacketsLostBlackhole(%s) is not legal.', 'description' => ''],
+ ['errorCode' => 'IllegalParamFormat.MinPacketsLostBlackhole', 'errorMessage' => 'The format of the specified parameter MinPacketsLostBlackhole(%s) is not legal.', 'description' => ''],
+ ['errorCode' => 'IllegalParam.Filter', 'errorMessage' => 'The specified Filter parameter (%s) is illegal.', 'description' => ''],
+ ['errorCode' => 'MissingParam.TransitRouterAttachmentId', 'errorMessage' => 'TransitRouterAttachmentId required in the specified Filter and GroupBy parameters.', 'description' => ''],
+ ['errorCode' => 'QuotaExceeded.CheckRowReadLimit', 'errorMessage' => 'The query time range exceeds the read data rows quota %s. Shorten the query interval.', 'description' => ''],
+ ['errorCode' => 'MissingParam.TransitRouterId', 'errorMessage' => 'When querying cross-region network connections, you need to specify the forwarding router ID.', 'description' => ''],
+ ['errorCode' => 'MissingParam.CbwpId', 'errorMessage' => 'The CbwpId filtered during the query cannot be empty.', 'description' => '查询时过滤的CbwpId不可为空。'],
+ ['errorCode' => 'ResourceNotFound.TrafficAnalyzerIdOneTupleDimension', 'errorMessage' => 'The specified traffic analyzer does not have a corresponding one-element group storage configuration.', 'description' => '指定的流量分析器没有对应的一元组存储配置。'],
+ ['errorCode' => 'IllegalParam.AttachmentType', 'errorMessage' => 'Unsupported AttachmentType(%s) type.', 'description' => '暂不支持的AttachmentType(%s)类型。'],
],
404 => [
- [
- 'errorCode' => 'ResourceNotFound.InstanceId',
- 'errorMessage' => 'The specified InstanceId(%s) does not exist.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.IpSets',
- 'errorMessage' => 'The specified instance does not exist or does not have any acceleration region.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.InspectionTaskId',
- 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.',
- ],
+ ['errorCode' => 'ResourceNotFound.TrafficAnalyzerId', 'errorMessage' => 'The specified resource TrafficAnalyzerId(%s) does not exist.', 'description' => '指定的资源TrafficAnalyzerId(%s)不存在。'],
+ ['errorCode' => 'ResourceNotFound.NtaNotStorageBucket', 'errorMessage' => 'The data source bound to the traffic analyzer does not have a corresponding storage configuration.', 'description' => '该流量分析器绑定的数据源无对应的存储配置。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"Data\\": {\\n \\"Unit\\": \\"Bits/Second\\",\\n \\"Metrics\\": [\\n {\\n \\"TimeStamp\\": 1690684091100,\\n \\"Value\\": 88\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取云网络指标趋势',
- 'description' => '数据查询结果同步说明:'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '启动NIS流量排序分析',
+ 'description' => '[请确保在使用该接口前,已充分了解NIS-流量分析器的收费方式和价格。](https://help.aliyun.com/zh/nis/product-overview/billing-method-new-version?spm=5176.25472526.console-base_help.dexternal.5b094887xwrWNE)'."\n"
."\n"
- .'- API数据跨度6小时同步一次,6小时后才可查询当前网络分析数据。'."\n"
+ .'使用该接口前,您需要先完成流量分析器创建和数据源添加。'."\n"
+ ."\n"
+ .'[流量分析器创建](https://help.aliyun.com/zh/nis/user-guide/traffic-analyzer-management?spm=a2c4g.11186623.help-menu-107955.d_1_3_0.7d2a2c07YsyRdP#39d1693bce6yp)'."\n"
+ ."\n"
+ .'[数据源添加](https://help.aliyun.com/zh/nis/user-guide/data-source-management?spm=a2c4g.11186623.help-menu-107955.d_1_3_1.789140e9L0u62h#73845748bfstv)'."\n"
."\n"
.'支持分析场景: '."\n"
- .'- 公网性能观测大盘场景'."\n"
- .'- 跨可用区内网性能观测大盘场景'."\n"
- .'- 跨地域内网性能观测大盘场景'."\n"
- ."\n\n"
- .'## 公网性能观测大盘场景'."\n"
."\n"
- .'**说明**'."\n"
+ .'- 全部VPC流日志分析'."\n"
+ .'- 公网VPC流日志分析'."\n"
+ .'- 全部TR流日志分析'."\n"
+ .'- 共享带宽指标分析'."\n"
."\n"
- .'支持最大查询时间跨度为24小时,不指定时默认查询最近1小时,查询的数据结果为1分钟1条。'."\n"
+ .'## 全部 VPC 流日志分析'."\n"
."\n"
- .'### **请求参数**'."\n"
+ .'### 请求参数'."\n"
."\n"
- .'| **名称** | **类型** | **必填** | **描述** |'."\n"
- .'| --- | --- | --- | --- |'."\n"
- .'| RegionNo | string | 是 | 探测源所在阿里云地域。 |'."\n"
- .'| ResourceType | string | 是 | 固定选择**InternetProbing**,表示查询公网性能监控趋势。 |'."\n"
- .'| MetricName | string | 是 | 指定查询趋势的指标,取值:**rtt**,探测的往返延迟。 |'."\n"
- .'| Dimensions | object\\[\\] | 是 | 过滤信息。 |'."\n"
- .'| \\-Name | string | 是 | 过滤条件,取值:<br> - **Country**:探测的国家。<br> - **Province**:探测的省份<br> - **Isp**:探测的运营商。<br> **说明:** 以上参数至少配置其中一个。 |'."\n"
- .'| \\-Value | string | 是 | 过滤条件对应的过滤值,示例如下:<br> - Country:China<br> - Province:Zhejiang <br>- Isp:阿里巴巴 <br>**说明:** 国家,省份格式为首字母大写,运营商参数与控制台显示名称一致即可。 |'."\n"
+ .'| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |'."\n"
+ .'|-------------------|----------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n"
+ .'| RegionNo | string | 是 | 资源所在地域。 | cn-shanghai | - |'."\n"
+ .'| TrafficAnalyzerId | string | 是 | 流量分析器 ID。 | nta-262****ca07f | - |'."\n"
+ .'| TrafficScenario | string | 是 | 支持分析场景:<br>● 全部 VPC 流日志分析 | 固定为:VpcFlowLogAll | VpcFlowLogAll |'."\n"
+ .'| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 ENI 的流量。<br>● Out:流出 ENI 的流量。 | In | - In <br>- Out |'."\n"
+ .'| TupleDimension | string | 是 | 流量存储聚合维度。 | Tuple1 | - Tuple1 <br>- Tuple2 <br>- Tuple5 |'."\n"
+ .'| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | | - |'."\n"
+ .'| | string | 否 | 根据 TupleDimension 字段,可以指定流量的聚合维度如下:<br>● TupleDimension = Tuple1 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ CloudIp:云端 IP<br><br>● TupleDimension = Tuple2 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ SourceIp:源端 IP<br> ■ DestinationIp:目的端 IP<br> ■ TrafficPath:流量路径<br><br>● TupleDimension = Tuple5 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ SourceIp:源端 IP<br> ■ DestinationIp:目的端 IP<br> ■ TrafficPath:流量路径<br> ■ SourcePort:源端端口<br> ■ DestinationPort:目的端口<br> ■ Protocol:网络协议 | ["VpcId"] | - VpcId<br>- VSwitchId<br>- CloudIp<br>- SourceIp<br>- DestinationIp<br>- Protocol<br>- SourcePort<br>- DestinationPort<br>- TrafficPath<br>- Country<br>- Province<br>- City<br>- Isp<br>- Asn |'."\n"
+ .'| OrderBy | string | 是 | 根据 TrafficScenario 字段,支持按以下指标对流量进行排名:<br><br>TrafficScenario = VpcFlowLogAll / VpcFlowLogInternet(VPC 流日志场景):<br>●Bytes:带宽<br>● Packets:包数<br>● RoundTripTime:TCP RTT | Bytes | - Bytes<br>- Packets<br>- RoundTripTime |'."\n"
+ .'| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | | - |'."\n"
+ .'| | object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | | - |'."\n"
+ .'| key | string | 否 | 支持过滤的条件标签键,如下所示:<br><br>- `TupleDimension` 为一元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(**必填**, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `CloudIp`:云端 IP(对应 value 值可多选)<br><br>- `TupleDimension` 为二元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(**必填**, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `SourceIp`:源端 IP(对应 value 值可多选)<br> - `DestinationIp`:目的端 IP(对应 value 值可多选)<br> - `TrafficPath`:流量路径(对应 value 值可多选)<br><br>- `TupleDimension` 为五元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(**必填**, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `SourceIp`:源端 IP<br> - `DestinationIp`:目的端 IP<br> - `TrafficPath`:流量路径(对应 value 值可多选)<br> - `SourcePort`:源端口(对应 value 值可多选)<br> - `DestinationPort`:目的端口(对应 value 值可多选)<br> - `Protocol`:网络协议(对应 value 值可多选)<br><br>- VPC 场景下,均可按流量指标过滤:<br> - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)<br> - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)<br> - `MinRoundTripTime`:指定参与排序的最小 RTT,单位 ms(对应 value 值不可多选)<br> - `MaxRoundTripTime`:指定参与排序的最大 RTT,单位 ms(对应 value 值不可多选)<br> - `MinPackages`:指定参与排序的最小包数,单位个(对应 value 值不可多选)<br> - `MaxPackages`:指定参与排序的最大包数,单位个(对应 value 值不可多选) | FlowAction | - FlowAction<br>- VpcId<br>- VSwitchId<br>- NetworkInterfaceId<br>- CloudIp<br>- DestinationIp<br>- SourceIp<br>- EcsId<br>- TrafficPath<br>- SourcePort<br>- DestinationPort<br>- Protocol<br>- MinBytes<br>- MaxBytes<br>- MinRoundTripTime<br>- MaxRoundTripTime<br>- MinPackages<br>- MaxPackages |'."\n"
+ .'| value | array | 否 | 过滤条件的值。 | | - |'."\n"
+ .'| | string | 否 | 根据过滤的 key 类型,传入对应的过滤值。<br><br>当 key 为 `FlowAction` 时,value 枚举为:<br> - `ACCEPT`(默认传 `Accept`):安全组和网络 ACL 允许的流量<br> - `REJECT`:安全组和网络 ACL 拒绝的流量 | Accept | 当 key 为 FlowAction 时:ACCEPT / REJECT |'."\n"
+ .'| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in):<br>● in:等于<br>● not in:不等于<br>● like:包含<br><br>根据 TupleDimension 字段和 TrafficScenario 字段,like 的支持情况如下:<br><br>TrafficScenario = VpcFlowLogAll / VpcFlowLogInternet(VPC 流日志场景):<br>当 key 为以下字段时,支持 like:<br> ○ CloudIp<br> ○ SourceIp<br> ○ DestinationIp<br><br>除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in<br>- in<br>- like |'."\n"
+ .'| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |'."\n"
+ .'| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |'."\n"
+ .'| Sort | string | 否 | 指定流量分析的排序方式:<br>● ASC:按正序排序。<br>● DESC:按逆序排序。 | Desc | - Desc<br>- Asc |'."\n"
+ .'| TopN | integer | 否 | 指定流量排序查询的条目数。<br>支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |'."\n"
+ .'| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN<br>- en-US |'."\n"
+ .'| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |'."\n"
+ .'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |'."\n"
+ .'| StorageInterval | integer | 否 | 存储桶精度属性。<br><br>存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。<br><br>- 流量分析器对应元组支持的存储精度为:<br> - `1`:单位分钟(1 分钟)<br> - `10`:单位分钟(10 分钟)<br> - `60`:单位分钟(60 分钟,即 1 小时)<br> - `1440`:单位分钟(1440 分钟,即 1 天)<br><br>- 存储桶精度可用于两类典型用途:<br> - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合<br> - 长周期流量统计:如 1440 分钟(1 天)聚合<br><br>- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:<br> - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据<br> - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1<br>- 10<br>- 60<br>- 1440 |'."\n"
."\n"
- .'### **返回参数**'."\n"
+ .'### 返回参数'."\n"
."\n"
- .'| **名称** | **类型** | **描述** |'."\n"
- .'| --- | --- | --- |'."\n"
- .'| RequestId | string | 请求ID。 |'."\n"
- .'| Data | object | 云网络指标趋势数据对象 |'."\n"
- .'| Metrics | array | 指标趋势数据集合 |'."\n"
- .'| \\-TimeStamp | long | 毫秒时间戳。 |'."\n"
- .'| \\-Value | double | 入参**MetricName**对应的指标值。 |'."\n"
- .'| Unit | String | 表示**Value**的单位。 |'."\n"
+ .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
+ .'|---------------------|--------|--------------------------------------------------------------------------------------------|---------------------------|--------|'."\n"
+ .'| | object | RpcResponse <ArrayList> | | - |'."\n"
+ .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | - |'."\n"
+ .'| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |'."\n"
."\n"
- .'## 跨可用区内网性能观测大盘场景'."\n"
+ .'## 公网 VPC 流日志分析'."\n"
."\n"
- .'**说明**'."\n"
+ .'### 请求参数'."\n"
."\n"
- .'- 查询时间长度超过5天时,查询数据结果为1天1条。'."\n"
- .' '."\n"
- .'- 查询时间长度超过1天时,查询数据结果为1小时1条。'."\n"
- .' '."\n"
- .'- 查询时间长度小于1天时,查询数据结果为5分钟1条。'."\n"
- .' '."\n"
+ .'| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |'."\n"
+ .'|-------------------|---------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n"
+ .'| RegionNo | string | 是 | 资源所在地域。 | cn-shanghai | - |'."\n"
+ .'| TrafficAnalyzerId | string | 是 | 流量分析器 ID。 | nta-262****ca07f | - |'."\n"
+ .'| TrafficScenario | string | 是 | 支持分析场景:<br>● 公网 VPC 流日志分析 | 固定为:VpcFlowLogInternet | VpcFlowLogInternet |'."\n"
+ .'| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 ENI 的流量。<br>● Out:流出 ENI 的流量。 | In | - In<br>- Out |'."\n"
+ .'| TupleDimension | string | 是 | 流量存储聚合维度。 | Tuple1 | - Tuple1<br>- Tuple2<br>- Tuple5 |'."\n"
+ .'| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | | - |'."\n"
+ .'| | string | 否 | 根据 TupleDimension 字段,可以指定流量的聚合维度如下:<br>● TupleDimension = Tuple1 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ CloudIp:云端 IP<br><br>● TupleDimension = Tuple2 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ SourceIp:源端 IP<br> ■ DestinationIp:目的端 IP<br> ■ TrafficPath:流量路径<br> ■ `Country`:客户端国家<br> ■ `Province`:客户端省份<br> ■ `City`:客户端城市<br> ■ `Isp`:网络服务提供商<br> ■ `Asn`:自治系统号码<br><br>● TupleDimension = Tuple5 时,支持:<br> ■ VpcId:VPC ID<br> ■ VSwitchId:交换机 ID<br> ■ NetworkInterfaceId:弹性网卡 ID<br> ■ EcsId:云服务器 ECS ID<br> ■ SourceIp:源端 IP<br> ■ DestinationIp:目的端 IP<br> ■ TrafficPath:流量路径<br> ■ SourcePort:源端端口<br> ■ DestinationPort:目的端口<br> ■ Protocol:网络协议<br> ■ Country:客户端国家<br> ■ Province:客户端省份<br> ■ City:客户端城市<br> ■ Isp:网络服务提供商<br> ■ Asn:自治系统号码 | ["VpcId"] | - VpcId<br>- VSwitchId<br>- CloudIp<br>- SourceIp<br>- DestinationIp<br>- Protocol<br>- SourcePort<br>- DestinationPort<br>- TrafficPath<br>- Country<br>- Province<br>- City<br>- Isp<br>- Asn |'."\n"
+ .'| OrderBy | string | 是 | 支持按以下指标对流量进行排名:Bytes、Packets、RoundTripTime | Bytes | - Bytes<br>- Packets<br>- RoundTripTime |'."\n"
+ .'| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | | - |'."\n"
+ .'| | object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | | - |'."\n"
+ .'| key | string | 否 | 支持过滤的条件标签键,如下所示:<br>- `TupleDimension` 为一元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `CloudIp`:云端 IP(对应 value 值可多选)<br><br>- `TupleDimension` 为二元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `SourceIp`:源端 IP(对应 value 值可多选)<br> - `DestinationIp`:目的端 IP(对应 value 值可多选)<br> - `TrafficPath`:流量路径(对应 value 值可多选)<br> - `ClientCountry`:按国家过滤流量分析范围(对应 value 值可多选)<br> - `ClientCity`:按城市过滤流量分析范围(对应 value 值可多选)<br> - `ClientAsn`:按 ASN 过滤流量分析范围(对应 value 值可多选)<br> - `ClientIsp`:按客户端运营商过滤流量分析范围(对应 value 值可多选)<br><br>- `TupleDimension` 为五元组时,支持:<br> - `FlowAction`:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)<br> - `VpcId`:VPC ID(对应 value 值可多选)<br> - `VSwitchId`:交换机 ID(对应 value 值可多选)<br> - `NetworkInterfaceId`:弹性网卡 ID(对应 value 值可多选)<br> - `EcsId`:云服务器 ECS ID(对应 value 值可多选)<br> - `SourceIp`:源端 IP<br> - `DestinationIp`:目的端 IP<br> - `TrafficPath`:流量路径(对应 value 值可多选)<br> - `SourcePort`:源端口(对应 value 值可多选)<br> - `DestinationPort`:目的端口(对应 value 值可多选)<br> - `Protocol`:网络协议(对应 value 值可多选)<br> - `ClientCountry`:按国家过滤流量分析范围(对应 value 值可多选)<br> - `ClientCity`:按城市过滤流量分析范围(对应 value 值可多选)<br> - `ClientAsn`:按 ASN 过滤流量分析范围(对应 value 值可多选)<br> - `ClientIsp`:按客户端运营商过滤流量分析范围(对应 value 值可多选)<br><br>- VPC 场景下,均可按流量指标过滤:<br> - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)<br> - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)<br> - `MinRoundTripTime`:指定参与排序的最小 RTT,单位 ms(对应 value 值不可多选)<br> - `MaxRoundTripTime`:指定参与排序的最大 RTT,单位 ms(对应 value 值不可多选)<br> - `MinPackages`:指定参与排序的最小包数,单位个(对应 value 值不可多选)<br> - `MaxPackages`:指定参与排序的最大包数,单位个(对应 value 值不可多选) | FlowAction | - FlowAction<br>- VpcId<br>- VSwitchId<br>- NetworkInterfaceId<br>- CloudIp<br>- DestinationIp<br>- SourceIp<br>- EcsId<br>- TrafficPath<br>- ClientCountry<br>- ClientCity<br>- ClientAsn<br>- ClientIsp<br>- SourcePort<br>- DestinationPort<br>- Protocol<br>- MinBytes<br>- MaxBytes<br>- MinRoundTripTime<br>- MaxRoundTripTime<br>- MinPackages<br>- MaxPackages |'."\n"
+ .'| value | array | 否 | 过滤条件的值。 | | - |'."\n"
+ .'| | string | 否 | 根据过滤的 key 类型,传入对应的过滤值。<br> - 当 key 为 `FlowAction` 时,value 枚举为:<br> - `ACCEPT`(默认传 `Accept`):安全组和网络 ACL 允许的流量<br> - `REJECT`:安全组和网络 ACL 拒绝的流量 | Accept | - |'."\n"
+ .'| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in):<br>● in:等于<br>● not in:不等于<br>● like:包含<br><br>● 当 key 为以下字段时,支持 like:<br> ○ CloudIp<br> ○ SourceIp<br> ○ DestinationIp<br>除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in <br> - in <br> - like |'."\n"
+ .'| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |'."\n"
+ .'| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |'."\n"
+ .'| Sort | string | 否 | 指定流量分析的排序方式:<br>● ASC:按正序排序。<br>● DESC:按逆序排序。 | Desc | - Desc<br>- Asc |'."\n"
+ .'| TopN | integer | 否 | 指定流量排序查询的条目数。<br>支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |'."\n"
+ .'| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN<br>- en-US |'."\n"
+ .'| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |'."\n"
+ .'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |'."\n"
+ .'| StorageInterval | integer | 否 | 存储桶精度属性。<br><br>存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。<br><br>- 流量分析器对应元组支持的存储精度为:<br> - `1`:单位分钟(1 分钟)<br> - `10`:单位分钟(10 分钟)<br> - `60`:单位分钟(60 分钟,即 1 小时)<br> - `1440`:单位分钟(1440 分钟,即 1 天)<br><br>- 存储桶精度可用于两类典型用途:<br> - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合<br> - 长周期流量统计:如 1440 分钟(1 天)聚合<br><br>- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:<br> - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据<br> - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1<br>- 10<br>- 60<br>- 1440 |'."\n"
."\n"
- .'### **请求参数**'."\n"
+ .'### 返回参数'."\n"
."\n"
- .'| **名称** | **类型** | **必填** | **描述** |'."\n"
- .'| --- | --- | --- | --- |'."\n"
- .'| RegionNo | string | 是 | 阿里云地域。 |'."\n"
- .'| ResourceType | string | 是 | 固定选择**IntranetProbing**,表示查询跨可用区性能监控趋势。 |'."\n"
- .'| MetricName | string | 是 | 指定查询趋势的指标,取值:**rtt**,探测的往返延迟。 |'."\n"
- .'| Dimensions | object\\[\\] | 是 | 过滤信息。 |'."\n"
- .'| \\-Name | string | 是 | 过滤条件,取值:<br> - **SourceZone**:探测的源可用区,必须指定。<br> - **DestinationZone**:探测的目的可用区,必须指定。 |'."\n"
- .'| \\-Value | string | 是 | 过滤条件对应的过滤值,示例如下:<br> - SourceZone:cn-hangzhou-j<br> - DestinationZone:cn-hangzhou-k |'."\n"
+ .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
+ .'|---------------------|--------|----------------------------------------------------------------------------------------|---------------------------|--------|'."\n"
+ .'| | object | RpcResponse<ArrayList> | | - |'."\n"
+ .'| RequestId | string | 请求ID。 | | - |'."\n"
+ .'| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |'."\n"
."\n"
- .'### **返回参数**'."\n"
+ .'## 全部 TR 流日志分析-TR跨地域'."\n"
."\n"
- .'| **名称** | **类型** | **描述** |'."\n"
- .'| --- | --- | --- |'."\n"
- .'| RequestId | string | 请求ID。 |'."\n"
- .'| Data | object | 云网络指标趋势数据对象 |'."\n"
- .'| Metrics | array | 指标趋势数据集合 |'."\n"
- .'| \\-TimeStamp | long | 毫秒时间戳。 |'."\n"
- .'| \\-Value | double | 入参**MetricName**对应的指标值。 |'."\n"
- .'| Unit | String | 表示**Value**的单位。 |'."\n"
+ .'### 请求参数'."\n"
."\n"
- .'## **跨地域内网性能观测大盘场景**'."\n"
+ .'| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |'."\n"
+ .'|-------------------|---------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n"
+ .'| RegionNo | string | 是 | 资源所在地域 | cn-shanghai | - |'."\n"
+ .'| TrafficAnalyzerId | string | 是 | 流量分析器 ID | nta-262****ca07f | - |'."\n"
+ .'| TrafficScenario | string | 是 | 支持分析场景:<br>● 全部TR流日志分析 | 固定为:TRFlowLog | TRFlowLog |'."\n"
+ .'| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 TR 的流量。<br>● Out:流出 TR 的流量。 | In | - In <br>- Out |'."\n"
+ .'| TupleDimension | string | 否 | 流量存储聚合维度。 | Tuple2 | - Tuple2 <br>- Tuple5 |'."\n"
+ .'| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | | - |'."\n"
+ .'| | string | 否 | (TR 流日志场景,元组自适应,`TupleDimension` 非必填)支持:<br>- `TransitRouterAttachmentId`: 网络实例连接 ID(必填)<br> - `TransitRouterId`:转发路由器实例 ID<br> - `SourceIp`:源端 IP<br> - `DestinationIp`:目的端 IP<br> - `Dscp`:区分服务代码点<br> - `Protocol`:网络协议<br> - `SourcePort`:源端端口<br> - `DestinationPort`:目的端端口 | ["TransitRouterAttachmentId"] | - TransitRouterAttachmentId<br> - TransitRouterId<br> - SourceIp<br> - DestinationIp<br> - Dscp<br> - Protocol<br> - SourcePort<br> - DestinationPort |'."\n"
+ .'| OrderBy | string | 是 | 支持按以下指标对流量进行排名: <br> - `Bytes`:带宽<br> - `Packets`:包数<br> - `PacketsLostNoRoute`:无路由丢包数<br> - `PacketsLostBlackhole`:黑洞路由丢包数<br> - `PacketsLostTTLExpired`:TTL 超时丢包数 | Bytes | - Bytes<br>- Packets<br>- PacketsLostNoRoute<br>- PacketsLostBlackhole<br>- PacketsLostTTLExpired |'."\n"
+ .'| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | | - |'."\n"
+ .'| | object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | | - |'."\n"
+ .'| key | string | 否 | 支持过滤的条件标签键,如下所示:<br>- 查询二元组或自适应为二元组时,支持:<br> - `TransitRouterAttachmentId`:网络实例连接 ID(必填,对应value值不可多选)<br> - `TransitRouterPairAttachmentId`:对端TR连接ID(对应value值可多选)<br> - `TransitRouterId`:转发路由器实例 ID(对应value值可多选)<br> - `SourceIp`:源端 IP(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)<br> - `DestinationIp`:目的端 IP(Operator= like时对应value值不可多选,Operator != like时对应value值可多选)<br> - `Dscp`:区分服务代码点(对应value值可多选)<br><br> - 查询五元组或自适应为五元组时,在二元组支持的基础上,额外支持:<br> - `Protocol`:网络协议(对应value值可多选)<br> - `SourcePort`:源端端口(对应value值可多选)<br> - `DestinationPort`:目的端端口(对应value值可多选)<br><br> - TR 场景下,均可按流量指标过滤:<br> - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应value值不可多选)<br> - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应value值不可多选)<br> - `MinPackages`:指定参与排序的最小包数,单位个(对应value值不可多选)<br> - `MaxPackages`:指定参与排序的最大包数,单位个(对应value值不可多选)<br> - `MinPacketsLostNoRoute`:最小无路由丢包数,单位个(对应value值不可多选)<br> - `MinPacketsLostBlackhole`:最小黑洞路由丢包数,单位个(对应value值不可多选)<br> - `MinPacketsLostTTLExpired`:最小 TTL 超时丢包数,单位个(对应value值不可多选)<br> - `MaxPacketsLostNoRoute`:最大无路由丢包数,单位个(对应value值不可多选)<br> - `MaxPacketsLostBlackhole`:最大黑洞路由丢包数,单位个(对应value值不可多选)<br> - `MaxPacketsLostTTLExpired`:最大 TTL 超时丢包数,单位个(对应value值不可多选) | TransitRouterAttachmentId | - TransitRouterAttachmentId<br>- TransitRouterPairAttachmentId<br>- TransitRouterId<br>- SourceIp<br>- DestinationIp<br>- Dscp<br>- Protocol<br>- SourcePort<br>- DestinationPort<br>- MinBytes<br>- MaxBytes<br>- MinPackages<br>- MaxPackages<br>- MinPacketsLostBlackhole<br>- MaxPacketsLostBlackhole<br>- MinPacketsLostNoRoute<br>- MaxPacketsLostNoRoute<br>- MinPacketsLostTTLExpired<br>- MaxPacketsLostTTLExpired |'."\n"
+ .'| value | array | 否 | 过滤条件的值。 | | - |'."\n"
+ .'| | string | 否 | 根据过滤的key类型,传入对应的过滤值。<br>key 为 TransitRouterAttachmentId 时为必传项,对应的 value 同为必填 | tr-attach-dsvbe32hr*** | - |'."\n"
+ .'| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in):<br>● in:等于<br>● not in:不等于<br>● like:包含<br>● 当 key 为以下字段时,支持 like:<br> ○ SourceIp<br> ○ DestinationIp<br>除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in<br>- in<br>- like |'."\n"
+ .'| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |'."\n"
+ .'| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |'."\n"
+ .'| Sort | string | 否 | 指定流量分析的排序方式<br>● ASC:按正序排序。<br>● DESC:按逆序排序。 | Desc | - Desc<br>- Asc |'."\n"
+ .'| TopN | integer | 否 | 指定流量排序查询的条目数。<br>支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |'."\n"
+ .'| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN<br>- en-US |'."\n"
+ .'| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |'."\n"
+ .'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |'."\n"
+ .'| StorageInterval | integer | 否 | 存储桶精度属性。<br><br>存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。<br><br>- 流量分析器对应元组支持的存储精度为:<br> - `1`:单位分钟(1 分钟)<br> - `10`:单位分钟(10 分钟)<br> - `60`:单位分钟(60 分钟,即 1 小时)<br> - `1440`:单位分钟(1440 分钟,即 1 天)<br><br>- 存储桶精度可用于两类典型用途:<br> - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合<br> - 长周期流量统计:如 1440 分钟(1 天)聚合<br><br>- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:<br> - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据<br> - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1<br>- 10<br>- 60<br>- 1440 |'."\n"
."\n"
- .'**说明**'."\n"
+ .'### 返回参数'."\n"
."\n"
- .'- 查询时间长度超过5天时,查询数据结果为1天1条。'."\n"
- .' '."\n"
- .'- 查询时间长度超过1天时,查询数据结果为1小时1条。'."\n"
- .' '."\n"
- .'- 查询时间长度小于1天时,查询数据结果为5分钟1条。'."\n"
- .' '."\n"
+ .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
+ .'|---------------------|--------|----------------------------------------------------------------------------------------|---------------------------|--------|'."\n"
+ .'| | object | RpcResponse<ArrayList> | | - |'."\n"
+ .'| RequestId | string | 请求ID。 | | - |'."\n"
+ .'| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |'."\n"
."\n"
- .'### **请求参数**'."\n"
+ .'## 共享带宽指标分析'."\n"
."\n"
- .'| **名称** | **类型** | **必填** | **描述** |'."\n"
- .'| --- | --- | --- | --- |'."\n"
- .'| RegionNo | string | 是 | 阿里云地域。 |'."\n"
- .'| ResourceType | string | 是 | 固定选择**IntranetProbing**,表示查询跨地域性能观测排名。 |'."\n"
- .'| Direction | string | 是 | 探测方向,取值:<br> - **in**:以RegionNo为目的的探测。<br> - **out**:以RegionNo为源的探测。 |'."\n"
- .'| MetricName | string | 是 | 指定查询趋势的指标,取值:**rtt**,探测的往返延迟。 |'."\n"
- .'| Dimensions | object\\[\\] | 否 | 过滤信息。 |'."\n"
- .'| \\-Name | string | 否 | 过滤条件,取值:**DestinationRegionNo**,探测的目的地域,该参数必须指定。 |'."\n"
- .'| \\-Value | string | 否 | 目的地域ID,示例如下: DestinationRegionNo:cn-shenzhen |'."\n"
+ .'### 请求参数'."\n"
."\n"
- .'### **返回参数**'."\n"
+ .'| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |'."\n"
+ .'|-------------------|---------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n"
+ .'| RegionNo | string | 是 | 资源所在地域 | cn-shanghai | - |'."\n"
+ .'| TrafficAnalyzerId | string | 是 | 流量分析器 ID | nta-262****ca07f | - |'."\n"
+ .'| TrafficScenario | string | 是 | 支持分析场景:<br>● 共享带宽指标分析 | 固定为:CbwpMetric | CbwpMetric |'."\n"
+ .'| Direction | string | 是 | 基于阿里云资源的网络流量方向。<br>● In:流入 EIP 的流量。<br>● Out:流出 EIP 的流量。 | In | -In <br>-Out |'."\n"
+ .'| TupleDimension | string | 否 | 流量存储聚合维度。 | Tuple1 | -Tuple1 |'."\n"
+ .'| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | | - |'."\n"
+ .'| | string | 否 | CBWP 指标分析场景,(`TupleDimension` 非必填)支持:<br> - `PublicIpAddress`:绑定的 EIP 的公网 IP 地址<br> - `BindingResourceType`:EIP 所绑定的实例资源类型<br> - `BindingResourceId`:EIP 所绑定的实例资源 ID<br> - `CbwpId`:共享带宽包 ID | ["BindingResourceId"] | - BindingResourceId<br>- BindingResourceType<br>- CbwpId<br>- PublicIpAddress |'."\n"
+ .'| OrderBy | string | 是 | 支持按以下指标对流量进行排名: <br> - `Bytes`:带宽<br> - `Packets`:包数 | Bytes | - Bytes<br>- Packets |'."\n"
+ .'| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | | - |'."\n"
+ .'| | object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | | - |'."\n"
+ .'| key | string | 否 | 支持过滤的条件标签键,如下所示:<br> - 按条件过滤,支持:<br> - `PublicIpAddress`:绑定的 EIP 的公网 IP 地址(Operator = like 时对应 value 值不可多选,Operator != like 时对应 value 值可多选)<br> - `BindingResourceType`:EIP 所绑定的实例资源类型(对应 value 值可多选)<br> - `BindingResourceId`:EIP 所绑定的实例资源 ID(对应 value 值可多选)<br> - `CbwpId`:共享带宽包 ID(必填, 对应 value 值不可多选)<br> - `InstanceId`:共享带宽包所绑定的 EIP ID(对应 value 值可多选)<br><br> - CBWP 场景下,均可按流量指标过滤:<br> - `MinBytes`:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)<br> - `MaxBytes`:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)<br> - `MinPackages`:指定参与排序的最小包数,单位个(对应 value 值不可多选)<br> - `MaxPackages`:指定参与排序的最大包数,单位个(对应 value 值不可多选) | CbwpId | - PublicIpAddress<br>- InstanceId<br>- BindingResourceType<br>- BindingResourceId<br>- CbwpId<br>- MinBytes<br>- MaxBytes<br>- MinPackages<br>- MaxPackages |'."\n"
+ .'| value | array | 否 | 过滤条件的值。 | | - |'."\n"
+ .'| | string | 否 | 根据过滤的key类型,传入对应的过滤值。<br> key 为 `CbwpId` 时为必传项,对应的 value 同为必填(指定具体的共享带宽包 ID)。 | cbwp-advb35j2jn3*** | - |'."\n"
+ .'| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in):<br>● in:等于<br>● not in:不等于<br>● like:包含<br>● 当 key 为以下字段时,支持 `like`:<br> - `PublicIpAddress`<br><br>除以上字段外,其余字段仅支持 `in` 和 `not in` 操作符。<br>除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in<br>- in<br>- like |'."\n"
+ .'| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |'."\n"
+ .'| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |'."\n"
+ .'| Sort | string | 否 | 指定流量分析的排序方式<br>● ASC:按正序排序。<br>● DESC:按逆序排序。 | Desc | - Desc<br>- Asc |'."\n"
+ .'| TopN | integer | 否 | 指定流量排序查询的条目数。<br>支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |'."\n"
+ .'| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN<br>- en-US |'."\n"
+ .'| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |'."\n"
+ .'| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |'."\n"
+ .'| StorageInterval | integer | 否 | 存储桶精度属性。<br><br>存储桶精度用于查询指定的存储聚合周期。支持高精度(例如1分钟)或长周期(例如1天)2种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。<br><br>- 流量分析器对应元组支持的存储精度为:<br> - `1`:单位分钟(1 分钟)<br> - `10`:单位分钟(10 分钟)<br> - `60`:单位分钟(60 分钟,即 1 小时)<br> - `1440`:单位分钟(1440 分钟,即 1 天)<br><br>- 存储桶精度可用于两类典型用途:<br> - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合<br> - 长周期流量统计:如 1440 分钟(1 天)聚合<br><br>- 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如:<br> - 传入 `10`:查询短周期、以 10 分钟为聚合粒度的数据<br> - 传入 `1440`:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1<br>- 10<br>- 60<br>- 1440 |'."\n"
."\n"
- .'| **名称** | **类型** | **描述** |'."\n"
- .'| --- | --- | --- |'."\n"
- .'| RequestId | string | 请求ID。 |'."\n"
- .'| Data | object | 云网络指标趋势数据对象 |'."\n"
- .'| Metrics | array | 指标趋势数据集合 |'."\n"
- .'| \\-TimeStamp | long | 毫秒时间戳。 |'."\n"
- .'| \\-Value | double | 入参**MetricName**对应的指标值。 |'."\n"
- .'| Unit | String | 表示**Value**的单位。 |',
- ],
- 'StartNisInspectionTask' => [
- 'summary' => '触发一次巡检任务,产生巡检报告。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '227070',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionTaskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '巡检任务id',
- 'description' => '巡检任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ni-8svmpe0yso****r7fh79',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<StartNisInspectionTaskResponse>',
- 'description' => 'RpcResponse<StartNisInspectionTaskResponse>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
- 'InspectionReportId' => [
- 'description' => '巡检报告ID。',
- 'type' => 'string',
- 'example' => 'nir-9923e262c106461d****',
- ],
+ .'### 返回参数'."\n"
+ ."\n"
+ .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n"
+ .'|---------------------|--------|----------------------------------------------------------------------------------------|---------------------------|--------|'."\n"
+ .'| | object | RpcResponse<ArrayList> | | - |'."\n"
+ .'| RequestId | string | 请求ID。 | | - |'."\n"
+ .'| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:StartNisTrafficRanking',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncorrectStatus.InspectionTaskNotActive',
- 'errorMessage' => 'The specified task InspectionTaskId(%s) is not active and cannot be executed.',
- ],
- [
- 'errorCode' => 'DuplicatedParam.InspectionReportId',
- 'errorMessage' => 'Specified InspectionReportId(%s) duplicated in task.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'ResourceNotFound.InspectionTaskId',
- 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.InspectionResource',
- 'errorMessage' => 'The specified InspectionTaskId(%s) resource does not exist.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"InspectionReportId\\": \\"nir-9923e262c106461d****\\"\\n}","type":"json"}]',
- 'title' => '发起巡检任务',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941\\",\\n \\"NisTrafficRankingId\\": \\"task-6462a7b4c4a54b****\\"\\n}","type":"json"}]',
],
'UpdateNisInspectionTask' => [
'summary' => '更新巡检任务。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6588,22 +5269,13 @@
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '226556',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
+ 'abilityTreeNodes' => ['FEATUREnetanaS7CH2P'],
],
'parameters' => [
[
'name' => 'InspectionTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '巡检任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ni-8svmpe0yso2bhzr7fh79',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
+ 'schema' => ['description' => '巡检任务ID。', 'type' => 'string', 'required' => true, 'example' => 'ni-8svmpe0yso2bhzr7fh79', 'maxLength' => 128, 'minLength' => 1],
],
[
'name' => 'Status',
@@ -6613,10 +5285,7 @@
'type' => 'string',
'required' => false,
'example' => 'Active',
- 'enum' => [
- 'Inactive',
- 'Active',
- ],
+ 'enum' => ['Inactive', 'Active'],
],
],
],
@@ -6627,1598 +5296,926 @@
'description' => 'RpcResponse<Boolean>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
- 'Data' => [
- 'description' => '更新结果。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F'],
+ 'Data' => ['description' => '更新结果。', 'type' => 'boolean', 'example' => 'True'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IncorrectStatus.InspectionTaskIsRunning',
- 'errorMessage' => 'The specified task InspectionTaskId(%s) is in progress and cannot be closed.',
- ],
- [
- 'errorCode' => 'IncorrectStatus.InspectionTaskNotInactive',
- 'errorMessage' => 'The specified task InspectionTaskId(%s) is not closed and cannot be opened.',
- ],
- [
- 'errorCode' => 'IllegalParam.Status',
- 'errorMessage' => 'The specified parameter Status(%s) is invalid, can only be Active or InActive.',
- ],
+ ['errorCode' => 'IncorrectStatus.InspectionTaskIsRunning', 'errorMessage' => 'The specified task InspectionTaskId(%s) is in progress and cannot be closed.', 'description' => '指定的任务InspectionTaskId(%s)正在执行中不能关闭。'],
+ ['errorCode' => 'IncorrectStatus.InspectionTaskNotInactive', 'errorMessage' => 'The specified task InspectionTaskId(%s) is not closed and cannot be opened.', 'description' => '指定的任务InspectionTaskId(%s)不是关闭状态不支持开启'],
+ ['errorCode' => 'IllegalParam.Status', 'errorMessage' => 'The specified parameter Status(%s) is invalid, can only be Active or InActive.', 'description' => '指定的参数Status(%s)不合法,只能是Active或者InActive。'],
],
404 => [
- [
- 'errorCode' => 'ResourceNotFound.InspectionTaskId',
- 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.',
- ],
+ ['errorCode' => 'ResourceNotFound.InspectionTaskId', 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.', 'description' => '指定的InspectionTaskId(%s)不存在。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"Data\\": true\\n}","type":"json"}]',
'title' => '更新巡检任务',
- ],
- 'DeleteNisInspectionTask' => [
- 'summary' => '删除巡检任务。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '226555',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionTaskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ni-209d****wfirfwc2yl'."\n",
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<Boolean>',
- 'description' => 'RpcResponse<Boolean>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
- 'Data' => [
- 'description' => '删除结果。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'nis:UpdateNisInspectionTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncorrectStatus.InspectionTaskNotInactive',
- 'errorMessage' => 'The specified task InspectionTaskId(%s) is not closed and cannot be deleted.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'ResourceNotFound.InspectionTaskId',
- 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.',
- ],
- ],
- ],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '删除巡检任务',
],
- 'ListNisInspectionTasks' => [
- 'summary' => '网络巡检任务列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226558',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionTaskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ni-8svm******hzr7fh79',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'InspectionName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'nis巡检',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'InspectionProject',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检任务采用的巡检方案类别:基础(basic)/自定义场景(customized)',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'customized' => 'customized',
- 'basic' => 'basic',
- ],
- 'example' => 'basic',
- 'maxLength' => 64,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务运行状态:'."\n"
- ."\n"
- .'Creating: 创建中'."\n"
- ."\n"
- .'Active: 已开启'."\n"
- ."\n"
- .'Running: 执行中'."\n"
- ."\n"
- .'Inactive:已关闭',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Creating' => 'Creating',
- 'Active' => 'Active',
- 'Running' => 'Running',
- 'Inactive' => 'Inactive',
- ],
- 'example' => 'Active',
- 'maxLength' => 50,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hKrS+MVXkuOgztXnvdml1/R9jhHkiH8eW3CfaOYU0CEL7yiT0zae6J8v1zYNg+d1',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页大小,取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<ListNisInspectTasksResponse>',
- 'description' => 'RpcResponse<ListNisInspectTasksResponse>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
- 'InspectionTaskList' => [
- 'description' => '巡检任务列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InspectionTaskId' => [
- 'description' => '巡检任务ID',
- 'type' => 'string',
- 'example' => 'ni-8svm******hzr7fh79',
- ],
- 'InspectionName' => [
- 'description' => '巡检任务名称',
- 'type' => 'string',
- 'example' => 'nis巡检',
- ],
- 'Status' => [
- 'description' => '任务运行状态:'."\n"
- ."\n"
- .'Creating: 创建中'."\n"
- ."\n"
- .'Active: 已开启'."\n"
- ."\n"
- .'Running: 执行中'."\n"
- ."\n"
- .'Inactive:已关闭',
- 'type' => 'string',
- 'example' => 'Active',
- ],
- 'InspectionProject' => [
- 'description' => '巡检任务采用的巡检方案类别:基础(basic)/自定义场景(customized)',
- 'type' => 'string',
- 'example' => 'basic',
- ],
- 'CreateTime' => [
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-06-18 00:14:46',
- ],
- 'LastUpdateReportId' => [
- 'description' => '最新报告ID',
- 'type' => 'string',
- 'example' => 'nir-b4c4c9******8a25e',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '是否拥有下一次查询的令牌(Token)。取值:如果NextToken为空表示没有下一次查询。 如果NextToken有返回值,该取值表示下一次查询开始的令牌。',
- 'type' => 'string',
- 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj',
- ],
- 'MaxResults' => [
- 'description' => '分页大小,取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => '返回的条目总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'nis.aliyuncs.com', 'endpoint' => 'nis.aliyuncs.com', 'vpc' => 'nis.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'nis-intl.aliyuncs.com', 'endpoint' => 'nis-intl.aliyuncs.com', 'vpc' => 'nis-intl.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Common.Timeout', 'message' => 'Timeout, please narrow your input time range.', 'http_code' => 500, 'description' => '接口请求超时,可能是因为您一次性请求的数量过多,请尝试缩小您的请求范围'],
+ ['code' => 'DiagnosticItemSetId.NotFound', 'message' => 'The specified diagnosticItemSetId of %s is not found.', 'http_code' => 404, 'description' => '参数 %s 不存在'],
+ ['code' => 'DiagnosticItemSetId.NotFound', 'message' => 'The specified DiagnosticItemSetId is not found.', 'http_code' => 404, 'description' => '参数DiagnosticItemSetId不存在'],
+ ['code' => 'DryRunOperation', 'message' => 'Request validation has been passed with DryRun flag set.', 'http_code' => 400, 'description' => '参数检查通过'],
+ ['code' => 'Duplicate.TagKey', 'message' => 'The Tag.N.Key contains duplicate keys.', 'http_code' => 400, 'description' => 'Tag的包含重复的key。'],
+ ['code' => 'DuplicatedParam.AddIps', 'message' => 'The specified AddIps parameter contains existing IP.', 'http_code' => 400, 'description' => '指定的AddIps参数中包含已存在的IP。'],
+ ['code' => 'DuplicatedParam.Filter', 'message' => 'The specified Filter(%s) parameter has a duplicate Key.', 'http_code' => 400, 'description' => '指定的Filter(%s)参数存在重复Key。'."\n"],
+ ['code' => 'DuplicatedParam.GroupBy', 'message' => 'Duplicate data exists for the specified GroupBy(%s) parameter.', 'http_code' => 400, 'description' => '指定的GroupBy(%s)参数存在重复数据。'],
+ ['code' => 'DuplicatedParam.InspectionReportId', 'message' => 'Specified InspectionReportId(%s) duplicated in task.', 'http_code' => 400, 'description' => '指定的InspectionReportId(%s)在任务中重复.'],
+ ['code' => 'DuplicatedParam.TupleDimension', 'message' => 'Duplicate data exists for the specified TupleDimension(%s) parameter.', 'http_code' => 400, 'description' => '指定的TupleDimension(%s)参数存在重复数据。'],
+ ['code' => 'Flowlog.AlreayExist', 'message' => 'This attachment already has existed flowlog instance.', 'http_code' => 400, 'description' => '此连接的流日志已打开。'],
+ ['code' => 'Forbidden', 'message' => 'You are not authorized to operate on the specified resource. Contact the administrator to acquire the permission of AliyunNISReadOnlyAccess or AliyunNISFullAccess.', 'http_code' => 403, 'description' => '您无权限对该资源进行此操作,请联系管理员授权AliyunNISReadOnlyAccess或AliyunNISFullAccess权限。'],
+ ['code' => 'Forbidden.AnalysisTaskIds', 'message' => 'The user does not have the corresponding instance (%s) permission.', 'http_code' => 403, 'description' => '该用户无对应实例(%s)权限.'],
+ ['code' => 'Forbidden.CreateServiceLinkedRole', 'message' => 'The user does not have permission: %s.', 'http_code' => 403, 'description' => '当前用户无权限:%s。'],
+ ['code' => 'Forbidden.DataSourceId', 'message' => 'The user does not have permission to operate this resource (%s).', 'http_code' => 403, 'description' => '该用户没有操作该资源(%s)权限。'],
+ ['code' => 'Forbidden.DiagnosisReportIds', 'message' => 'This user does not have permission to operate this resource (%s).', 'http_code' => 403, 'description' => '该用户无可操作该资源(%s)权限.'],
+ ['code' => 'Forbidden.InsightId', 'message' => 'The user does not have permission on the instance parameter (%s).', 'http_code' => 403, 'description' => '该用户无该实例参数(%s)权限.'],
+ ['code' => 'Forbidden.InspectionReportId', 'message' => 'This user does not have permission to this report parameter (%s).', 'http_code' => 403, 'description' => '该用户无该报告参数(%s)权限。'],
+ ['code' => 'Forbidden.MappingId', 'message' => 'The user does not have permission to operate this resource (%s).', 'http_code' => 403, 'description' => '该用户没有操作该资源(%s)权限。'],
+ ['code' => 'Forbidden.NetworkPath', 'message' => 'The current user has not activated NIS and is not authorized to use the path analysis interface.', 'http_code' => 403, 'description' => '当前用户未开通NIS,无权限使用路径分析接口。'],
+ ['code' => 'Forbidden.NetworkPathId', 'message' => 'The user does not have permission on the instance parameter (%s).', 'http_code' => 403, 'description' => '该用户没有该实例资源(%s)权限.'],
+ ['code' => 'Forbidden.NetworkReachableAnalysisId', 'message' => 'The user does not have permission on the instance parameter (%s).', 'http_code' => 403, 'description' => '该用户没有该资源(%s)权限.'],
+ ['code' => 'Forbidden.NoPermission', 'message' => 'The authentication result is successful but the verification fails.', 'http_code' => 400, 'description' => '鉴权结果成功但验证未通过。'],
+ ['code' => 'Forbidden.ReportId', 'message' => 'The user does not have permission on the instance parameter (%s).', 'http_code' => 403, 'description' => '该用户没有该实例资源(%s)权限.'],
+ ['code' => 'Forbidden.ResourceId', 'message' => 'The user does not have permission on the instance parameter (%s).', 'http_code' => 403, 'description' => '该用户没有该实例资源(%s)权限.'],
+ ['code' => 'Forbidden.TagKeys', 'message' => 'The request do not allow to operate the tag keys', 'http_code' => 400, 'description' => '无权操作此标签类型。'],
+ ['code' => 'Forbidden.TaskId', 'message' => 'The user does not have permission on the instance parameter (%s).', 'http_code' => 403, 'description' => '该用户没有改实例参数(%s)的权限.'],
+ ['code' => 'Forbidden.TrafficAnalyzerId', 'message' => 'The user does not have permission to operate this resource (%s).', 'http_code' => 403, 'description' => '该用户没有操作该资源(%s)权限。'],
+ ['code' => 'ForbiddenException.UidNoPermission', 'message' => 'This user (%s) does not have AliyunServiceRoleForNis privileges.', 'http_code' => 403, 'description' => '该用户(%s)无AliyunServiceRoleForNis权限。'],
+ ['code' => 'IllegalParam', 'message' => 'The specified parameter thisRegion(%s) is illegal.', 'http_code' => 400, 'description' => '该thisRegion(%s)字段是不合法的'],
+ ['code' => 'IllegalParam.AccountIds', 'message' => 'The specified param of accountId (%s) is not in the optional range.', 'http_code' => 400, 'description' => '指定的AccountId (%s)不在用户可选范围内。'],
+ ['code' => 'IllegalParam.AccountIds', 'message' => 'The specified parameter accountId (%s) is invalid.', 'http_code' => 400, 'description' => '指定的AccountId (%s)不在用户可选范围内。'],
+ ['code' => 'IllegalParam.AddIpsOrDeleteIps', 'message' => 'The specified AddIpsOrDeleteIps parameter is illegal.', 'http_code' => 400, 'description' => '指定的AddIpsOrDeleteIps参数不合法。'],
+ ['code' => 'IllegalParam.AggregationInterval', 'message' => 'The parameter (%s) cannot be large or small.', 'http_code' => 400, 'description' => '该参数(%s)不可大与最小值。'],
+ ['code' => 'IllegalParam.AliUid', 'message' => 'The current uid (%s) has no inspection tasks.', 'http_code' => 400, 'description' => '当前用户 (%s) 没有巡检任务。'],
+ ['code' => 'IllegalParam.AnalysisLogs', 'message' => 'The specified AnalysisLogs(%s) parameter cannot be empty.', 'http_code' => 400, 'description' => '指定的AnalysisLogs(%s)参数不能为空。'],
+ ['code' => 'IllegalParam.AnalysisTaskIds', 'message' => 'The specified AnalysisTaskIds parameter is illegal.', 'http_code' => 400, 'description' => '指定的AnalysisTaskIds参数不合法。'],
+ ['code' => 'IllegalParam.BeginTime', 'message' => 'The specified begin time (%s) is invalid.', 'http_code' => 400, 'description' => '指定的开始时间(%s)不合法。'],
+ ['code' => 'IllegalParam.BeginTime', 'message' => 'The specified BeginTime parameter is illegal.', 'http_code' => 400, 'description' => '指定的BeginTime参数不合法。'],
+ ['code' => 'IllegalParam.BeginTimeAndEndTime', 'message' => 'It only supports querying data for up to 7 days: %s.', 'http_code' => 400, 'description' => '最大仅支持查询7天的数据:%s。'],
+ ['code' => 'IllegalParam.BeginTimeAndEndTime', 'message' => 'It only supports querying data for up to 24 hours: %s.', 'http_code' => 400, 'description' => '最大支持查询24小时数据。'],
+ ['code' => 'IllegalParam.BeginTimeAndEndTime', 'message' => 'The param of BeginTimeAndEndTime is illegal.', 'http_code' => 400, 'description' => '开始结束时间错误。可能是因为开始时间大于结束时间,或范围超出最大限制'],
+ ['code' => 'IllegalParam.BeginTimeAndEndTime1H', 'message' => 'It only supports querying data for up to 1 hour: %s.', 'http_code' => 400, 'description' => '最长支持查询1小时数据: %s。'],
+ ['code' => 'IllegalParam.BeginTimeAndEndTime5M', 'message' => 'It only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.', 'http_code' => 400, 'description' => '当TupleType=5且CloudIp、OtherIp都是空时,只支持查询最长5分钟范围的数据。'],
+ ['code' => 'IllegalParam.CenId', 'message' => 'The parameter CenId is not specified.', 'http_code' => 400, 'description' => 'CenId参数未指定。'],
+ ['code' => 'IllegalParam.CloudIp', 'message' => 'The specified CloudIp(%s) is invalid.', 'http_code' => 400, 'description' => '指定的CloudIp(%s)不合法。'],
+ ['code' => 'IllegalParam.CloudPort', 'message' => 'The specified CloudPort(%s) is invalid.', 'http_code' => 400, 'description' => '指定的CloudPort(%s)不合法。'],
+ ['code' => 'IllegalParam.DataSourceIdOrNtaId', 'message' => 'TrafficAnalyzerId and DataSourceId cannot be empty at the same time.', 'http_code' => 400, 'description' => 'TrafficAnalyzerId和DataSourceId不可同时为空。'],
+ ['code' => 'IllegalParam.DataSourceType', 'message' => 'The parameter (%s) is illegal.', 'http_code' => 400, 'description' => '该参数(%s)不合法。'],
+ ['code' => 'IllegalParam.DestinationIp', 'message' => 'The specified ip(%s) is illegal.', 'http_code' => 400, 'description' => '指定的ip(%s)不合法。'],
+ ['code' => 'IllegalParam.DestinationIpAddress', 'message' => 'The specified DestinationIpAddress(%s) is invalid.', 'http_code' => 400, 'description' => '指定的DestinationIpAddress(%s)参数不合法。'],
+ ['code' => 'IllegalParam.DestinationPort', 'message' => 'The specified DestinationPort(%s) is invalid.', 'http_code' => 400, 'description' => '指定的DestinationPort(%s)参数不合法。'],
+ ['code' => 'IllegalParam.DestinationSubnet', 'message' => 'The request parameter destination network segment (%s) is invalid.', 'http_code' => 400, 'description' => '该请求参数目标网段(%s)不合法。'],
+ ['code' => 'IllegalParam.DestinationZones', 'message' => 'The param of DestinationZones is illegal.', 'http_code' => 400, 'description' => '输入的目的可用区不合法,可能是与 RegionId 不匹配'],
+ ['code' => 'IllegalParam.Dimensions', 'message' => 'The specified Dimensions(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Dimensions(%s)参数不合法。'],
+ ['code' => 'IllegalParam.Dimensions.DestinationRegionId', 'message' => 'The specified parameter Dimensions.DestinationRegionId(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Dimensions.DestinationRegionId(%s)参数非法。'],
+ ['code' => 'IllegalParam.Dimensions.DestinationRegionNo', 'message' => 'The specified parameter Dimensions.DestinationRegionNo(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Dimensions.DestinationRegionNo(%s)参数非法。'],
+ ['code' => 'IllegalParam.Dimensions.DestinationZone', 'message' => 'The specified parameter Dimensions.DestinationZone (%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数Dimensions.DestinationZone(%s)不合法。'],
+ ['code' => 'IllegalParam.Dimensions.Direction', 'message' => 'The specified Dimensions.Direction(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Dimensions.Direction(%s)参数不合法。'],
+ ['code' => 'IllegalParam.Dimensions.InspectionTaskId', 'message' => 'The specified argument Dimensions.InspectionTaskId(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数Dimensions.InspectionTaskId(%s)不合法。'],
+ ['code' => 'IllegalParam.Dimensions.InstanceId', 'message' => 'The specified Dimensions.InstanceId(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Dimensions.InstanceId(%s)参数不合法。'],
+ ['code' => 'IllegalParam.Dimensions.ResourceType', 'message' => 'The specified Dimensions.ResourceType(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Dimensions.ResourceType(%s)参数不合法。'],
+ ['code' => 'IllegalParam.Dimensions.SourceZone', 'message' => 'The specified parameter Dimensions.SourceZone(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数Dimensions.SourceZone(%s)不合法。'],
+ ['code' => 'IllegalParam.Dimensions.TrafficScenario', 'message' => 'The argument Dimensions.TrafficScenario(%s) is illegal.', 'http_code' => 400, 'description' => '该参数Dimensions.TrafficScenario(%s)不合法。'],
+ ['code' => 'IllegalParam.Dimensions.TupleDimension', 'message' => 'The argument Dimensions.TupleDimension(%s) is illegal.', 'http_code' => 400, 'description' => '该参数Dimensions.TupleDimension(%s)不合法。'],
+ ['code' => 'IllegalParam.Direction', 'message' => 'The specified direction (%s) is invalid.', 'http_code' => 400, 'description' => '指定的Direction参数不合法,请修改。'],
+ ['code' => 'IllegalParam.DiskCategory', 'message' => 'The specified disk category (%s) is invalid.', 'http_code' => 400, 'description' => '指定的磁盘类型(%s)不合法。'],
+ ['code' => 'IllegalParam.EnableAndIntervalEmpty', 'message' => 'The specified parameter LogAggregationInterval and EnableNISTrafficAnalyzer cannot be both empty.', 'http_code' => 400, 'description' => '指定的参数LogAggregationInterval和EnableNISTrafficAnalyzer不能同时都为空。'],
+ ['code' => 'IllegalParam.EnableNISTrafficAnalyzer', 'message' => 'The specified EnableNISTrafficAnalyzer(%s) argument is illegal.', 'http_code' => 400, 'description' => '指定的EnableNISTrafficAnalyzer(%s)参数不合法。'],
+ ['code' => 'IllegalParam.EndTime', 'message' => 'The specified end time (%s) is invalid.', 'http_code' => 400, 'description' => '指定的结束时间(%s)不合法。'],
+ ['code' => 'IllegalParam.EventType', 'message' => 'The specified EventType(%s) is invalid.', 'http_code' => 400, 'description' => '指定的EventType参数(%s)不合法。'],
+ ['code' => 'IllegalParam.ExtraInfo.NetworkInterfaceId', 'message' => 'The specified ExtraInfo.NetworkInterfaceId parameter is illegal.', 'http_code' => 400, 'description' => '指定的ExtraInfo.NetworkInterfaceId参数不合法。'],
+ ['code' => 'IllegalParam.Filter.Combine', 'message' => 'The specified filter parameter(%s) is invalid.', 'http_code' => 400, 'description' => '当前过滤参数不合法。'],
+ ['code' => 'IllegalParam.Filter.FlowAction', 'message' => 'The parameter Filter.FlowAction(%s) is illegal.', 'http_code' => 400, 'description' => '该参数Filter.FlowAction(%s)不合法.'],
+ ['code' => 'IllegalParam.Filter.InstanceId', 'message' => 'The specified InstanceId(%s) is illegal.', 'http_code' => 400, 'description' => '指定的InstanceId(%s)参数非法。'],
+ ['code' => 'IllegalParam.Filter.QueryByRelationshipType', 'message' => 'The specified filter parameter(%s) is invalid.', 'http_code' => 400, 'description' => '指定过滤参数(%s)不合法。'],
+ ['code' => 'IllegalParam.Filter.QueryByResourceType', 'message' => 'The specified filter parameter(%s) is invalid.', 'http_code' => 400, 'description' => '过滤参数(%s)不合法。'],
+ ['code' => 'IllegalParam.FlowLogIntervalGreaterThanNta', 'message' => 'The FlowLog sampling interval (%s) specified is greater than the minimum sampling interval of the traffic analyzer.', 'http_code' => 400, 'description' => '指定的FlowLog的采样间隔(%s)大于流量分析器的最小采样间隔。'],
+ ['code' => 'IllegalParam.FlowLogNotSupport', 'message' => 'The parameter MetricName(%s) is illegal.', 'http_code' => 400, 'description' => '该参数MetricName(%s)不合法.'],
+ ['code' => 'IllegalParam.FlowLogStatusNotInactive', 'message' => 'FlowLog status is not Inactive.', 'http_code' => 400, 'description' => 'flowLog状态不是Inactive'],
+ ['code' => 'IllegalParam.GroupBy', 'message' => 'The specified param of GroupBy (%s) is invalid.', 'http_code' => 400, 'description' => '指定的分组字段(%s)不合法。'],
+ ['code' => 'IllegalParam.inOrOut', 'message' => 'Valid values for the inOrOut parameter: in and out.', 'http_code' => 400, 'description' => '参数inOrOut必须为i(\'in\',\'out\')之一。'],
+ ['code' => 'IllegalParam.InsightId', 'message' => 'The specified InsightId(%s) is illegal.', 'http_code' => 400, 'description' => '指定的InsightId参数不合法。'],
+ ['code' => 'IllegalParam.InsightIds', 'message' => 'The specified InsightIds(%s) parameter is illegal.', 'http_code' => 400, 'description' => '指定的InsightIds(%s)参数不合法。'],
+ ['code' => 'IllegalParam.InspectionProject', 'message' => 'The specified argument InspectionProject(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数InspectionProject不合法。'],
+ ['code' => 'IllegalParam.InspectionType', 'message' => 'The specified inspectionType (%s) is not supported.', 'http_code' => 400, 'description' => '参数inspectionType不合法'],
+ ['code' => 'IllegalParam.InstanceChargeType', 'message' => 'The specified InstanceChargeType is invalid.', 'http_code' => 404, 'description' => '?参数InstanceChargeType非法'],
+ ['code' => 'IllegalParam.InstanceIps', 'message' => 'The specified InstanceIps (%s) is invliad.', 'http_code' => 400, 'description' => '指定的InstanceIps(%s)参数不合法。'],
+ ['code' => 'IllegalParam.InternetIP', 'message' => 'The specified IP address (%s) is not an internet IP address.', 'http_code' => 400, 'description' => '指定的IP(%s)不是公网地址。即IP地址不能在10.0.0.0~10.255.255.255、172.16.0.0 ~172.31.255.255、192.168.0.0~192.168.255.255 这3个地址段内。'],
+ ['code' => 'IllegalParam.Interval', 'message' => 'The specified Interval(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Interval(%s)参数不合法。'],
+ ['code' => 'IllegalParam.IntervalImmutable', 'message' => 'The sample time of this parameter information (%s) cannot be modified.', 'http_code' => 400, 'description' => '该参数信息(%s)的采样时间不允许修改。'],
+ ['code' => 'IllegalParam.IP', 'message' => 'The specified IP address (%s) is invalid.', 'http_code' => 400, 'description' => '指定的IP地址(%s)无效。'],
+ ['code' => 'IllegalParam.IpType', 'message' => 'The specified IpType (%s) is invalid.', 'http_code' => 400, 'description' => '指定的IpType参数不合法。'],
+ ['code' => 'IllegalParam.IpTypeAndBindType', 'message' => 'It it not support the combination of IpType and BindType(%s).', 'http_code' => 400, 'description' => '不支持当前IpType和BindType(%s)的参数组合。'],
+ ['code' => 'IllegalParam.Ipv4Prefix', 'message' => 'The parameter Ipv4Prefix is invalid.', 'http_code' => 400, 'description' => '参数Ipv4Prefix非法'],
+ ['code' => 'IllegalParam.Kaleidoscope', 'message' => 'The user RFQ call kaleidoscope error.', 'http_code' => 400, 'description' => '该用户询价调用万花筒错误。'],
+ ['code' => 'IllegalParam.LogAggregationInterval', 'message' => 'The specified LogAggregationInterval(%s) argument is illegal.', 'http_code' => 400, 'description' => '指定的LogAggregationInterval(%s)参数不合法。'],
+ ['code' => 'IllegalParam.LogId', 'message' => 'The specified LogId(%s) parameter cannot be empty.', 'http_code' => 400, 'description' => 'LogId不能为空'],
+ ['code' => 'IllegalParam.MappingId', 'message' => 'The parameter (%) is illegal.', 'http_code' => 400, 'description' => '该参数(%)不合法。'],
+ ['code' => 'IllegalParam.MaxResult', 'message' => 'The specified param of MaxResult (%s) is invalid.', 'http_code' => 400, 'description' => '指定的最大查询条数MaxResult(%s)超出查询限制。'],
+ ['code' => 'IllegalParam.MaxTimeScope', 'message' => 'The query time range exceeds the limit. You can query up to %s days of data.', 'http_code' => 400, 'description' => '查询时间范围超出限制,最大支持查询%s天的数据。'],
+ ['code' => 'IllegalParam.MetricName', 'message' => 'The specified MetricName(%s) is illegal.', 'http_code' => 400, 'description' => '指定的MetricName(%s)参数不合法。'],
+ ['code' => 'IllegalParam.MetricType', 'message' => 'The specified metricType (%s) is not supported.', 'http_code' => 400, 'description' => '指定的metricType参数不支持,目前只支持sp和fp。'],
+ ['code' => 'IllegalParam.MetricType', 'message' => 'The specified MetricType(%s) is illegal.', 'http_code' => 400, 'description' => '指定的MetricType(%s)参数不合法。'],
+ ['code' => 'IllegalParam.Name', 'message' => 'The specified Name(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Name参数不合法,可能是长度过长。'],
+ ['code' => 'IllegalParam.NetworkPathId', 'message' => 'The parameter (%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数(%s)不能为空.'],
+ ['code' => 'IllegalParam.NetworkReachableAnalysisId', 'message' => 'The parameter (%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数(%s)不能为空。'],
+ ['code' => 'IllegalParam.NextToken', 'message' => 'The specified nextToken(%s) is invalid.', 'http_code' => 400, 'description' => '指定的NextToken(%s)参数不合法。'],
+ ['code' => 'IllegalParam.NextToken', 'message' => 'The specified argument NextToken(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数NextToken(%s)不合法。'."\n"],
+ ['code' => 'IllegalParam.NextToken', 'message' => 'The specified NextToken(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数NextToken不合法。'],
+ ['code' => 'IllegalParam.NextToken', 'message' => 'The specified parameter NextToken is illegal.', 'http_code' => 400, 'description' => '指定的参数NextToken不合法。'],
+ ['code' => 'IllegalParam.NotPublicIp', 'message' => 'The specified (%s) is invalid.', 'http_code' => 400, 'description' => '指定的参数 (%s) 不是公网IP。'."\n"],
+ ['code' => 'IllegalParam.NotSupportHaVpn', 'message' => 'The specified VPN(%s), which is not currently supported for such instances.', 'http_code' => 400, 'description' => '指定的VPN(%s)是HaVpn,此类实例目前尚不支持。'."\n"],
+ ['code' => 'IllegalParam.NotTr', 'message' => 'The specified TR(%s), which is not currently supported for such instances.', 'http_code' => 400, 'description' => '指定的转发路由器TR(%s)不是企业版,此类实例目前尚不支持。'],
+ ['code' => 'IllegalParam.NtaIntervalLessThanFlowLog', 'message' => 'The sampling interval of the specified traffic analyzer is less than the maximum sampling interval of the associated network log (%s).', 'http_code' => 400, 'description' => '指定的流量分析器采样间隔小于已经关联的网络日志的最大采样间隔(%s)。'],
+ ['code' => 'IllegalParam.NullSystemParam', 'message' => 'The system parameter (%s) is not specified. This problem occurs mostly when called through the SDK.', 'http_code' => 400, 'description' => '系统参数(%s)未指定。此问题多发生在通过SDK调用时。'],
+ ['code' => 'IllegalParam.ObjectId', 'message' => 'The specified objectId (%s) is not supported.', 'http_code' => 400, 'description' => '参数objectId不合法'],
+ ['code' => 'IllegalParam.ObjectType', 'message' => 'The specified objectType (%s) is not supported.', 'http_code' => 400, 'description' => '参数objectType不支持'],
+ ['code' => 'IllegalParam.OrderBy', 'message' => 'The specified param of orderBy (%s) is invalid.', 'http_code' => 400, 'description' => '指定的排序字段(%s)不合法。'],
+ ['code' => 'IllegalParam.OtherIp', 'message' => 'The specified OtherIp(%s) is invalid.', 'http_code' => 400, 'description' => '指定的OtherIp(%s)不合法。'],
+ ['code' => 'IllegalParam.OtherPort', 'message' => 'The specified OtherPort(%s) is invalid.', 'http_code' => 400, 'description' => '指定的OtherPort(%s)不合法。'],
+ ['code' => 'IllegalParam.Period', 'message' => 'The specified Period is invalid.', 'http_code' => 404, 'description' => '参数Period非法'],
+ ['code' => 'IllegalParam.Period', 'message' => 'The specified period (%s) is not supported.', 'http_code' => 400, 'description' => '参数period不合法'],
+ ['code' => 'IllegalParam.ProductId', 'message' => 'The specified ProductId is invalid.', 'http_code' => 404, 'description' => '参数ProductId非法'],
+ ['code' => 'IllegalParam.Protocol', 'message' => 'The specified Protocol(%s) is invalid.', 'http_code' => 400, 'description' => '指定的Protocol(%s)参数不合法。'],
+ ['code' => 'IllegalParam.QueryTimeRange', 'message' => 'The specified query time range is too long. You can query data less than %s.', 'http_code' => 400, 'description' => '指定的查询时间范围过长,支持查询%s以内的数据。'],
+ ['code' => 'IllegalParam.Reachable', 'message' => 'The specified reachable (%s) is invalid. It must be one of the following: true, false, or null.', 'http_code' => 400, 'description' => '指定的Reachable变量值(%s)不合法,其枚举为:true/false/null。'],
+ ['code' => 'IllegalParam.RegionId', 'message' => 'The specified region ID (%s) is invalid.', 'http_code' => 400, 'description' => '指定的地域(%s)不合法。'],
+ ['code' => 'IllegalParam.RegionId', 'message' => 'The specified RegionId parameter is illegal.', 'http_code' => 400, 'description' => '指定的RegionId参数不合法。'],
+ ['code' => 'IllegalParam.regionId', 'message' => 'The specified RegionID (%s) is invalid.', 'http_code' => 400, 'description' => "\n"
+ ."\n"
+ .'The specified RegionID (%s) is invalid.'],
+ ['code' => 'IllegalParam.RegionId', 'message' => 'The specified parameter RegionId(%s) is illegal.', 'http_code' => 400, 'description' => 'RegionId参数不合法'],
+ ['code' => 'IllegalParam.RegionIdAndIpMap', 'message' => 'The specified RegionIdAndIpMap(%s) is invalid.', 'http_code' => 400, 'description' => '指定的RegionIdAndIpMap(%s)参数不合法,RegionIdAndIpMap需要是个JSON格式字符串,其中key为合法Region,value为逗号分隔的IP。'],
+ ['code' => 'IllegalParam.RegionIdAndIpMap.Ips', 'message' => 'The specified (%s) in RegionIdAndIpMap is invalid, which should be ip address separated by comma.', 'http_code' => 400, 'description' => '参数RegionIdAndIpMap中指定的(%s)不合法,应该是逗号分隔的IP。'],
+ ['code' => 'IllegalParam.RegionIdAndIpMap.RegionId', 'message' => 'The specified (%s) in RegionIdAndIpMap is an invalid region.', 'http_code' => 400, 'description' => '参数RegionIdAndIpMap里指定的(%s)不是一个合法的Region。'],
+ ['code' => 'IllegalParam.RegionIdNotSupported', 'message' => 'The specified parameter RegionId(%s) is not supported.', 'http_code' => 400, 'description' => '指定的参数RegionId(%s)不支持。'],
+ ['code' => 'IllegalParam.RegionIds', 'message' => 'The specified RegionIds (%s) is invalid.', 'http_code' => 400, 'description' => '指定的RegionIds参数不合法。'],
+ ['code' => 'IllegalParam.RegionNo', 'message' => 'The specified parameter RegionNo(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数RegionNo(%s)不合法。'],
+ ['code' => 'IllegalParam.RelationshipType', 'message' => 'The specified param of RelationshipType (%s) is invalid.', 'http_code' => 400, 'description' => '指定的RelationshipType(%s)不合法。'],
+ ['code' => 'IllegalParam.ReportId', 'message' => 'The specified reportId (%s) may be not exist.', 'http_code' => 400, 'description' => '参数reportId不存在'],
+ ['code' => 'IllegalParam.ResourceId', 'message' => 'The specified resourceId (%s) may be not exist.', 'http_code' => 400, 'description' => '指定的实例(%s)可能不存在,请检查是否拼写错误。'],
+ ['code' => 'IllegalParam.ResourcePoolName', 'message' => 'The parameter ResourcePoolName is invalid.', 'http_code' => 400, 'description' => '参数ResourcePoolName非法'],
+ ['code' => 'IllegalParam.ResourceType', 'message' => 'The specified resourceType (%s) is invalid.', 'http_code' => 400, 'description' => '指定的ResourceType变量值(%s)不存在。'],
+ ['code' => 'IllegalParam.ResourceType', 'message' => 'The specified resourceType (%s) is not supported.', 'http_code' => 400, 'description' => '指定的资源类型不支持。'],
+ ['code' => 'IllegalParam.ResourceType', 'message' => 'The specified argument ResourceType(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数ResourceType(%s)不合法。'],
+ ['code' => 'IllegalParam.ResourceType', 'message' => 'The specified ResourceType(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数ResourceType不合法。'],
+ ['code' => 'IllegalParam.ResourceType', 'message' => 'The specified parameter ResourceType is illegal.', 'http_code' => 400, 'description' => '指定的参数ResourceType不合法。'],
+ ['code' => 'IllegalParam.Retentions', 'message' => 'The specified Retentions(%s) argument is illegal.', 'http_code' => 400, 'description' => '指定的Retentions(%s)参数不合法。'],
+ ['code' => 'IllegalParam.RiskLevel', 'message' => 'The specified argument RiskLevel(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数RiskLevel(%s)不合法。'],
+ ['code' => 'IllegalParam.RiskType', 'message' => 'The specified riskType (%s) is not supported.', 'http_code' => 400, 'description' => '参数riskType不合法'],
+ ['code' => 'IllegalParam.ServiceOffline', 'message' => 'The service has been taken offline.', 'http_code' => 400, 'description' => '该服务已下线。'],
+ ['code' => 'IllegalParam.Sort', 'message' => 'The specified Sort(%s) is invalid.', 'http_code' => 400, 'description' => '排序字段必须为(\'desc\',\'asc\')其中之一'],
+ ['code' => 'IllegalParam.SourceAndTargetInternetIp', 'message' => 'Both source ID and target ID are IP addresses, but are not Internet IP addresses. Reachability Analyzer does not support the scenario.', 'http_code' => 400, 'description' => '源与目的都是IP,但都不是阿里云公网IP,路径分析不支持这种场景。'],
+ ['code' => 'IllegalParam.SourceEqualTarget', 'message' => 'The specified source and destination are identical, which is not supported for analysis.', 'http_code' => 400, 'description' => '指定的源和目的相同,不支持分析。'],
+ ['code' => 'IllegalParam.SourceId', 'message' => 'The specified SourceId(%s) may be not exist.', 'http_code' => 400, 'description' => '指定的实例(%s)可能不存在,请检查是否拼写错误。'],
+ ['code' => 'IllegalParam.SourceIp', 'message' => 'Please enter a valid source IP.', 'http_code' => 400, 'description' => '请输入合法的源IP'],
+ ['code' => 'IllegalParam.SourceIpAddress', 'message' => 'The specified SourceIpAddress(%s) is invalid.', 'http_code' => 400, 'description' => '指定的SourceIpAddress(%s)参数不合法。'],
+ ['code' => 'IllegalParam.SourceNotBound', 'message' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.', 'http_code' => 400, 'description' => '弹性公网IP(%s)未绑定资源,暂不支持分析。'],
+ ['code' => 'IllegalParam.SourcePort', 'message' => 'The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536].', 'http_code' => 400, 'description' => 'SourcePort参数不合法,必须介于0到65536(含)之间。'],
+ ['code' => 'IllegalParam.SourcePort', 'message' => 'The specified SourcePort(%s) is invalid.', 'http_code' => 400, 'description' => '指定的SourcePort(%s)参数不合法。'],
+ ['code' => 'IllegalParam.SourceRegions', 'message' => 'SourceRegions Can be wrong.', 'http_code' => 400, 'description' => 'Region 参数有误。请确认输入的 Region 数量是否有误(> 1),或输入了错误的 RegionId'],
+ ['code' => 'IllegalParam.SourceSubnet', 'message' => 'The request source network segment parameter (%s) is invalid.', 'http_code' => 400, 'description' => '该请求源网段参数(%s)不合法。'],
+ ['code' => 'IllegalParam.SourceType', 'message' => 'The specified source type (%s) is invalid.', 'http_code' => 400, 'description' => '指定的源类型(%s)无效。'],
+ ['code' => 'IllegalParam.SourceZones', 'message' => 'The param of SourceZones is illegal.', 'http_code' => 400, 'description' => '输入的源可用区不合法,可能是与 RegionId 不匹配'],
+ ['code' => 'IllegalParam.Status', 'message' => 'The specified parameter Status(%s) is invalid, can only be Active or InActive.', 'http_code' => 400, 'description' => '指定的参数Status(%s)不合法,只能是Active或者InActive。'],
+ ['code' => 'IllegalParam.Status', 'message' => 'The specified Status(%s) parameter is illegal.', 'http_code' => 400, 'description' => '指定的Status(%s)参数不合法。'],
+ ['code' => 'IllegalParam.StatusNotInactive', 'message' => 'The specified TrafficAnalyzerId resource state (%s) is not stopped. Please stop and try again.', 'http_code' => 400, 'description' => '指定的TrafficAnalyzerId资源状态(%s)不是停止状态,请先停止后再重试。'],
+ ['code' => 'IllegalParam.StepMinutes', 'message' => 'The specified sampling interval (%s) is invalid.', 'http_code' => 400, 'description' => '指定的采样间隔(%s)不合法。'],
+ ['code' => 'IllegalParam.StepMinutes', 'message' => 'The specified argument StepMinutes(%s) is illegal.', 'http_code' => 400, 'description' => '指定的参数StepMinutes(%s)不合法。'],
+ ['code' => 'IllegalParam.StepMinutes', 'message' => 'The specified StepMinutes parameter value is illegal, only% s minutes of data precision is supported.', 'http_code' => 400, 'description' => '指定的StepMinutes参数值不合法,仅支持%s分钟的数据精度。'],
+ ['code' => 'IllegalParam.StepMinutes', 'message' => 'The specified StepMinutes parameter value is illegal, only %s minutes of data precision is supported.', 'http_code' => 400, 'description' => '指定的StepMinutes参数值不合法,仅支持%s分钟的数据精度。'],
+ ['code' => 'IllegalParam.StepMinutesAndTime', 'message' => 'In the current query time range, data precision of only% s minutes is supported to ensure performance.', 'http_code' => 400, 'description' => '当前查询时间范围下,为保证性能,仅支持%s分钟的数据精度。'],
+ ['code' => 'IllegalParam.StepMinutesAndTime', 'message' => 'In the current query time range, data precision of only %s minutes is supported to ensure performance.', 'http_code' => 400, 'description' => '当前查询时间范围下,为保证性能,仅支持%s分钟的数据精度。'],
+ ['code' => 'IllegalParam.SystemParam', 'message' => 'A system parameter was not specified. This problem occurs mostly when called through the SDK.', 'http_code' => 400, 'description' => '某个系统参数未指定。此问题多发生在通过SDK调用时。'],
+ ['code' => 'IllegalParam.TargetId', 'message' => 'The specified TargetId(%s) may be not exist.', 'http_code' => 400, 'description' => '指定的实例(%s)可能不存在,请检查是否拼写错误。'],
+ ['code' => 'IllegalParam.TargetIp', 'message' => 'The specified target ip (%s) is invalid.', 'http_code' => 400, 'description' => '指定的目的IP(%s)格式不正确。'],
+ ['code' => 'IllegalParam.TargetNotBound', 'message' => 'Elastic public network IP(%s) is not bound to resources, and analysis is not supported for the time being.', 'http_code' => 400, 'description' => '弹性公网IP(%s)未绑定资源,暂不支持分析。'],
+ ['code' => 'IllegalParam.TargetPort', 'message' => 'The specified TargetPort(%s) value is invalid. The value must be within the range of (0,65536].', 'http_code' => 400, 'description' => 'TargetPort参数不合法,必须介于0到65536(含)之间。'],
+ ['code' => 'IllegalParam.TargetType', 'message' => 'The specified target type (%s) is invalid.', 'http_code' => 400, 'description' => '指定的目的类型(%s)无效。'],
+ ['code' => 'IllegalParam.TaskId', 'message' => 'The specified taskId (%s) may be not exist.', 'http_code' => 400, 'description' => '参数taskId不存在'],
+ ['code' => 'IllegalParam.TaskId', 'message' => 'The specified TaskId(%s) parameter cannot be empty.', 'http_code' => 400, 'description' => '指定的TaskId(%s)参数不能为空。'],
+ ['code' => 'IllegalParam.TaskStatus', 'message' => 'The specified taskStatus (%s) is not supported.', 'http_code' => 400, 'description' => '参数taskStatus不是支持的巡检任务状态'],
+ ['code' => 'IllegalParam.ThisRegion', 'message' => 'The specified parameter thisRegion(%s) is illegal.', 'http_code' => 400, 'description' => 'ThisRegion不合法'],
+ ['code' => 'IllegalParam.TopN', 'message' => 'The TopN(%s) should not greater than 100.', 'http_code' => 400, 'description' => '最大仅支持Top 100,实际传入为(%s)。'],
+ ['code' => 'IllegalParam.TrafficAnalyzerId', 'message' => 'The specified TrafficAnalyzerId(%s) argument is illegal.', 'http_code' => 400, 'description' => '指定的TrafficAnalyzerId(%s)参数不合法。'],
+ ['code' => 'IllegalParam.TriggerTime', 'message' => 'The specified triggerTime (%s) is not supported.', 'http_code' => 400, 'description' => '参数triggerTime不合法'],
+ ['code' => 'IllegalParam.TupleDimension', 'message' => 'The specified TupleDimension(%s) argument is illegal.', 'http_code' => 400, 'description' => '指定的TupleDimension(%s)参数不合法。'],
+ ['code' => 'IllegalParam.TypeAndIdMismatch', 'message' => 'The specified instanceId (%s) and type do not match.', 'http_code' => 400, 'description' => '指定的实例 (%s) 和实例类型不匹配。'],
+ ['code' => 'IllegalParam.UnsupportedRegion', 'message' => 'The specified regionId(%s) is not supported.', 'http_code' => 400, 'description' => '当前指定的地域不支持。'],
+ ['code' => 'IllegalParam.UnsupportedResourceType', 'message' => 'The specified parameter ResourceType(%s) is invalid, with a resource type that is not currently supported.', 'http_code' => 400, 'description' => '指定的参数ResourceType(%s)不合法,有当前不支持的资源类型。'],
+ ['code' => 'IllegalParam.UserNotActivated', 'message' => 'User (%s) did not provision service.', 'http_code' => 400, 'description' => '用户(%s)未开通服务。'],
+ ['code' => 'IllegalParam.UserOwesFees', 'message' => 'User (%s) is overdue.', 'http_code' => 400, 'description' => '用户(%s)已欠费.'],
+ ['code' => 'IllegalParam.VpnType', 'message' => '%s, and this type of instance is currently not supported.', 'http_code' => 400, 'description' => '%s,此类实例目前尚不支持。'],
+ ['code' => 'IllegalParam.ZoneId', 'message' => 'The specified available zone (%s) is invalid.', 'http_code' => 400, 'description' => '指定的可用区(%s)不合法。'],
+ ['code' => 'IllegalParameter.StorageConfiguration', 'message' => 'The specified StorageConfiguration parameter is invalid. It is expected to be in JSON format with the specified project and logstore.', 'http_code' => 400, 'description' => '指定的StorageConfiguration参数不合法,期望为json格式,其中指定了project和logstore。'],
+ ['code' => 'IllegalParamFormat.ItemCodes', 'message' => 'The param format of %s is illegal.', 'http_code' => 400, 'description' => '参数 %s 格式不对'],
+ ['code' => 'IllegalParamFormat.MaxBytes', 'message' => 'The format of the specified parameter MaxBytes(%s) is not legal.', 'http_code' => 400, 'description' => '指定的参数MaxBytes(%s)格式不合法。'],
+ ['code' => 'IllegalParamFormat.MaxPackages', 'message' => 'The format of the specified parameter MaxPackages(%s) is not legal.', 'http_code' => 400, 'description' => '指定的参数MaxPackages(%s)格式不合法。'],
+ ['code' => 'IllegalParamFormat.MaxRoundTripTime', 'message' => 'The format of the specified parameter MaxRoundTripTime(%s) is not legal.', 'http_code' => 400, 'description' => '指定的参数MaxRoundTripTime(%s)格式不合法。'],
+ ['code' => 'IllegalParamFormat.MinBytes', 'message' => 'The format of the specified parameter MinBytes(%s) is not legal.', 'http_code' => 400, 'description' => '指定的参数MinBytes(%s)格式不合法。'],
+ ['code' => 'IllegalParamFormat.MinPackages', 'message' => 'The format of the specified parameter MinPackages(%s) is not legal.', 'http_code' => 400, 'description' => '指定的参数MinPackages(%s)格式不合法。'."\n"],
+ ['code' => 'IllegalParamFormat.MinRoundTripTime', 'message' => 'The format of the specified parameter MinRoundTripTime(%s) is not legal.', 'http_code' => 400, 'description' => '指定的参数MinRoundTripTime(%s)格式不合法。'."\n"],
+ ['code' => 'IllegalParamSize.DestinationRegions', 'message' => 'The param size of DestinationRegions is %s, what is illegal.', 'http_code' => 400, 'description' => 'DestinationRegions 入参数量(%s)不合法,请确认是否为空或超出数量限制'],
+ ['code' => 'IllegalParamSize.SourceRegions', 'message' => 'The param size of SourceRegions is %s, what is illegal.', 'http_code' => 400, 'description' => 'SourceRegions 入参数量(%s)不合法,请确认是否为空或超出数量限制'],
+ ['code' => 'IncorrectBusinessStatus.AliyunServiceRoleForNis', 'message' => 'The operation is not allowed before creating ServiceLinkedRole:%s.', 'http_code' => 400, 'description' => '在做此操作前,请先手动创建服务关联角色:%s。'],
+ ['code' => 'IncorrectStatus.flowlog', 'message' => 'This action is not allowed in the current flow log status.', 'http_code' => 400, 'description' => '当前状态不允许此操作,请稍后重试。'],
+ ['code' => 'IncorrectStatus.InspectionReportNotFinish', 'message' => 'The specified task report InspectionReportId(%s) has not been completed.', 'http_code' => 400, 'description' => '指定的任务报告InspectionReportId(%s)还没有完成。'],
+ ['code' => 'IncorrectStatus.InspectionTaskIsRunning', 'message' => 'The specified task InspectionTaskId(%s) is in progress and cannot be closed.', 'http_code' => 400, 'description' => '指定的任务InspectionTaskId(%s)正在执行中不能关闭。'],
+ ['code' => 'IncorrectStatus.InspectionTaskNotActive', 'message' => 'The specified task InspectionTaskId(%s) is not active and cannot be executed.', 'http_code' => 400, 'description' => '指定的任务InspectionTaskId(%s)不是开启状态不支持执行'],
+ ['code' => 'IncorrectStatus.InspectionTaskNotInactive', 'message' => 'The specified task InspectionTaskId(%s) is not closed and cannot be deleted.', 'http_code' => 400, 'description' => '指定的任务InspectionTaskId(%s)不是关闭状态,不支持删除。'],
+ ['code' => 'IncorrectStatus.InspectionTaskNotInactive', 'message' => 'The specified task InspectionTaskId(%s) is not closed and cannot be opened.', 'http_code' => 400, 'description' => '指定的任务InspectionTaskId(%s)不是关闭状态不支持开启'],
+ ['code' => 'IncorrectStatus.NetworkPath', 'message' => 'The last analysis status of %s is %s. Please try again later.', 'http_code' => 400, 'description' => '%s有分析任务未完成,请等待其完成后再试!'],
+ ['code' => 'IncorrectStatus.ResourceId', 'message' => 'The %s has %s diagnosis task. Please try again later.', 'http_code' => 400, 'description' => '实例%s有未完成的诊断任务,请稍后重试。'],
+ ['code' => 'IncorrectStatus.ResourceIdJustFinish', 'message' => 'Wait for at least one minute after the diagnosis (%s) of the resource ID is finished, and then try again.', 'http_code' => 400, 'description' => '该实例诊断(%s)刚结束未满1分钟,请稍后重试。'],
+ ['code' => 'IncorrectStatus.TaskId', 'message' => 'The current state of the specified TaskId(%s) does not support modification. Please try again later.', 'http_code' => 400, 'description' => '指定的TaskId(%s)当前状态不支持修改,请稍后重试。'],
+ ['code' => 'IncorrectStatus.TrafficAnalyzerId', 'message' => 'TrafficAnalyzerId (%s) is not in a valid status.', 'http_code' => 400, 'description' => 'TrafficAnalyzerId(%s)非有效状态.'],
+ ['code' => 'Insufficient.Balance', 'message' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'http_code' => 400, 'description' => '您的账户可用额度小于0,请先充值后再尝试购买。'],
+ ['code' => 'InvalidInstanceIds.NotFound', 'message' => 'The instanceIds are not found', 'http_code' => 400, 'description' => '指定的InstanceIds不合法。'],
+ ['code' => 'InvalidInstanceType.NotFound', 'message' => 'The instance type is not found', 'http_code' => 400, 'description' => '指定的InstanceType不合法。'],
+ ['code' => 'InvalidParameter.TagKey', 'message' => 'The Tag.N.Key parameter is invalid.', 'http_code' => 400, 'description' => 'Tag的Key参数无效'],
+ ['code' => 'InvalidParameter.TagValue', 'message' => 'The Tag.N.Value parameter is invalid.', 'http_code' => 400, 'description' => 'Tag的Value参数无效。'],
+ ['code' => 'InvalidParameter.TrAttachment', 'message' => 'Can not find related resources from input tr-attachment id.', 'http_code' => 400, 'description' => '无法通过您输入的跨地域连接实例找到关联资源'],
+ ['code' => 'InvalidResourceType.NotFound', 'message' => 'The resource type is not found', 'http_code' => 400, 'description' => '指定的ResourceType不合法。'],
+ ['code' => 'InvalidTagKey', 'message' => 'The tag keys are not valid.', 'http_code' => 400, 'description' => '指定的TagKey不合法。'],
+ ['code' => 'InvalidTagValue', 'message' => 'The tag values are not valid.', 'http_code' => 400, 'description' => '指定的TagValue不合法。'],
+ ['code' => 'ItemCode.NotFound', 'message' => 'The specified itemCode of %s is not found.', 'http_code' => 404, 'description' => '参数 %s 不存在'],
+ ['code' => 'ItemCode.NotFound', 'message' => 'The specified ItemCode is not found.', 'http_code' => 404, 'description' => '参数ItemCode不存在'],
+ ['code' => 'Mismatch.BeginTime', 'message' => 'Missing parameter BeginTime', 'http_code' => 400, 'description' => '缺失参数BeginTime'],
+ ['code' => 'Mismatch.BeginTimeAndEndTime', 'message' => 'The specified begin time must be earlier than the end time.', 'http_code' => 400, 'description' => '指定的开始时间在结束时间之后。'],
+ ['code' => 'Mismatch.SourceIdAndTargetId', 'message' => 'Reachability Analyzer does not support the scenario in which source and target Internet IP addresses and ECS instance ID (%s and %s) are bound.', 'http_code' => 400, 'description' => '路径分析不支持源与目的的公网IP和ECS实例ID(%s和%s)具有绑定关系。'],
+ ['code' => 'MismatchParameter.TrAttachmentAndRegion', 'message' => 'The tr attachment id can not match the regionId.', 'http_code' => 400, 'description' => '输入的跨域连接实例与 regionId 不匹配。'],
+ ['code' => 'MissingParam', 'message' => 'The parameter %s is empty.', 'http_code' => 400, 'description' => '参数%s为空。'],
+ ['code' => 'MissingParam.AnalysisLogs', 'message' => 'The specified AnalysisLogs(%s) parameter cannot be empty.', 'http_code' => 400, 'description' => 'AnalysisLogs不能为空'],
+ ['code' => 'MissingParam.AnalysisSettings', 'message' => 'The AnalysisSettings(%s) parameter cannot be empty.', 'http_code' => 400, 'description' => '该AnalysisSettings(%s)参数不能为空。'],
+ ['code' => 'MissingParam.BeginTime', 'message' => 'The parameter BeginTime(%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数BeginTime(%s)不能为空。'],
+ ['code' => 'MissingParam.Dimensions.Direction', 'message' => 'The parameter Dimensions.Direction(%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数Dimensions.Direction(%s)不能为空.'],
+ ['code' => 'MissingParam.Dimensions.RegionId', 'message' => 'The parameter Dimensions.RegionId(%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数Dimensions.RegionId(%s)不能为空.'],
+ ['code' => 'MissingParam.Dimensions.TrafficAnalyzerId', 'message' => 'The parameter Dimensions.TrafficAnalyzerId(%) cannot be empty.', 'http_code' => 400, 'description' => '该参数Dimensions.TrafficAnalyzerId(%)不能为空.'],
+ ['code' => 'MissingParam.Dimensions.TrafficScenario', 'message' => 'The Dimensions.TrafficScenario(%s) parameter cannot be empty.', 'http_code' => 400, 'description' => '该Dimensions.TrafficScenario(%s)参数不能为空.'],
+ ['code' => 'MissingParam.Dimensions.TupleDimension', 'message' => 'The parameter Dimensions.TupleDimension(%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数Dimensions.TupleDimension(%s)不可为空.'],
+ ['code' => 'MissingParam.EnableAndIntervalEmpty', 'message' => 'The specified parameter LogAggregationInterval and EnableNISTrafficAnalyzer cannot be both empty.', 'http_code' => 400, 'description' => '指定的参数LogAggregationInterval和EnableNISTrafficAnalyzer不能都为空。'],
+ ['code' => 'MissingParam.EndTime', 'message' => 'The parameter EndTime(%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数EndTime(%s)不可为空.'],
+ ['code' => 'MissingParam.IdleCountModelList', 'message' => 'You must specify IdleCountModelList.', 'http_code' => 404, 'description' => '缺少必填参数IdleCountModelList'],
+ ['code' => 'MissingParam.Interval', 'message' => 'The specified Interval(%s) parameter cannot be empty.', 'http_code' => 400, 'description' => 'Interval不能为空'],
+ ['code' => 'MissingParam.MetricType', 'message' => 'The param of MetricType is missing.', 'http_code' => 400, 'description' => '缺少MetricType参数。'],
+ ['code' => 'MissingParam.Period', 'message' => 'You must specify Period.', 'http_code' => 404, 'description' => '缺少必填参数Period'],
+ ['code' => 'MissingParam.ProductId', 'message' => 'You must specify ProductId.', 'http_code' => 404, 'description' => '缺少必填参数ProductId'],
+ ['code' => 'MissingParam.regionId', 'message' => 'The param of regionId is missing.', 'http_code' => 400, 'description' => '请输入 RegionId'],
+ ['code' => 'MissingParam.RegionId', 'message' => 'The param of regionId is missing.', 'http_code' => 400, 'description' => '请输入 RegionId'."\n"],
+ ['code' => 'MissingParam.Retentions', 'message' => 'The Retentions(%s) parameter cannot be empty.', 'http_code' => 400, 'description' => '该Retentions(%s)参数不能为空.'],
+ ['code' => 'MissingParam.TrafficPath', 'message' => 'The specified TrafficPath parameter cannot be empty.', 'http_code' => 400, 'description' => '指定TrafficPath参数不能为空。'],
+ ['code' => 'MissingParam.TrafficType', 'message' => 'The specified TrafficType parameter cannot be empty.', 'http_code' => 400, 'description' => '指定TrafficType参数不能为空。'],
+ ['code' => 'MissingParam.TupleDimension', 'message' => 'The specified TupleDimension parameter cannot be empty.', 'http_code' => 400, 'description' => '指定TupleDimension参数不能为空。'],
+ ['code' => 'MissingParameter.ResourceIdsOrTags', 'message' => 'ResourceId and Tag cannot be empty at the same time.', 'http_code' => 400, 'description' => 'ResourceId和Tag不能同时为空。'],
+ ['code' => 'MissingParameter.TagKey', 'message' => 'You must specify Tag.N.Key.', 'http_code' => 400, 'description' => '必须指定Tag的Key。'],
+ ['code' => 'MissingParameter.TagValue', 'message' => 'You must specify Tag.N.Value.', 'http_code' => 400, 'description' => '必须指定Tag的Value。'],
+ ['code' => 'NoPermission.Account', 'message' => 'The accountId is not a member of the user\'s account.', 'http_code' => 403, 'description' => '跨账号不是用户的成员账号'],
+ ['code' => 'NoPermission.Uid', 'message' => 'The uid is not DA or MA.', 'http_code' => 403, 'description' => '用户不是管理员或者委派管理员'],
+ ['code' => 'NotSupported.Instance', 'message' => '%s, and this type of instance is currently not supported.', 'http_code' => 400, 'description' => '%s,此类实例目前尚不支持。'],
+ ['code' => 'NumberExceed.Tags', 'message' => 'The maximum number of Tags is exceeded.', 'http_code' => 400, 'description' => '超过了标签的最大数目。'],
+ ['code' => 'OperationDenied.NetworkReachableAnalysis', 'message' => 'The operation is not allowed because of invalid parameters.', 'http_code' => 400, 'description' => '请求存在非法参数,当前操作不被允许。'],
+ ['code' => 'OperationDenied.NisTrafficRankingId', 'message' => 'The specified parameter NisTrafficRankingId(%s) user does not have permission to operate.', 'http_code' => 403, 'description' => '指定的参数NisTrafficRankingId(%s)用户没有操作权限。'],
+ ['code' => 'OperationDenied.NtaStop', 'message' => 'Refuse to stop the operation. There are instances in the traffic analyzer that enable flow logs.', 'http_code' => 400, 'description' => '拒绝停止操作,流量分析器中存在开启流日志的实例。'],
+ ['code' => 'OperationDenied.TaskId', 'message' => 'The specified parameter TaskId(%s) user does not have permission to operate.', 'http_code' => 403, 'description' => '指定的参数TaskId(%s)用户没有操作权限。'."\n"],
+ ['code' => 'OperationDenied.TaskNotComplete', 'message' => 'Task(%s) not completed.', 'http_code' => 400, 'description' => '任务未完成'],
+ ['code' => 'OperationDenied.ZonesConflict', 'message' => 'The specified available zones do not belong to the same region.', 'http_code' => 400, 'description' => '指定的可用区不属于同一个地域。'],
+ ['code' => 'OperationFailed.CloseNonPublicFlowAnalysis', 'message' => 'The operation(%s) is failed.', 'http_code' => 500, 'description' => '%s操作失败,请稍后重试、或提交工单。'],
+ ['code' => 'OperationFailed.DataToMuch', 'message' => 'Too many simultaneous times or memory limitations.', 'http_code' => 400, 'description' => '同时进行的次数过多或内存限制.'],
+ ['code' => 'OperationFailed.DataTooMuch', 'message' => 'Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.', 'http_code' => 400, 'description' => '指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。'],
+ ['code' => 'OperationFailed.DbConcurrentTooHigh', 'message' => 'The operation failed due to too many concurrent queries in DB. Please try again.', 'http_code' => 400, 'description' => 'DB并发查询过多,导致操作失败,请重试。'],
+ ['code' => 'OperationFailed.DbConcurrentTooHigh', 'message' => 'The operation failed due to too many concurrent queries. Please try again later.', 'http_code' => 400, 'description' => '当前用户过多,导致操作失败,请稍后再重试。'],
+ ['code' => 'OperationFailed.ExceedPurchaseLimit', 'message' => 'You have reached the limit of purchase quantity.', 'http_code' => 400, 'description' => '您当前购买数量超过还可购买的数量余量,请重新选择数量!'],
+ ['code' => 'OperationFailed.ExceedPurchaseLimit', 'message' => 'Your current purchase quantity exceeds the available quantity margin, please re-select the quantity.', 'http_code' => 400, 'description' => '您当前购买数量超过还可购买的数量余量,请重新选择数量.'],
+ ['code' => 'OperationFailed.InternalError', 'message' => 'An internal error occurred.', 'http_code' => 400, 'description' => '内部错误'],
+ ['code' => 'OperationFailed.InvokeApi', 'message' => 'Failed to invoke the API operation.', 'http_code' => 400, 'description' => '调用API失败'],
+ ['code' => 'OperationFailed.NoPermission', 'message' => 'You are not authorized to call the API operation.', 'http_code' => 400, 'description' => '没有接口调用权限'],
+ ['code' => 'OperationFailed.NotSupport', 'message' => 'Do not support you to buy this product.', 'http_code' => 400, 'description' => '暂不支持您购买本商品.'],
+ ['code' => 'OperationFailed.OpenNonPublicFlowAnalysis', 'message' => 'The operation(%s) is failed.', 'http_code' => 500, 'description' => '%s操作失败,请稍后重试、或者提交工单。'],
+ ['code' => 'OperationFailed.ProductInfo', 'message' => 'Failed to obtain product information.', 'http_code' => 400, 'description' => '获取商品信息失败.'],
+ ['code' => 'OperationFailed.QueryIpPoolFailed', 'message' => 'Failed to query IP resource pool.', 'http_code' => 400, 'description' => '查询IP资源库失败'],
+ ['code' => 'OperationFailed.ServiceOverloaded', 'message' => 'The number of relative resources has exceeded the service limit.', 'http_code' => 503, 'description' => '指定条件下查询的数据过多,请减小资源关系查询层数(Depth)、指定更精确查询关系后再重试。'],
+ ['code' => 'OperationFailed.UnableToPurchase', 'message' => 'The product code does not have the product tag on the cloud of the group and cannot be purchased (it is recommended to purchase pay-as-you-go products in the group internal scenario to avoid the release of the package year and the package month).', 'http_code' => 400, 'description' => '商品code无集团上云商品标签,无法购买(集团内部场景建议购买按量付费商品,避免包年包月过期释放)'],
+ ['code' => 'OptInRequired.FlowLog', 'message' => 'You are not authorized to use the requested service of flowLog.', 'http_code' => 400, 'description' => '没有使用VPC流日志的权限。有可能VPC流日志未开通。'],
+ ['code' => 'OptInRequired.FlowLogService', 'message' => 'The flow log service has not been activated. Please activate it and try again.', 'http_code' => 400, 'description' => '流日志服务未开通,请开通后再重试。'],
+ ['code' => 'ParameterCenInstanceId', 'message' => 'The specified CEN instance id does not exist.', 'http_code' => 404, 'description' => '指定的CEN实例ID不存在。'],
+ ['code' => 'QuotaExceeded.AnalysisLogs', 'message' => 'The AnalysisLogs cannot exceed 100.', 'http_code' => 400, 'description' => '该AnalysisLogs不能超过100个'],
+ ['code' => 'QuotaExceeded.FlowLogCountQuota', 'message' => 'The FlowLog quantity has reached the quota limit (current quantity:%s). To increase the quota, go to the quota center to apply (https://quotas.console.aliyun.com/products/vpc/quotas).', 'http_code' => 400, 'description' => 'FlowLog数量已达到配额上限(当前数量:%s),如需提升配额,请前往配额中心申请(https://quotas.console.aliyun.com/products/vpc/quotas?query=flowlog)。'],
+ ['code' => 'QuotaExceeded.MaxNraCount', 'message' => 'The maximum number of reachability analysis task is exceeded.', 'http_code' => 400, 'description' => '保存的路径分析任务数量已超过规格。'],
+ ['code' => 'QuotaExceeded.NetworkPath', 'message' => 'The quota of %s is exceeded, usage %s/%s.', 'http_code' => 400, 'description' => '网络路径数量(%s)超过阈值,使用率:%s/%s。'],
+ ['code' => 'QuotaExceeded.ParallelDiagnosisLimit', 'message' => 'The number of parallel diagnostic tasks exceeds the upper limit.', 'http_code' => 400, 'description' => '并行的诊断任务数量已超过规格。'],
+ ['code' => 'QuotaExceeded.ParallelInspectionLimit', 'message' => 'The quota of %s is exceeded, usage %s, limit %s.', 'http_code' => 400, 'description' => '巡检对象超过配额'],
+ ['code' => 'QuotaExceeded.ParallelNraLimit', 'message' => 'The maximum number of parallel reachability analysis task is exceeded.', 'http_code' => 400, 'description' => '并行的路径分析任务数量已超过规格。'],
+ ['code' => 'Rd.Absent.Error', 'message' => 'Permission denied,current user is not in RD.', 'http_code' => 404, 'description' => '正使用多账号模式访问,但当前账号未开通资源目录,访问被拒绝。请使用资源目录管理员访问或退出多账号模式'],
+ ['code' => 'ResourceAlreadyAssociated.NatGatewayId', 'message' => 'The TopN feature has been enabled for the NAT gateway (%s).', 'http_code' => 400, 'description' => '该Nat网关实例(%s)此前已打开TopN功能,无需重复打开。'],
+ ['code' => 'ResourceAlreadyExist.AliUid', 'message' => 'The specified inspection task of %s already exists.', 'http_code' => 400, 'description' => '用户的巡检任务已经存在'],
+ ['code' => 'ResourceAlreadyExist.NetworkPath', 'message' => 'The specified resource of %s already exists.', 'http_code' => 400, 'description' => '指定的网络路径配置%s已存在。'],
+ ['code' => 'ResourceAlreadyExist.SourceVpc', 'message' => 'This feature has already been enabled for the VPC (%s).', 'http_code' => 400, 'description' => '指定的VPC实例(%s)已经开通此功能,不能重复开通。'],
+ ['code' => 'ResourceNotFound.AnalysisTaskIds', 'message' => 'The instance resource (%s) does not exist.', 'http_code' => 404, 'description' => '该实例资源(%s)不存在.'],
+ ['code' => 'ResourceNotFound.CommodityCode', 'message' => 'The specified Commodity ID (%s) is not be activated.', 'http_code' => 400, 'description' => '指定的商品(%s)未被开通,无法关闭。'],
+ ['code' => 'ResourceNotFound.CommodityCode', 'message' => '%s can not be deactivated because it has not been activated.', 'http_code' => 404, 'description' => '无法关闭未开通的服务%s。'],
+ ['code' => 'ResourceNotFound.DataSourceId', 'message' => 'The resource (%s) information does not exist.', 'http_code' => 404, 'description' => '该资源(%s)信息不存在。'],
+ ['code' => 'ResourceNotFound.DiagnosisReportId', 'message' => 'The specified resource of %s is not found.', 'http_code' => 404, 'description' => '指定的诊断报告ID %s不存在,可能已删除或者指定的ID错误。'],
+ ['code' => 'ResourceNotFound.DiagnosisReportIds', 'message' => 'The resource (%s) does not exist.', 'http_code' => 404, 'description' => '该资源(%s)不存在。'],
+ ['code' => 'ResourceNotFound.DiagnosisTask', 'message' => 'The specified resource of %s is not found.', 'http_code' => 404, 'description' => '指定的诊断任务%s不存在,可能已删除或者拼写错误。'],
+ ['code' => 'ResourceNotFound.Flowlog', 'message' => 'The specified resource does not exist.', 'http_code' => 400, 'description' => '指定的资源不存在。'],
+ ['code' => 'ResourceNotFound.InsightId', 'message' => 'The specified InsightId(%s) parameter does not exist.', 'http_code' => 404, 'description' => '指定的InsightId(%s)参数不存在。'],
+ ['code' => 'ResourceNotFound.InspectionReportId', 'message' => 'The specified InspectionReportId(%s) is not found.', 'http_code' => 404, 'description' => '指定的InspectionReportId(%s)不存在。'],
+ ['code' => 'ResourceNotFound.InspectionResource', 'message' => 'The specified InspectionTaskId(%s) resource does not exist.', 'http_code' => 404, 'description' => '指定的InspectionTaskId(%s)资源不存在.'],
+ ['code' => 'ResourceNotFound.InspectionTaskId', 'message' => 'The specified InspectionTaskId(%s) is not found.', 'http_code' => 404, 'description' => '指定的InspectionTaskId(%s)不存在。'],
+ ['code' => 'ResourceNotFound.InstanceId', 'message' => 'The specified InstanceId(%s) does not exist.', 'http_code' => 404, 'description' => '指定的InstanceId(%s)不存在。'],
+ ['code' => 'ResourceNotFound.InstanceId2', 'message' => 'The parameter InstanceId2(%s) instance resource specified does not exist.', 'http_code' => 404, 'description' => '指定的参数InstanceId2(%s) 实例资源不存在。'],
+ ['code' => 'ResourceNotFound.IpSets', 'message' => 'The specified instance does not exist or does not have any acceleration region.', 'http_code' => 404, 'description' => '指定的实例不存在或者没有加速区域。'],
+ ['code' => 'ResourceNotFound.MappingId', 'message' => 'The resource (%s) does not exist.', 'http_code' => 404, 'description' => '该资源(%s)不存在。'],
+ ['code' => 'ResourceNotFound.NetworkPath', 'message' => 'The specified resource of %s is not found.', 'http_code' => 400, 'description' => '指定的网络路径%s不存在,可能已删除或者指定的ID错误。'],
+ ['code' => 'ResourceNotFound.NetworkPathId', 'message' => 'The instance resource (%s) does not exist.', 'http_code' => 404, 'description' => '该实例资源(%s)不存在。'],
+ ['code' => 'ResourceNotFound.NetworkReachableAnalysis', 'message' => 'The specified resource of %s is not found.', 'http_code' => 404, 'description' => '指定的网络路径分析ID %s不存在,可能已删除或者指定的ID错误。'],
+ ['code' => 'ResourceNotFound.NetworkReachableAnalysisId', 'message' => 'The instance resource (%s) does not exist.', 'http_code' => 404, 'description' => '该资源(%s)不存在。'],
+ ['code' => 'ResourceNotFound.NisTrafficRankingId', 'message' => 'The specified parameter NisTrafficRankingId(%s) does not exist.', 'http_code' => 404, 'description' => '指定的参数NisTrafficRankingId(%s)不存在。'],
+ ['code' => 'ResourceNotFound.RecommendationCode', 'message' => 'The specified parameter RecommendationCode(%s) does not exist.', 'http_code' => 404, 'description' => '指定的参数RecommendationCode(%s) 不存在。'],
+ ['code' => 'ResourceNotFound.ReportId', 'message' => 'The instance resource (%s) does not exist.', 'http_code' => 404, 'description' => '该实例资源(%s)不存在'],
+ ['code' => 'ResourceNotFound.ResourceId', 'message' => 'The instance resource (%s) does not exist.', 'http_code' => 404, 'description' => '该实例(%s)资源不存在.'],
+ ['code' => 'ResourceNotFound.TaskId', 'message' => 'The specified TaskId(%s) parameter does not exist.', 'http_code' => 400, 'description' => '指定的TaskId(%s)参数不存在。'],
+ ['code' => 'ResourceNotFound.TaskId', 'message' => 'The specified parameter TaskId(%s) does not exist.', 'http_code' => 404, 'description' => '指定的参数TaskId(%s)不存在。 '],
+ ['code' => 'ResourceNotFound.Tr.Vpc', 'message' => 'No ENI is available under the VPC covered by this Intra-region traffic analysis.', 'http_code' => 400, 'description' => '此同域流量分析覆盖的VPC下无可用的ENI。'],
+ ['code' => 'ResourceNotFound.TrafficAnalyzerId', 'message' => 'The specified TrafficAnalyzerId(%s) resource does not exist.', 'http_code' => 400, 'description' => '指定的TrafficAnalyzerId(%s)资源不存在。'],
+ ['code' => 'ResourceNotFound.TrafficAnalyzerId', 'message' => 'The specified resource TrafficAnalyzerId(%s) does not exist.', 'http_code' => 404, 'description' => '指定的资源TrafficAnalyzerId(%s)不存在。'],
+ ['code' => 'ResourceNotSupport.Depth', 'message' => 'The specified Depth(%s) is invalid.', 'http_code' => 400, 'description' => '指定的资源关系层级Depth(%s)超出查询限制。'],
+ ['code' => 'ResourceNotSupport.IP', 'message' => 'The specified IP(%s) does not exist.', 'http_code' => 400, 'description' => '指定的IP(%s)不存在。'],
+ ['code' => 'ResourceNotSupport.ResourceType', 'message' => 'The specified ResourceType(%s) is not invalid.', 'http_code' => 400, 'description' => '指定的ResourceType(%s)不支持查询资源关系。'],
+ ['code' => 'Route.Node.Expired', 'message' => 'The node is expired. Refresh the page.', 'http_code' => 400, 'description' => '节点已过期,请刷新页面。'],
+ ['code' => 'SizeExceeds.DestinationRegions', 'message' => 'The length of the specified destination regions exceeds the limit.', 'http_code' => 400, 'description' => '指定的目的地域列表长度超过限制。'],
+ ['code' => 'SizeExceeds.DestinationZones', 'message' => 'The length of the specified destination zones exceeds the limit.', 'http_code' => 400, 'description' => '指定的目的可用区列表长度超过限制。'],
+ ['code' => 'SizeExceeds.DiskCategories', 'message' => 'The length of the specified disk categories exceeds the limit.', 'http_code' => 400, 'description' => '指定的磁盘类型列表长度超过限制。'],
+ ['code' => 'SizeExceeds.MaxResults', 'message' => 'The value of maxResults exceeds the limit.', 'http_code' => 400, 'description' => 'maxResults超过了最大分页大小'],
+ ['code' => 'SizeExceeds.SourceRegions', 'message' => 'The length of the specified source regions exceeds the limit.', 'http_code' => 400, 'description' => '指定的源地域列表长度超过限制。'],
+ ['code' => 'SizeExceeds.SourceZones', 'message' => 'The length of the specified source zones exceeds the limit.', 'http_code' => 400, 'description' => '指定的源可用区列表长度超过限制。'],
+ ['code' => 'SizeExceeds.Zones', 'message' => 'The length of the specified available zones exceeds the limit.', 'http_code' => 400, 'description' => '指定的可用区列表长度超过限制。'],
+ ['code' => 'SystemBusy', 'message' => 'The system is busy. Please try again later.', 'http_code' => 400, 'description' => '系统正忙,请稍后重试。'],
+ ['code' => 'SystemBusy', 'message' => 'The system is busy now. Please try again later.', 'http_code' => 500, 'description' => '当前查询繁忙,请等待片刻后重试'],
+ ['code' => 'UnsupportedFeature.QueryTimeRange', 'message' => 'The specified query time range is too long. You can query data less than %s.', 'http_code' => 400, 'description' => '指定的查询时间范围过长,支持查询%s以内的数据。'."\n"],
+ ['code' => 'IllegalParam.Language', 'message' => 'Unsupported Language(%s) language type.', 'http_code' => 400, 'description' => '暂不支持的Language(%s)语言类型。'],
+ ['code' => 'MissingParam.TaskParameters', 'message' => 'The TaskParameters parameter cannot be empty.', 'http_code' => 400, 'description' => '该TaskParameters参数不可为空。'],
+ ['code' => 'MissingParam.SessionId', 'message' => 'The SessionId parameter cannot be empty.', 'http_code' => 400, 'description' => '该SessionId参数不可为空。'],
+ ['code' => 'IllegalParam.Vote', 'message' => 'Vote(%s) user feedback type not supported.', 'http_code' => 400, 'description' => '暂不支持的Vote(%s)用户反馈类型。'],
+ ['code' => 'MissingParam.TaskType', 'message' => 'The TaskType parameter cannot be empty.', 'http_code' => 400, 'description' => '该TaskType参数不可为空。'],
+ ['code' => 'IllegalParam.MissingTimeRange', 'message' => 'The (StartTime,EndTime) time range must be passed in together.', 'http_code' => 400, 'description' => '该(StartTime,EndTime)时间范围必须一起传入。'],
+ ['code' => 'IllegalParam.TaskType', 'message' => 'Unsupported TaskType(%s) task type.', 'http_code' => 400, 'description' => '暂不支持的TaskType(%s)任务类型。'],
+ ['code' => 'IllegalParam.Order', 'message' => 'Unsupported Order(%s) sort type.', 'http_code' => 400, 'description' => '暂不支持的Order(%s)排序类型。'],
+ ['code' => 'IllegalParam.TaskParametersType', 'message' => 'Unsupported TaskParameters.Type(%s) task parameter type.', 'http_code' => 400, 'description' => '暂不支持的TaskParameters.Type(%s)任务参数类型。'],
+ ['code' => 'Forbidden.CreateTask', 'message' => 'The user has a running task and creation is prohibited.', 'http_code' => 403, 'description' => '用户存在运行中的任务,禁止创建。'],
+ ['code' => 'QuotaExceeded.SessionTask', 'message' => 'The current session has reached the maximum number of submitted tasks (%s).', 'http_code' => 400, 'description' => '当前会话提交的任务数已达最大限制(%s)。'],
+ ['code' => 'MissingParam.Value', 'message' => 'The Value parameter is not nullable.', 'http_code' => 400, 'description' => '该Value参数不可为空。'],
+ ['code' => 'DuplicatedParam.Type', 'message' => 'The Type(%s) parameter is duplicate.', 'http_code' => 400, 'description' => '该Type(%s)参数重复。'],
+ ['code' => 'IncorrectStatus.NtaInvalidOperationState', 'message' => 'The traffic analyzer is not started. Please start before binding the data source.', 'http_code' => 400, 'description' => '流量分析器未启动,请先启动后再绑定数据源。'],
+ ['code' => 'IllegalParam.NtaNotOneTuple', 'message' => 'When binding a shared bandwidth, the traffic analyzer has at least one tuple for high-precision statistics and long-period statistics.', 'http_code' => 400, 'description' => '绑定共享带宽时,流量分析器高精度统计和长周期统计至少有一个一元组。'],
+ ['code' => 'IncorrectStatus.NtaStatusInvalid', 'message' => 'Traffic Analyzer %s is currently at %s and does not support binding data sources.', 'http_code' => 400, 'description' => '流量分析器 %s 当前处于 %s , 暂不支持绑定数据源。'],
+ ['code' => 'IllegalParam.TrDataSourceVersion', 'message' => 'The Forwarding Router (TR) flow log version is too low. Traffic analysis is not supported.', 'http_code' => 400, 'description' => '转发路由器(TR)流日志版本过低,暂不支持开启流量分析。'],
+ ['code' => 'IllegalParam.Status', 'message' => 'Unsupported Status(%s) type.', 'http_code' => 400, 'description' => '暂不支持的Status(%s)类型。'],
+ ['code' => 'IllegalParam.MonitorScopeType', 'message' => 'Unsupported MonitorScopeType(%s) type.', 'http_code' => 400, 'description' => '暂不支持的MonitorScopeType(%s)类型。'],
+ ['code' => 'MissingParam.MetricSubscriptionId', 'message' => 'The MetricSubscriptionId parameter cannot be empty.', 'http_code' => 400, 'description' => '该MetricSubscriptionId参数不可为空。'],
+ ['code' => 'MissingParam.FromAz', 'message' => 'The FromAz parameter is not nullable.', 'http_code' => 400, 'description' => '该FromAz参数不可为空。'],
+ ['code' => 'IllegalParam.NameSpaceMetricType', 'message' => 'Unsupported NameSpaceMetricType(%s) type.', 'http_code' => 400, 'description' => '暂不支持的NameSpaceMetricType(%s)类型。'],
+ ['code' => 'MissingParam.Type', 'message' => 'The Type parameter cannot be null or empty.', 'http_code' => 400, 'description' => '该Type参数不可为空。'],
+ ['code' => 'IllegalParamLength.Description', 'message' => 'The Description parameter exceeds the maximum length (%s) limit.', 'http_code' => 400, 'description' => '该Description参数超过最大长度(%s)限制。'],
+ ['code' => 'OperationDenied.AliUid', 'message' => 'The current account (%s) does not have permission to operate on this subscription object (%s).', 'http_code' => 403, 'description' => '当前账户(%s)对该订阅对象(%s)无操作权限。'],
+ ['code' => 'IllegalParam.Order', 'message' => 'Unsupported Order(%s) type.', 'http_code' => 400, 'description' => '暂不支持的Order(%s)类型。'],
+ ['code' => 'MissingParam.MonitorScope', 'message' => 'The MonitorScope parameter cannot be empty.', 'http_code' => 400, 'description' => '该MonitorScope参数不可为空。'],
+ ['code' => 'ResourceNotFound.MetricSubscriptionIds', 'message' => 'The current resource MetricSubscriptionIds(%s) does not exist.', 'http_code' => 404, 'description' => '当前资源MetricSubscriptionIds(%s)不存在。'],
+ ['code' => 'MissingParam.NameSpace', 'message' => 'The NameSpace parameter cannot be empty.', 'http_code' => 400, 'description' => '该NameSpace参数不可为空。'],
+ ['code' => 'MissingParam.MetricType', 'message' => 'The MetricType parameter cannot be empty.', 'http_code' => 400, 'description' => '该MetricType参数不可为空。'],
+ ['code' => 'MissingParam.ToRegion', 'message' => 'The ToRegion parameter cannot be empty.', 'http_code' => 400, 'description' => '该ToRegion参数不可为空。'],
+ ['code' => 'IllegalParam.Type', 'message' => 'Unsupported Type(%s) type.', 'http_code' => 400, 'description' => '暂不支持的Type(%s)类型。'],
+ ['code' => 'IncorrectStatus.EntityInstanceId', 'message' => 'The current resource EntityInstanceId(%s) state (%s) is not available for this operation.', 'http_code' => 400, 'description' => '当前资源EntityInstanceId(%s)状态(%s)不可执行此操作。'],
+ ['code' => 'IllegalParam.NextToken', 'message' => 'Unsupported NextToken(%s) type.', 'http_code' => 400, 'description' => '暂不支持的NextToken(%s)类型。'],
+ ['code' => 'ResourceNotFound.MetricSubscriptionId', 'message' => 'The current resource MetricSubscriptionId(%s) does not exist.', 'http_code' => 404, 'description' => '当前资源MetricSubscriptionId(%s)不存在。'],
+ ['code' => 'MissingParam.MetricSubscriptionName', 'message' => 'The MetricSubscriptionName parameter cannot be empty.', 'http_code' => 400, 'description' => '该MetricSubscriptionName参数不可为空。'],
+ ['code' => 'MissingParam.Config', 'message' => 'The Config parameter cannot be null or empty.', 'http_code' => 400, 'description' => '该Config参数不可为空。'],
+ ['code' => 'MissingParam.FromRegion', 'message' => 'The FromRegion parameter cannot be empty.', 'http_code' => 400, 'description' => '该FromRegion参数不可为空。'],
+ ['code' => 'MissingParam.ToAz', 'message' => 'The ToAz parameter cannot be null or empty.', 'http_code' => 400, 'description' => '该ToAz参数不可为空。'],
+ ['code' => 'ResourceAlreadyExist.SubscriptionObject', 'message' => 'Duplicate configuration already exists for the subscription object.', 'http_code' => 400, 'description' => '订阅对象已存在重复配置。'],
+ ['code' => 'MissingParam.CbwpId', 'message' => 'The CbwpId filtered during the query cannot be empty.', 'http_code' => 400, 'description' => '查询时过滤的CbwpId不可为空。'],
+ ['code' => 'IllegalParam.NtaNotOneTuple', 'message' => 'The traffic analyzer does not have a unary configured and cannot bind to shared bandwidth. Please configure the tuple before binding.', 'http_code' => 400, 'description' => '该流量分析器未配置一元组,不可绑定共享带宽。请配置一元组后在进行绑定。'],
+ ['code' => 'ResourceNotFound.TrafficAnalyzerIdOneTupleDimension', 'message' => 'The specified traffic analyzer does not have a corresponding one-element group storage configuration.', 'http_code' => 400, 'description' => '指定的流量分析器没有对应的一元组存储配置。'],
+ ['code' => 'IllegalParam.NtaIdBindCbwpNeedOneTuple', 'message' => 'The traffic analyzer cannot cancel the unary group when binding the shared bandwidth data source.', 'http_code' => 400, 'description' => '流量分析器绑定共享带宽数据源时,不可取消一元组。'],
+ ['code' => 'IllegalParam.NtaIdBindTrNotOnlyOneTuple', 'message' => 'When the traffic analyzer binds to the tr data source, you cannot configure only the one-tuple.', 'http_code' => 400, 'description' => '流量分析器绑定tr数据源时,不可只配置一元组。'],
+ ['code' => 'IllegalParam.SmartAlb', 'message' => 'The specified Application Type Load Balancing ALB(%s) is a Smart Edition and is not currently supported for such instances.', 'http_code' => 400, 'description' => '指定的应用型负载均衡ALB(%s)是智能版,此类实例目前尚不支持。'."\n"],
+ ['code' => 'ResourceNotFound.NtaNotStorageBucket', 'message' => 'The data source bound to the traffic analyzer does not have a corresponding storage configuration.', 'http_code' => 404, 'description' => '该流量分析器绑定的数据源无对应的存储配置。'],
+ ['code' => 'InvalidParameter.ResourceType', 'message' => 'The ResourceType parameter (%s) is illegal.', 'http_code' => 400, 'description' => '该参数(%s)不合法。'],
+ ['code' => 'IllegalParam.SDK.EndpointResolvingError', 'message' => 'the domain name called by the sdk is invalid.', 'http_code' => 400, 'description' => 'sdk调用域名不合法。'],
+ ['code' => 'IllegalParam.OppositeVpcId', 'message' => 'The request parameter (%s) is illegal.', 'http_code' => 400, 'description' => '该请求参数(%s)不合法。'],
+ ['code' => 'IllegalParam.TransitRouterId', 'message' => 'The request parameter (%s) is illegal.', 'http_code' => 400, 'description' => '该请求参数(%s)不合法。'],
+ ['code' => 'IllegalParam.VpcId', 'message' => 'The request parameter (%s) is illegal.', 'http_code' => 400, 'description' => '该请求参数(%s)不合法。'],
+ ['code' => 'IllegalParam.InspectionTaskId', 'message' => 'The specified argument InspectionTaskId(%s) is illegal.', 'http_code' => 400, 'description' => '指定参数InspectionTaskId(%s)不合法。'],
+ ['code' => 'ResourceNotFound.NisMetricSubscriptionId', 'message' => 'The current resource NisMetricSubscriptionId(%s) does not exist.', 'http_code' => 400, 'description' => '当前资源NisMetricSubscriptionId(%s)不存在。'],
+ ['code' => 'IllegalParam.MetricType', 'message' => 'Unsupported MetricType(%s) type.', 'http_code' => 400, 'description' => '暂不支持的MetricType(%s)类型。'],
+ ['code' => 'MissingParam.NisMetricSubscriptionId', 'message' => 'The NisMetricSubscriptionId parameter cannot be empty.', 'http_code' => 400, 'description' => '该NisMetricSubscriptionId参数不可为空。'],
+ ['code' => 'IllegalParam.RelatedFieldsKey', 'message' => 'Unsupported RelatedFieldsKey(%s) type.', 'http_code' => 400, 'description' => '暂不支持的RelatedFieldsKey(%s)类型。'],
+ ['code' => 'OptInRequired.Cms', 'message' => 'The user has not yet activated the (Cms) service.', 'http_code' => 400, 'description' => '用户暂未开通(Cms)服务。'],
+ ['code' => 'MissingParam.DeliveryRegion', 'message' => 'The DeliveryRegion parameter cannot be empty.', 'http_code' => 400, 'description' => '该DeliveryRegion参数不可为空。'],
+ ['code' => 'Forbidden'."\0".'.GetCmsService', 'message' => 'The user does not have permission to access the (cms:GetCmsService) service.', 'http_code' => 403, 'description' => '用户无权限访问(cms:GetCmsService)服务。'],
+ ['code' => 'IncorrectStatus.NisMetricSubscriptionId', 'message' => 'The current resource NisMetricSubscriptionId(%s) state (%s) is not available for this operation.', 'http_code' => 400, 'description' => '当前资源NisMetricSubscriptionId(%s)状态(%s)不可执行此操作。'],
+ ['code' => 'IllegalParam.NisMetricFieldName', 'message' => 'Unsupported NisMetricFieldName(%s) type.', 'http_code' => 400, 'description' => '暂不支持的NisMetricFieldName(%s)类型。'],
+ ['code' => 'MissingParam.NisMetricFieldName', 'message' => 'The NisMetricFieldName parameter cannot be empty.', 'http_code' => 400, 'description' => '该NisMetricFieldName参数不可为空。'],
+ ['code' => 'IllegalParam.NameSpace', 'message' => 'Unsupported NameSpace(%s) type.', 'http_code' => 400, 'description' => '暂不支持的NameSpace(%s)类型。'],
+ ['code' => 'IllegalParamLength.NisMetricSubscriptionName', 'message' => 'The NisMetricSubscriptionName parameter exceeds the maximum length (%s) limit.', 'http_code' => 400, 'description' => '该NisMetricSubscriptionName参数超过最大长度(%s)限制。'],
+ ['code' => 'ResourceNotFound.NisMetricSubscriptionIds', 'message' => 'The current resource NisMetricSubscriptionIds(%s) does not exist.', 'http_code' => 400, 'description' => '当前资源NisMetricSubscriptionIds(%s)不存在。'],
+ ['code' => 'QuotaExceeded.DeliveryAliUid', 'message' => 'The maximum quota for user postings has been exceeded with% s/%s.', 'http_code' => 400, 'description' => '已超出用户投递的最大配额,使用量为 %s/%s。'],
+ ['code' => 'QuotaExceeded.DeliveryMonitorScope', 'message' => 'The maximum quota for MonitorScope delivery has been exceeded with% s/%s.', 'http_code' => 400, 'description' => '已超出MonitorScope投递的最大配额,使用量为 %s/%s。'],
+ ['code' => 'MissingParam.NisMetricSubscriptionName', 'message' => 'The NisMetricSubscriptionName parameter cannot be empty.', 'http_code' => 400, 'description' => '该NisMetricSubscriptionName参数不可为空。'],
+ ['code' => 'IllegalParam.AzToAzValue', 'message' => 'Unsupported value for Az pair (%s).', 'http_code' => 400, 'description' => '暂不支持的Az对(%s)值。'],
+ ['code' => 'ResourceNotFound.NisMetricSubscriptionIds', 'message' => 'The current resource NisMetricSubscriptionIds(%s) does not exist.', 'http_code' => 404, 'description' => '当前资源NisMetricSubscriptionIds(%s)不存在。'],
+ ['code' => 'IllegalParam.DeliveryRegion', 'message' => 'Unsupported DeliveryRegion(%s) value.', 'http_code' => 400, 'description' => '暂不支持的DeliveryRegion(%s)值。'],
+ ['code' => 'IllegalParam.RegionToRegionValue', 'message' => 'Unsupported Region pair (%s) value.', 'http_code' => 400, 'description' => '暂不支持的Region对(%s)值。'],
+ ['code' => 'ResourceNotFound.NisMetricSubscriptionId', 'message' => 'The current resource NisMetricSubscriptionId(%s) does not exist.', 'http_code' => 404, 'description' => '当前资源NisMetricSubscriptionId(%s)不存在。'],
+ ['code' => 'IllegalParam.NisMetricSubscriptionId', 'message' => 'Unsupported NisMetricSubscriptionId(%s) value.', 'http_code' => 400, 'description' => '暂不支持的NisMetricSubscriptionId(%s)值。'],
+ ['code' => 'IllegalParam'."\0".'.DescriptionLanguage', 'message' => 'Unsupported DescriptionLanguage(%s) type.', 'http_code' => 400, 'description' => '暂不支持的DescriptionLanguage(%s)类型。'],
+ ['code' => 'Forbidden.GetPrometheusUserSetting', 'message' => 'The user does not have permission to access the (cms:GetPrometheusUserSetting) service.', 'http_code' => 403, 'description' => '用户无权限访问(cms:GetPrometheusUserSetting)服务。'],
+ ['code' => 'UnsupportedRegion', 'message' => 'The current (%s) service does not support this (%s) region.', 'http_code' => 400, 'description' => '当前(%s)服务不支持此(%s)地域。'],
+ ['code' => 'UnsupportedFeature.DestinationIp', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤.'],
+ ['code' => 'UnsupportedFeature.CloudIp', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤。'],
+ ['code' => 'UnsupportedFeature.SourceIp', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤。'],
+ ['code' => 'UnsupportedFeature.DestinationPort', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤。'],
+ ['code' => 'UnsupportedFeature.VpcId', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤。'],
+ ['code' => 'UnsupportedFeature.VSwitchId', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤。'],
+ ['code' => 'UnsupportedFeature.SourcePort', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤。'],
+ ['code' => 'UnsupportedFeature.TrafficPath', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤.'],
+ ['code' => 'UnsupportedFeature.Protocol', 'message' => 'Filtering by current field (%s) is not supported under this tuple.', 'http_code' => 400, 'description' => '该元组下不支持按当前字段(%s)过滤。'],
+ ['code' => 'ResourceAlreadyExist.SubscriptionObject', 'message' => 'Duplicate configuration already exists for subscription object (%s).', 'http_code' => 400, 'description' => '订阅对象(%s)已存在重复配置。'],
+ ['code' => 'QuotaExceeded.DeliveryMonitorScope', 'message' => 'The maximum quota for% s delivery has been exceeded with% s/%s.', 'http_code' => 400, 'description' => '已超出%s投递的最大配额,使用量为 %s/%s。'],
+ ['code' => 'IllegalParam.DescriptionLanguage', 'message' => 'Unsupported DescriptionLanguage(%s) type.', 'http_code' => 400, 'description' => '暂不支持的DescriptionLanguage(%s)类型。'],
+ ['code' => 'QuotaExceeded.DeliveryMonitorScope', 'message' => 'The maximum quota for %s delivery has been exceeded with %s/%s.', 'http_code' => 400, 'description' => '已超出%s投递的最大配额,使用量为 %s/%s。'],
+ ['code' => 'IllegalParam.ownerId', 'message' => 'The param of ownerId is illegal.', 'http_code' => 400, 'description' => 'ownerId的参数不合法。'],
+ ['code' => 'IllegalParam.AttachmentType', 'message' => 'Unsupported AttachmentType(%s) type.', 'http_code' => 400, 'description' => '暂不支持的AttachmentType(%s)类型。'],
+ ['code' => 'IllegalParam.MaxResults', 'message' => 'The specified parameter MaxResults is illegal.', 'http_code' => 400, 'description' => '指定的参数MaxResults不合法。'],
+ ['code' => 'IllegalParam.Provider', 'message' => 'The specified parameter Provider(s%) is invalid.', 'http_code' => 400, 'description' => '指定的参数Provider(s%)不合法。'],
+ ['code' => 'IllegalParam.RawPayload', 'message' => 'This parameter (%s) has exceeded the maximum length, please re-enter.', 'http_code' => 400, 'description' => '该参数(%s)已超过最大长度,请重新输入。'],
+ ['code' => 'MissingParam.RawPayload', 'message' => 'The parameter (%s) is not nullable.', 'http_code' => 400, 'description' => '该参数(%s)不可为空。'],
+ ['code' => 'MissingParam.AlertSource', 'message' => 'The parameter (%s) is not nullable.', 'http_code' => 400, 'description' => '该参数(%s)不可为空。'],
+ ['code' => 'MissingParam.AliUid', 'message' => 'The current user cannot be empty.', 'http_code' => 400, 'description' => '当前用户不可为空。'],
+ ['code' => 'MissingParam.GroupBy', 'message' => 'The GroupBy parameter cannot be empty.', 'http_code' => 400, 'description' => '该GroupBy参数不可为空。'],
+ ['code' => 'OperationFailed.NoRealNameAuthentication', 'message' => 'You have not verified your real name.', 'http_code' => 400, 'description' => '您尚未进行实名认证。'],
+ ['code' => 'NextToken.PAGE_SERVICE_ERROR', 'message' => 'Token is illegal, paging service error.', 'http_code' => 400, 'description' => 'Token不合法,分页服务出错.'],
+ ['code' => 'IllegalParam.Title', 'message' => 'This parameter (%s) cannot be empty or longer than 256.', 'http_code' => 400, 'description' => '该参数(%s)不可为空,或长度不可超过256.'],
+ ['code' => 'IllegalParam.ContextId', 'message' => 'The parameter (%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数(%s)不可为空。'],
+ ['code' => 'IllegalParam.Id', 'message' => 'The parameter (%s) cannot be empty.', 'http_code' => 400, 'description' => '该参数(%s)不可为空。'],
+ ['code' => 'IllegalParam.ResourceSelector.ResourceId', 'message' => 'The parameter ResourceId is invalid.', 'http_code' => 400, 'description' => '参数ResourceId异常'],
+ ['code' => 'IllegalParam.ResourceSelector.ResourceType', 'message' => 'The parameter is illegal.', 'http_code' => 400, 'description' => '参数非法 ResourceType'],
+ ['code' => 'IllegalParam.ResourceSelector.RegionId', 'message' => 'The param of ResourceSelector.ResourceId is illegal.', 'http_code' => 400, 'description' => '参数非法 ResourceId'],
+ ['code' => 'IllegalParam.Minute', 'message' => 'The specified Minute(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Minute(%s) 不合法。'],
+ ['code' => 'IllegalParam.IntervalMinutes', 'message' => 'The specified IntervalMinutes(%s) is illegal.', 'http_code' => 400, 'description' => '指定的IntervalMinutes(%s) 不合法。'],
+ ['code' => 'OperationDenied.JobStatus', 'message' => 'The current job status does not allow this operation.', 'http_code' => 403, 'description' => '当前任务状态不允许此操作。'],
+ ['code' => 'QuotaExceeded.ScheduledJob', 'message' => 'The number of scheduled jobs exceeds the quota limit.', 'http_code' => 400, 'description' => '定时巡检任务数量超过配额限制。'],
+ ['code' => 'IllegalParam.SkillId', 'message' => 'The SkillId must be an inspection or diagnose type.', 'http_code' => 400, 'description' => 'SkillId必须是巡检或诊断类型。'],
+ ['code' => 'IllegalParam.DaysOfWeek', 'message' => 'The specified DaysOfWeek(%s) is illegal.', 'http_code' => 400, 'description' => '指定的DaysOfWeek(%s) 不合法。'],
+ ['code' => 'IllegalParam.Product', 'message' => 'The specified Product(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Product(%s) 不合法。'],
+ ['code' => 'IllegalParam.ChannelId', 'message' => 'The specified ChannelId(%s) is illegal.', 'http_code' => 400, 'description' => '指定的ChannelId(%s) 不合法。'],
+ ['code' => 'IllegalParam.ScheduleType', 'message' => 'The specified ScheduleType(%s) is illegal.', 'http_code' => 400, 'description' => '指定的ScheduleType(%s) 不合法。'],
+ ['code' => 'MissingParam.JobName', 'message' => 'The JobName parameter cannot be empty.', 'http_code' => 400, 'description' => '该JobName参数不可为空。'],
+ ['code' => 'IllegalParam.TemplateConfig', 'message' => 'The specified TemplateConfig(%s) is illegal.', 'http_code' => 400, 'description' => '指定的TemplateConfig(%s) 不合法。'],
+ ['code' => 'MissingParam.Time', 'message' => 'The Time parameter cannot be empty.', 'http_code' => 400, 'description' => '该Time参数不可为空。'],
+ ['code' => 'IllegalParam.Time', 'message' => 'The specified Time(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Time(%s) 不合法。'],
+ ['code' => 'MissingParam.ContextId', 'message' => 'The ContextId parameter cannot be empty.', 'http_code' => 400, 'description' => '该ContextId参数不可为空。'],
+ ['code' => 'MissingParam.Date', 'message' => 'The Date parameter cannot be empty.', 'http_code' => 400, 'description' => '该Date参数不可为空。'],
+ ['code' => 'MissingParam.IntervalMinutes', 'message' => 'The IntervalMinutes parameter cannot be empty.', 'http_code' => 400, 'description' => '该IntervalMinutes参数不可为空。'],
+ ['code' => 'MissingParam.RunId', 'message' => 'The RunId parameter cannot be empty.', 'http_code' => 400, 'description' => '该RunId参数不可为空。'],
+ ['code' => 'MissingParam.ChannelType', 'message' => 'The ChannelType parameter cannot be empty.', 'http_code' => 400, 'description' => '该ChannelType参数不可为空。'],
+ ['code' => 'IllegalParam.Status', 'message' => 'The specified Status(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Status(%s) 不合法。'],
+ ['code' => 'IllegalParam.TaskMode', 'message' => 'The specified TaskMode(%s) is illegal.', 'http_code' => 400, 'description' => '指定的TaskMode(%s) 不合法。'],
+ ['code' => 'MissingParam.Enabled', 'message' => 'The Enabled parameter cannot be empty.', 'http_code' => 400, 'description' => '该Enabled参数不可为空。'],
+ ['code' => 'MissingParam.Channels', 'message' => 'The Channels parameter cannot be empty.', 'http_code' => 400, 'description' => '该Channels参数不可为空。'],
+ ['code' => 'DuplicatedParam.Channel', 'message' => 'The Channel is duplicated.', 'http_code' => 400, 'description' => 'Channel重复传入。'],
+ ['code' => 'MissingParam.ChannelId', 'message' => 'The ChannelId parameter cannot be empty.', 'http_code' => 400, 'description' => '该ChannelId参数不可为空。'],
+ ['code' => 'MissingParam.ScheduleType', 'message' => 'The ScheduleType parameter cannot be empty.', 'http_code' => 400, 'description' => '该ScheduleType参数不可为空。'],
+ ['code' => 'MissingParam.JobId', 'message' => 'The JobId parameter cannot be empty.', 'http_code' => 400, 'description' => '该JobId参数不可为空。'],
+ ['code' => 'IllegalParam.EndTime', 'message' => 'The specified EndTime(%s) is illegal.', 'http_code' => 400, 'description' => '指定的EndTime(%s) 不合法。'],
+ ['code' => 'MissingParam.CustomConfig', 'message' => 'The CustomConfig parameter cannot be empty.', 'http_code' => 400, 'description' => '该CustomConfig参数不可为空。'],
+ ['code' => 'IllegalParam.SortBy', 'message' => 'The specified SortBy(%s) is illegal.', 'http_code' => 400, 'description' => '指定的SortBy(%s) 不合法。'],
+ ['code' => 'MissingParam.TemplateConfig', 'message' => 'The TemplateConfig parameter cannot be empty.', 'http_code' => 400, 'description' => '该TemplateConfig参数不可为空。'],
+ ['code' => 'IllegalParam.SortOrder', 'message' => 'The specified SortOrder(%s) is illegal.', 'http_code' => 400, 'description' => '指定的SortOrder(%s) 不合法。'],
+ ['code' => 'MissingParam.DaysOfWeek', 'message' => 'The DaysOfWeek parameter cannot be empty.', 'http_code' => 400, 'description' => '该DaysOfWeek参数不可为空。'],
+ ['code' => 'IllegalParam.TriggerType', 'message' => 'The specified TriggerType(%s) is illegal.', 'http_code' => 400, 'description' => '指定的TriggerType(%s) 不合法。'],
+ ['code' => 'OperationDenied.AliUid', 'message' => 'The specified AliUid is not authorized to operate this resource.', 'http_code' => 403, 'description' => '指定的AliUid无权操作该资源。'],
+ ['code' => 'IllegalParam.ChannelType', 'message' => 'The specified ChannelType(%s) is illegal.', 'http_code' => 400, 'description' => '指定的ChannelType(%s) 不合法。'],
+ ['code' => 'IllegalParam.BeginTime', 'message' => 'The specified BeginTime(%s) is illegal.', 'http_code' => 400, 'description' => '指定的BeginTime(%s) 不合法。'],
+ ['code' => 'MissingParam.TaskMode', 'message' => 'The TaskMode parameter cannot be empty.', 'http_code' => 400, 'description' => '该TaskMode参数不可为空。'],
+ ['code' => 'IllegalParam.CustomConfig', 'message' => 'The specified CustomConfig(%s) is illegal.', 'http_code' => 400, 'description' => '指定的CustomConfig(%s) 不合法。'],
+ ['code' => 'MissingParam.DayOfMonth', 'message' => 'The DayOfMonth parameter cannot be empty.', 'http_code' => 400, 'description' => '该DayOfMonth参数不可为空。'],
+ ['code' => 'MissingParam.SkillId', 'message' => 'The SkillId parameter cannot be empty.', 'http_code' => 400, 'description' => '该SkillId参数不可为空。'],
+ ['code' => 'MissingParam.ExecutionId', 'message' => 'The ExecutionId parameter cannot be empty.', 'http_code' => 400, 'description' => '该ExecutionId参数不可为空。'],
+ ['code' => 'MissingParam.Minute', 'message' => 'The Minute parameter cannot be empty.', 'http_code' => 400, 'description' => '该Minute参数不可为空。'],
+ ['code' => 'QuotaExceeded.NotificationChannels', 'message' => 'The number of notification channels exceeds the quota limit.', 'http_code' => 400, 'description' => '通知渠道数量超过配额限制。'],
+ ['code' => 'IllegalParam.DayOfMonth', 'message' => 'The specified DayOfMonth(%s) is illegal.', 'http_code' => 400, 'description' => '指定的DayOfMonth(%s) 不合法。'],
+ ['code' => 'ResourceNotFound.JobId', 'message' => 'The specified JobId(%s) does not exist.', 'http_code' => 404, 'description' => '指定的JobId(%s) 不存在。'],
+ ['code' => 'MissingParam.UserAuthId', 'message' => 'The UserAuthId parameter cannot be empty.', 'http_code' => 400, 'description' => '该UserAuthId参数不可为空。'],
+ ['code' => 'IllegalParam.Date', 'message' => 'The specified Date(%s) is illegal.', 'http_code' => 400, 'description' => '指定的Date(%s) 不合法。'],
+ ['code' => 'IllegalParamLength.JobName', 'message' => 'The JobName exceeds the maximum length limit of 128.', 'http_code' => 400, 'description' => 'JobName超过最大长度限制128。'],
+ ['code' => 'IllegalParam.IntervalMinutesTooShort', 'message' => 'The IntervalMinutes must be at least 10.', 'http_code' => 400, 'description' => 'IntervalMinutes最小值为10。'],
+ ['code' => 'IllegalParam.TemplateConfigSkillCount', 'message' => 'The TemplateConfig can only contain one skill.', 'http_code' => 400, 'description' => 'TemplateConfig只能包含一个巡检技能。'],
+ ['code' => 'IllegalParam.BizType', 'message' => 'The specified BizType(%s) is illegal.', 'http_code' => 400, 'description' => '指定的BizType(%s)不合法。'],
+ ['code' => 'InvalidParameter', 'message' => 'Invalid parameter.', 'http_code' => 400, 'description' => '无效参数。'],
+ ['code' => 'ResourceNotFound.InspectionResource', 'message' => 'The current resource InspectionResource(%s) does not exist.', 'http_code' => 404, 'description' => '当前资源InspectionResource(%s)不存在。'],
+ ['code' => 'MissingParam.AgentTaskBindingId', 'message' => 'The AgentTaskBindingId parameter cannot be empty.', 'http_code' => 400, 'description' => '该AgentTaskBindingId参数不可为空。'],
+ ['code' => 'IllegalParam.BizId', 'message' => 'The specified BizId(%s) is illegal.', 'http_code' => 400, 'description' => '指定的BizId(%s)不合法。'],
+ ['code' => 'IllegalParam.ActionParam', 'message' => 'Illegal parameter ActionParam.', 'http_code' => 400, 'description' => '非法参数ActionParam。'],
+ ['code' => 'NidUnknownError', 'message' => 'The NID service is not available.', 'http_code' => 400, 'description' => 'NID服务不可用。'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNetworkPath'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAndAnalyzeNetworkPath'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNetworkPath'],
+ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetVbrFlowTopN'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNetworkReachableAnalysis'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNisNetworkRanking'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNetworkReachableAnalysis'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNetworkReachableAnalysis'],
+ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTransitRouterFlowTopN'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNisNetworkMetrics'],
+ ['threshold' => '120', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNatTopN'],
+ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetInternetTuple'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'NIS',
+ 'productName' => '网络智能服务',
+ 'ramCodes' => ['nis'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetNisNetworkRanking',
+ 'description' => '获取云网络指标排名',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'nis:GetNisNetworkRanking',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalParam.NextToken',
- 'errorMessage' => 'The specified argument NextToken(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.Status',
- 'errorMessage' => 'The specified Status(%s) parameter is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.InspectionProject',
- 'errorMessage' => 'The specified argument InspectionProject(%s) is illegal.',
+ [
+ 'apiName' => 'GetVbrFlowTopN',
+ 'description' => '获取混合云流量详情数据排名',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:GetVbrFlowTopN',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"InspectionTaskList\\": [\\n {\\n \\"InspectionTaskId\\": \\"ni-8svm******hzr7fh79\\",\\n \\"InspectionName\\": \\"nis巡检\\",\\n \\"Status\\": \\"Active\\",\\n \\"InspectionProject\\": \\"basic\\",\\n \\"CreateTime\\": \\"2024-06-18 00:14:46\\",\\n \\"LastUpdateReportId\\": \\"nir-b4c4c9******8a25e\\"\\n }\\n ],\\n \\"NextToken\\": \\"hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 5\\n}","type":"json"}]',
- 'title' => '查询巡检任务列表',
- ],
- 'DescribeNisInspectionTask' => [
- 'summary' => '查询巡检任务详情。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DescribeNisInspectionReportStatus',
+ 'description' => '查询巡检报告状态',
'operationType' => 'get',
- 'abilityTreeCode' => '227206',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionTaskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检任务ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ni-8svmpe0yso2bhzr7fh79',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<DescribeNisInspectionTaskResponse>',
- 'description' => 'RpcResponse<DescribeNisInspectionTaskResponse>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
- 'InspectionTaskId' => [
- 'description' => '巡检任务ID',
- 'type' => 'string',
- 'example' => 'ni-8svmpe0yso2bhzr7fh79',
- ],
- 'InspectionName' => [
- 'description' => '巡检任务名称',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'Status' => [
- 'description' => '任务运行状态:'."\n"
- ."\n"
- .'Creating: 创建中'."\n"
- ."\n"
- .'Active: 已开启'."\n"
- ."\n"
- .'Running: 执行中'."\n"
- ."\n"
- .'Inactive:已关闭',
- 'type' => 'string',
- 'example' => 'Active',
- ],
- 'InspectionProject' => [
- 'description' => '巡检任务采用的巡检方案类别:基础(basic)/自定义场景(customized)',
- 'type' => 'string',
- 'example' => 'basic',
- ],
- 'InspectionTriggerTime' => [
- 'description' => '巡检任务触发时间。',
- 'type' => 'string',
- 'example' => '2024-07-01 15:15:57',
- ],
- 'InspectionInterval' => [
- 'description' => '巡检执行周期。单位**天**。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'LastUpdateReportId' => [
- 'description' => '最新报告ID。',
- 'type' => 'string',
- 'example' => 'nir-7c3dd178738a429abe6d',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-07-01 10:00:57'."\n",
- ],
- 'LastUpdateTime' => [
- 'description' => '最新一次更新时间。',
- 'type' => 'string',
- 'example' => '2024-07-01 10:00:59',
- ],
- 'CheckResourceList' => [
- 'description' => '巡检资源配置。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'description' => '资源类型。',
- 'type' => 'string',
- 'example' => 'EIP',
- ],
- 'CheckScope' => [
- 'description' => '巡检规则。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Whitelist' => '白名单',
- 'BlackList' => '黑名单',
- 'CheckAll' => '资源类型下实例全托管',
- ],
- 'example' => 'CheckAll',
- ],
- ],
- ],
- 'enumValueTitles' => [],
- ],
- ],
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionReportStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ResourceNotFound.InspectionTaskId',
- 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.',
+ [
+ 'apiName' => 'ListNisInspectionTaskReports',
+ 'description' => '查询巡检任务报告列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:ListNisInspectionTaskReports',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"InspectionTaskId\\": \\"ni-8svmpe0yso2bhzr7fh79\\",\\n \\"InspectionName\\": \\"Default\\",\\n \\"Status\\": \\"Active\\",\\n \\"InspectionProject\\": \\"basic\\",\\n \\"InspectionTriggerTime\\": \\"2024-07-01 15:15:57\\",\\n \\"InspectionInterval\\": \\"1\\",\\n \\"LastUpdateReportId\\": \\"nir-7c3dd178738a429abe6d\\",\\n \\"CreateTime\\": \\"2024-07-01 10:00:57\\\\n\\",\\n \\"LastUpdateTime\\": \\"2024-07-01 10:00:59\\",\\n \\"CheckResourceList\\": [\\n {\\n \\"ResourceType\\": \\"EIP\\",\\n \\"CheckScope\\": \\"CheckAll\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询巡检任务详情',
- ],
- 'ListNisInspectionResourceType' => [
- 'summary' => '查询巡检对象产品类型列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListNisInspectionResourceType',
+ 'description' => '查询巡检对象产品类型列表',
'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226557',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<ListNisInspectionResourceTypeResponse>',
- 'description' => 'RpcResponse<ListNisInspectionResourceTypeResponse>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B',
- ],
- 'ResourceTypeList' => [
- 'description' => '巡检资源类型',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'description' => '资源类型',
- 'type' => 'string',
- 'example' => 'EIP',
- ],
- ],
- ],
- ],
- ],
+ 'ramAction' => [
+ 'action' => 'nis:ListNisInspectionResourceType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"ResourceTypeList\\": [\\n {\\n \\"ResourceType\\": \\"EIP\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询巡检对象产品类型列表',
- ],
- 'DescribeNisInspectionReportStatus' => [
- 'summary' => '查询巡检报告状态。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DescribeNisTrafficRanking',
+ 'description' => '查询NIS流量排序分析结果',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226204',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionReportId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检报告ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nir-2ca527b8de114ba4afb9',
- 'maxLength' => 128,
- 'minLength' => 1,
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisTrafficRanking',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<DescribeNisInspectionReportStatusResponse>',
- 'description' => 'RpcResponse<DescribeNisInspectionReportStatusResponse>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
- 'InspectionReportId' => [
- 'description' => '巡检报告ID。',
- 'type' => 'string',
- 'example' => 'nir-2ca527b8de114ba4afb9',
- ],
- 'InspectionTaskId' => [
- 'description' => '巡检任务ID。',
- 'type' => 'string',
- 'example' => 'ni-8svmpe0yso****r7fh79',
- ],
- 'Status' => [
- 'description' => '巡检报告状态。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Failed' => '失败',
- 'Finish' => '结束',
- 'On-going' => '执行中',
- ],
- 'example' => 'Finish',
- ],
- 'StartTime' => [
- 'description' => '开始时间。',
- 'type' => 'string',
- 'example' => '2024-07-18 15:12:28',
- ],
- 'EndTime' => [
- 'description' => '停止时间。',
- 'type' => 'string',
- 'example' => '2024-07-18 15:13:07',
- ],
- 'InspectionProject' => [
- 'description' => '巡检任务采用的巡检方案类别。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'customized' => '自定义场景',
- 'basic' => '基础场景',
- ],
- 'example' => 'basic',
- ],
- 'InspectionTaskName' => [
- 'description' => '巡检任务名称。',
- 'type' => 'string',
- 'example' => '默认',
- ],
- ],
+ [
+ 'apiName' => 'DeleteNisInspectionReport',
+ 'description' => '删除巡检报告',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'nis:DeleteNisInspectionReport',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'Forbidden.InspectionReportId',
- 'errorMessage' => 'This user does not have permission to this report parameter (%s).',
+ [
+ 'apiName' => 'DescribeNisInspectionReportSummary',
+ 'description' => '查询巡检报告总结',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionReportSummary',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'ResourceNotFound.InspectionReportId',
- 'errorMessage' => 'The specified InspectionReportId(%s) is not found.',
+ ],
+ [
+ 'apiName' => 'DeleteNisInspectionTask',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'nis:DeleteNisInspectionTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"InspectionReportId\\": \\"nir-2ca527b8de114ba4afb9\\",\\n \\"InspectionTaskId\\": \\"ni-8svmpe0yso****r7fh79\\",\\n \\"Status\\": \\"Finish\\",\\n \\"StartTime\\": \\"2024-07-18 15:12:28\\",\\n \\"EndTime\\": \\"2024-07-18 15:13:07\\",\\n \\"InspectionProject\\": \\"basic\\",\\n \\"InspectionTaskName\\": \\"默认\\"\\n}","type":"json"}]',
- 'title' => '查询巡检报告状态',
- ],
- 'DescribeNisInspectionReportSummary' => [
- 'summary' => '查询巡检报告总结。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DeleteNetworkReachableAnalysis',
+ 'description' => '删除网络可达性分析任务',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'nis:DeleteNetworkReachableAnalysis',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkReachableAnalysis', 'arn' => 'acs:nis:*:{#accountId}:networkreachableanalysis/{#NetworkReachableAnalysisId}'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetNetworkReachableAnalysis',
+ 'description' => '获取网络可达性分析任务结果',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226211',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionReportId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检报告ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nir-38abb318b27b49cc9a01',
- 'maxLength' => 128,
- 'minLength' => 1,
+ 'ramAction' => [
+ 'action' => 'nis:GetNetworkReachableAnalysis',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkReachableAnalysis', 'arn' => 'acs:nis:*:{#accountId}:networkreachableanalysis/{#NetworkReachableAnalysisId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<DescribeNisInspectionReportSummaryResponse>',
- 'description' => 'RpcResponse<DescribeNisInspectionReportSummaryResponse>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '4838F3F2-30E1-5D82-B25A-B9FE33BC3E25',
- ],
- 'InspectionReportId' => [
- 'description' => '巡检报告ID。',
- 'type' => 'string',
- 'example' => 'nir-38abb318b27b49cc9a01',
- ],
- 'InspectionTaskId' => [
- 'description' => '巡检任务ID',
- 'type' => 'string',
- 'example' => 'ni-8svmpe0yso2bhzr7fh79',
- ],
- 'Status' => [
- 'description' => '任务运行状态:'."\n"
- ."\n"
- .'Creating: 创建中'."\n"
- ."\n"
- .'Active: 已开启'."\n"
- ."\n"
- .'Running: 执行中'."\n"
- ."\n"
- .'Inactive:已关闭',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Creating' => '创建中',
- 'Active' => '已开启',
- 'Running' => '执行中',
- 'Inactive' => '已关闭',
- ],
- 'example' => 'Active',
- ],
- 'StartTime' => [
- 'description' => '开始时间。',
- 'type' => 'string',
- 'example' => '2024-06-03 09:35:00',
- ],
- 'EndTime' => [
- 'description' => '停止时间。',
- 'type' => 'string',
- 'example' => '2024-06-03 09:36:00'."\n",
- ],
- 'Summary' => [
- 'description' => '摘要信息。',
- 'type' => 'object',
- 'properties' => [
- 'CheckItemCount' => [
- 'description' => '巡检项数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
- ],
- 'CheckResourceCount' => [
- 'description' => '巡检资源数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '123',
- ],
- 'PassRateSummary' => [
- 'description' => '通过率摘要。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PassRateScope' => [
- 'description' => '通过率范畴。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Stability' => '稳定性',
- 'Total' => '总体',
- ],
- 'example' => 'Stability',
- ],
- 'PassRate' => [
- 'description' => '通过率。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.98',
- ],
- ],
- ],
- ],
- 'RiskSummary' => [
- 'description' => '风险摘要。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RiskType' => [
- 'description' => '风险类型。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'StabilityRisk' => '稳定性风险',
- 'TotalRisk' => '总体风险',
- ],
- 'example' => 'StabilityRisk',
- ],
- 'RiskLevel' => [
- 'description' => '风险等级。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'LowRisk' => '低风险',
- 'HighRisk' => '高风险',
- 'MediumRisk' => '中风险',
- 'NoRisk' => '无风险',
- ],
- 'example' => 'HighRisk',
- ],
- 'RiskCount' => [
- 'description' => '风险数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'ResourceCount' => [
- 'description' => '风险关联的资源数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'DescribeNisInspectionTask',
+ 'description' => '查询巡检任务详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'Forbidden.InspectionReportId',
- 'errorMessage' => 'This user does not have permission to this report parameter (%s).',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound.InspectionReportId',
- 'errorMessage' => 'The specified InspectionReportId(%s) is not found.',
+ [
+ 'apiName' => 'DescribeNisInspectionRecommendationResources',
+ 'description' => '查询巡检报告异常项实例列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionRecommendationResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4838F3F2-30E1-5D82-B25A-B9FE33BC3E25\\",\\n \\"InspectionReportId\\": \\"nir-38abb318b27b49cc9a01\\",\\n \\"InspectionTaskId\\": \\"ni-8svmpe0yso2bhzr7fh79\\",\\n \\"Status\\": \\"Active\\",\\n \\"StartTime\\": \\"2024-06-03 09:35:00\\",\\n \\"EndTime\\": \\"2024-06-03 09:36:00\\\\n\\",\\n \\"Summary\\": {\\n \\"CheckItemCount\\": 11,\\n \\"CheckResourceCount\\": 123,\\n \\"PassRateSummary\\": [\\n {\\n \\"PassRateScope\\": \\"Stability\\",\\n \\"PassRate\\": 0.98\\n }\\n ],\\n \\"RiskSummary\\": [\\n {\\n \\"RiskType\\": \\"StabilityRisk\\",\\n \\"RiskLevel\\": \\"HighRisk\\",\\n \\"RiskCount\\": 3,\\n \\"ResourceCount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '查询巡检报告总结',
- ],
- 'DescribeNisInspectionReportCheckItems' => [
- 'summary' => '查询巡检报告检查项详情。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListNisInspectionTasks',
+ 'description' => '查询巡检任务列表',
'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226206',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionReportId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检报告ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nir-ffd1af****196d0',
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'ResourceType',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '资源类型',
- 'type' => 'array',
- 'items' => [
- 'description' => '关联资源的类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NAT' => 'NAT',
- 'VPN' => 'VPN',
- 'NLB' => 'NLB',
- 'VBR' => 'VBR',
- 'ALB' => 'ALB',
- 'CLB' => 'CLB',
- 'EIP' => 'EIP',
- 'TR' => 'TR',
- ],
- 'example' => 'NAT',
- 'maxLength' => 32,
- 'minLength' => 1,
- ],
- 'required' => false,
- 'maxItems' => 20,
- ],
- ],
- [
- 'name' => 'CategoryCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检项类别。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'stability',
- 'enum' => [
- 'cost_optimizing',
- 'performance',
- 'security',
- 'stability',
- 'operational_excellence',
- ],
- ],
- ],
- [
- 'name' => 'RiskLevel',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '风险等级集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '风险等级,不填为全部风险等级。取值:'."\n"
- .'- **HighRisk**:高风险'."\n"
- .'- **MediumRisk**:中风险'."\n"
- .'- **LowRisk**:低风险'."\n"
- .'- **NoRisk**:无风险',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HighRisk',
- 'enum' => [
- 'HighRisk',
- 'MediumRisk',
- 'LowRisk',
- 'NoRisk',
- ],
- ],
- 'required' => false,
- 'maxItems' => 20,
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。最大值为100。默认值为20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
- ],
- [
- 'name' => 'Language',
- 'in' => 'query',
- 'schema' => [
- 'title' => '语言,枚举:zh-CN,en-US',
- 'description' => '语言,枚举:zh-CN,en-US',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- 'enum' => [
- 'zh-CN',
- 'en-US',
- ],
+ 'ramAction' => [
+ 'action' => 'nis:ListNisInspectionTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<NextTokenResult<DescribeNisInspectionReportCheckItemsResponse>>',
- 'description' => 'RpcResponse<NextTokenResult<DescribeNisInspectionReportCheckItemsResponse>>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B',
- ],
- 'CheckItemList' => [
- 'description' => '巡检检查项列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'description' => '巡检检查项关联的资源类型。',
- 'type' => 'string',
- 'example' => 'NAT',
- ],
- 'CategoryCode' => [
- 'description' => '巡检项类别。',
- 'type' => 'string',
- 'example' => 'stability',
- ],
- 'CheckItemCode' => [
- 'description' => '巡检检查项码',
- 'type' => 'string',
- 'example' => 'item_nat_water_level_check',
- ],
- 'Description' => [
- 'description' => '巡检检查项描述。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'CheckResultList' => [
- 'description' => '巡检风险等级数量结果列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RiskLevel' => [
- 'description' => '风险等级。取值:'."\n"
- .'- **HighRisk**:高风险'."\n"
- .'- **MediumRisk**:中风险'."\n"
- .'- **LowRisk**:低风险'."\n"
- .'- **NoRisk**:无风险',
- 'type' => 'string',
- 'example' => 'LowRisk',
- ],
- 'Count' => [
- 'description' => '巡检报告中对应等级的风险数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'RecommendationList' => [
- 'description' => '巡检异常项结果列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RiskLevel' => [
- 'description' => '风险等级。'."\n"
- .'取值:'."\n"
- .'- **HighRisk**:高风险'."\n"
- .'- **MediumRisk**:中风险'."\n"
- .'- **LowRisk**:低风险'."\n"
- .'- **NoRisk**:无风险',
- 'type' => 'string',
- 'example' => 'LowRisk',
- ],
- 'RecommendationCode' => [
- 'description' => '巡检异常项。',
- 'type' => 'string',
- 'example' => 'nat_snat_cross_az_warn',
- ],
- 'Abnormality' => [
- 'description' => '异常项描述。',
- 'type' => 'string',
- 'example' => '多个跨可用区资源共用一台NAT网关',
- ],
- 'Reason' => [
- 'description' => '异常原因。',
- 'type' => 'string',
- 'example' => '多个跨可用区资源共用一台NAT网关',
- ],
- 'Suggestion' => [
- 'description' => '优化建议。',
- 'type' => 'string',
- 'example' => '建议在资源所在可用区均部署NAT网关,并配置您的SNAT/DNAT规则以确保资源使用同可用区内的NAT网关。这样可以确保即使某个可用区发生故障,其他可用区的资源仍能保持网络通信。',
- ],
- 'Metadata' => [
- 'description' => '异常项对应资源的元数据。',
- 'type' => 'string',
- 'example' => '{"Columns":[{"ColumnType":"id","ColumnTitle":"资源ID","ColumnValue":"ResourceId"},{"ColumnType":"az","ColumnTitle":"NAT部署AZ","ColumnValue":"NatAZ"},{"ColumnType":"array.az","ColumnTitle":"资源部署AZ","ColumnValue":"ForwardsAZs"},{"ColumnType":"region","ColumnTitle":"地域","ColumnValue":"RegionNo"}]}',
- ],
- 'ReasonCode' => [
- 'type' => 'string',
- ],
- 'SuggestionCode' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'CheckItemName' => [
- 'description' => '检查项的名称。',
- 'type' => 'string',
- 'example' => 'NAT高可用部署检查',
- ],
- 'DescriptionCode' => [
- 'title' => '巡检项描述Code',
- 'description' => '巡检项描述Code',
- 'type' => 'string',
- 'example' => 'item_ep_high_availability_check_description',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '是否拥有下一次查询的令牌(Token)。取值:如果NextToken为空表示没有下一次查询。 如果NextToken有返回值,该取值表示下一次查询开始的令牌。',
- 'type' => 'string',
- 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj',
- ],
- 'TotalCount' => [
- 'description' => '返回的条目总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
- ],
- 'MaxResults' => [
- 'description' => '分页大小,取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'InspectionReportId' => [
- 'description' => '巡检报告ID',
- 'type' => 'string',
- 'example' => 'nir-ffd1af****196d0',
- ],
- ],
+ [
+ 'apiName' => 'CreateNetworkPath',
+ 'description' => '创建网络分析路径',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:CreateNetworkPath',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkPath', 'arn' => 'acs:nis:*:{#accountId}:networkpath/*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncorrectStatus.InspectionReportNotFinish',
- 'errorMessage' => 'The specified task report InspectionReportId(%s) has not been completed.',
- ],
- [
- 'errorCode' => 'IllegalParam.ResourceType',
- 'errorMessage' => 'The specified resourceType (%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.RiskLevel',
- 'errorMessage' => 'The specified argument RiskLevel(%s) is illegal.',
- ],
- [
- 'errorCode' => 'IllegalParam.NextToken',
- 'errorMessage' => 'The specified nextToken(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.UnsupportedResourceType',
- 'errorMessage' => 'The specified parameter ResourceType(%s) is invalid, with a resource type that is not currently supported.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden.InspectionReportId',
- 'errorMessage' => 'This user does not have permission to this report parameter (%s).',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound.InspectionReportId',
- 'errorMessage' => 'The specified InspectionReportId(%s) is not found.',
+ [
+ 'apiName' => 'DeleteNetworkPath',
+ 'description' => '删除网络分析路径',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'nis:DeleteNetworkPath',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkPath', 'arn' => 'acs:nis:*:{#accountId}:networkpath/{#NetworkPathId}'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"CheckItemList\\": [\\n {\\n \\"ResourceType\\": \\"NAT\\",\\n \\"CategoryCode\\": \\"stability\\",\\n \\"CheckItemCode\\": \\"item_nat_water_level_check\\",\\n \\"Description\\": \\"无\\",\\n \\"CheckResultList\\": [\\n {\\n \\"RiskLevel\\": \\"LowRisk\\",\\n \\"Count\\": 0\\n }\\n ],\\n \\"RecommendationList\\": [\\n {\\n \\"RiskLevel\\": \\"LowRisk\\",\\n \\"RecommendationCode\\": \\"nat_snat_cross_az_warn\\",\\n \\"Abnormality\\": \\"多个跨可用区资源共用一台NAT网关\\",\\n \\"Reason\\": \\"多个跨可用区资源共用一台NAT网关\\",\\n \\"Suggestion\\": \\"建议在资源所在可用区均部署NAT网关,并配置您的SNAT/DNAT规则以确保资源使用同可用区内的NAT网关。这样可以确保即使某个可用区发生故障,其他可用区的资源仍能保持网络通信。\\",\\n \\"Metadata\\": \\"{\\\\\\"Columns\\\\\\":[{\\\\\\"ColumnType\\\\\\":\\\\\\"id\\\\\\",\\\\\\"ColumnTitle\\\\\\":\\\\\\"资源ID\\\\\\",\\\\\\"ColumnValue\\\\\\":\\\\\\"ResourceId\\\\\\"},{\\\\\\"ColumnType\\\\\\":\\\\\\"az\\\\\\",\\\\\\"ColumnTitle\\\\\\":\\\\\\"NAT部署AZ\\\\\\",\\\\\\"ColumnValue\\\\\\":\\\\\\"NatAZ\\\\\\"},{\\\\\\"ColumnType\\\\\\":\\\\\\"array.az\\\\\\",\\\\\\"ColumnTitle\\\\\\":\\\\\\"资源部署AZ\\\\\\",\\\\\\"ColumnValue\\\\\\":\\\\\\"ForwardsAZs\\\\\\"},{\\\\\\"ColumnType\\\\\\":\\\\\\"region\\\\\\",\\\\\\"ColumnTitle\\\\\\":\\\\\\"地域\\\\\\",\\\\\\"ColumnValue\\\\\\":\\\\\\"RegionNo\\\\\\"}]}\\",\\n \\"ReasonCode\\": \\"\\",\\n \\"SuggestionCode\\": \\"\\"\\n }\\n ],\\n \\"CheckItemName\\": \\"NAT高可用部署检查\\",\\n \\"DescriptionCode\\": \\"item_ep_high_availability_check_description\\"\\n }\\n ],\\n \\"NextToken\\": \\"hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj\\",\\n \\"TotalCount\\": 11,\\n \\"MaxResults\\": 20,\\n \\"InspectionReportId\\": \\"nir-ffd1af****196d0\\"\\n}","type":"json"}]',
- 'title' => '查询巡检报告检查项详情',
- ],
- 'DescribeNisInspectionRecommendationResources' => [
- 'summary' => '查询巡检报告异常项实例列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226209',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionReportId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检报告ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nir-ffd1af****196d0'."\n",
- 'maxLength' => 128,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'RecommendationCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '异常建议码',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nat_snat_cross_az_warn',
- 'maxLength' => 64,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的最大条目数。最大值为100。默认值为20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
- ],
- [
- 'name' => 'Language',
- 'in' => 'query',
- 'schema' => [
- 'description' => '使用的语言。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- 'enum' => [
- 'zh-CN',
- 'en-US',
- ],
+ [
+ 'apiName' => 'CreateNetworkReachableAnalysis',
+ 'description' => '创建网络可达性分析任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:CreateNetworkReachableAnalysis',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => 'NetworkReachableAnalysis', 'arn' => 'acs:nis:*:{#accountId}:networkreachableanalysis/*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<NextTokenResult<DescribeNisInspectionRecommendationResourcesResponse>>',
- 'description' => 'RpcResponse<NextTokenResult<DescribeNisInspectionRecommendationResourcesResponse>>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F',
- ],
- 'ResourceList' => [
- 'description' => '资源列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ResourceId' => [
- 'description' => '异常实例ID',
- 'type' => 'string',
- 'example' => 'ngw-p0wn04hi4****q2us6q7q',
- ],
- 'ResourceName' => [
- 'description' => '实例名称',
- 'type' => 'string',
- 'example' => '公网nat',
- ],
- 'AnalysisData' => [
- 'description' => '异常信息详情',
- 'type' => 'string',
- 'example' => "\n"
- .'{ResourceId: "ngw-p0wn04hi4****q2us6q7q"}',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '下一个查询开始的Token。',
- 'type' => 'string',
- 'example' => 'qt0DqY2lXxwBt9/ROQoS/7J9p90D1vF2vFbwzb/1oSWr3AxcM6/KpObZ7Z1PZdcV',
- ],
- 'TotalCount' => [
- 'description' => '资源信息总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '192',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的最大条目数。最大值为100。默认值为20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'InspectionReportId' => [
- 'description' => '资源报告ID',
- 'type' => 'string',
- 'example' => 'nir-ffd1af****196d0'."\n",
- ],
- ],
+ [
+ 'apiName' => 'StartNisInspectionTask',
+ 'description' => '发起巡检任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:StartNisInspectionTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalParam.NextToken',
- 'errorMessage' => 'The specified nextToken(%s) is invalid.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden.InspectionReportId',
- 'errorMessage' => 'This user does not have permission to this report parameter (%s).',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound.InspectionReportId',
- 'errorMessage' => 'The specified InspectionReportId(%s) is not found.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.RecommendationCode',
- 'errorMessage' => 'The specified parameter RecommendationCode(%s) does not exist.',
+ [
+ 'apiName' => 'GetNisNetworkMetrics',
+ 'description' => '获取云网络指标趋势',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'nis:GetNisNetworkMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F0D6EC-E19E-58AC-AC9F-08036763960F\\",\\n \\"ResourceList\\": [\\n {\\n \\"ResourceId\\": \\"ngw-p0wn04hi4****q2us6q7q\\",\\n \\"ResourceName\\": \\"公网nat\\",\\n \\"AnalysisData\\": \\"\\\\n{ResourceId: \\\\\\"ngw-p0wn04hi4****q2us6q7q\\\\\\"}\\"\\n }\\n ],\\n \\"NextToken\\": \\"qt0DqY2lXxwBt9/ROQoS/7J9p90D1vF2vFbwzb/1oSWr3AxcM6/KpObZ7Z1PZdcV\\",\\n \\"TotalCount\\": 192,\\n \\"MaxResults\\": 20,\\n \\"InspectionReportId\\": \\"nir-ffd1af****196d0\\\\n\\"\\n}","type":"json"}]',
- 'title' => '查询巡检报告异常项实例列表',
- ],
- 'ListNisInspectionTaskReports' => [
- 'summary' => '查询巡检任务报告列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226119',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionTaskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '巡检任务id',
- 'description' => '巡检任务id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ni-8svmpe0yso2bhzr7fh79',
- 'maxLength' => 23,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '上一页的查询返回的值,首页查询不传值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页大小,取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
+ [
+ 'apiName' => 'StartNisTrafficRanking',
+ 'description' => '启动NIS流量排序分析',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:StartNisTrafficRanking',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<NextTokenResult<ListNisInspectionTaskReportsResponse>>',
- 'description' => 'RpcResponse<NextTokenResult<ListNisInspectionTaskReportsResponse>>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0D213AF9-7B8A-51A8-B411-2D797A1A447B',
- ],
- 'InspectionReportList' => [
- 'description' => '巡检报告列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InspectionReportId' => [
- 'description' => '巡检报告ID。',
- 'type' => 'string',
- 'example' => 'nir-7c3dd178738a429abe6d',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '返回的条目总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '34',
- ],
- 'NextToken' => [
- 'description' => '是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。',
- 'type' => 'string',
- 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj',
- ],
- 'MaxResults' => [
- 'description' => '分页大小,取值范围:1~100,默认值:20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- ],
+ [
+ 'apiName' => 'UpdateNisInspectionTask',
+ 'description' => '更新巡检任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'nis:UpdateNisInspectionTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IllegalParam.NextToken',
- 'errorMessage' => 'The specified nextToken(%s) is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParam.InspectionTaskId',
- 'errorMessage' => 'The specified argument InspectionTaskId(%s) is illegal.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'ResourceNotFound.InspectionTaskId',
- 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.',
+ [
+ 'apiName' => 'GetTransitRouterFlowTopN',
+ 'description' => '获取跨域流量详情数据排名',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:GetTransitRouterFlowTopN',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D213AF9-7B8A-51A8-B411-2D797A1A447B\\",\\n \\"InspectionReportList\\": [\\n {\\n \\"InspectionReportId\\": \\"nir-7c3dd178738a429abe6d\\"\\n }\\n ],\\n \\"TotalCount\\": 34,\\n \\"NextToken\\": \\"hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
- 'title' => '查询巡检任务报告列表',
- ],
- 'DeleteNisInspectionReport' => [
- 'summary' => '删除巡检报告。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226212',
- 'abilityTreeNodes' => [
- 'FEATUREnetanaS7CH2P',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'InspectionReportId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '巡检报告ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'nir-ffd1af****196d0'."\n",
- 'maxLength' => 128,
- 'minLength' => 1,
+ [
+ 'apiName' => 'CreateAndAnalyzeNetworkPath',
+ 'description' => '发起网络可达性分析任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'nis:CreateAndAnalyzeNetworkPath',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'RpcResponse<Boolean>',
- 'description' => 'RpcResponse<Boolean>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B',
- ],
- 'Data' => [
- 'description' => '删除结果',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- ],
+ [
+ 'apiName' => 'GetInternetTuple',
+ 'description' => '获取公网流量详情数据排名',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:GetInternetTuple',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'Forbidden.InspectionReportId',
- 'errorMessage' => 'This user does not have permission to this report parameter (%s).',
+ [
+ 'apiName' => 'GetNatTopN',
+ 'description' => '获取NAT网关SNAT转发实时数据排名',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:GetNatTopN',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'ResourceNotFound.InspectionReportId',
- 'errorMessage' => 'The specified InspectionReportId(%s) is not found.',
+ ],
+ [
+ 'apiName' => 'DescribeNisInspectionReportCheckItems',
+ 'description' => '查询巡检报告检查项详情',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'nis:DescribeNisInspectionReportCheckItems',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'NIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5E98683-355B-5867-8D3D-A24755F6895B\\",\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '删除巡检报告',
],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'nis.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'nis-intl.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'InspectionReport', 'arn' => 'acs:nis::{#accountId}:inspectionreport/*'],
+ ['validationType' => 'always', 'resourceType' => 'InspectionTask', 'arn' => 'acs:nis::{#accountId}:inspectiontask/*'],
+ ['validationType' => 'always', 'resourceType' => 'NetworkReachableAnalysis', 'arn' => 'acs:nis:*:{#accountId}:networkreachableanalysis/{#NetworkReachableAnalysisId}'],
+ ['validationType' => 'always', 'resourceType' => 'NetworkPath', 'arn' => 'acs:nis:*:{#accountId}:networkpath/*'],
+ ['validationType' => 'always', 'resourceType' => 'NetworkPath', 'arn' => 'acs:nis:*:{#accountId}:networkpath/{#NetworkPathId}'],
+ ['validationType' => 'always', 'resourceType' => 'NetworkReachableAnalysis', 'arn' => 'acs:nis:*:{#accountId}:networkreachableanalysis/*'],
],
],
];