diff options
Diffstat (limited to 'data/zh_cn/nis')
| -rw-r--r-- | data/zh_cn/nis/2021-12-16/api-docs.php | 8224 |
1 files changed, 8224 insertions, 0 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 new file mode 100644 index 0000000..f4ff3bb --- /dev/null +++ b/data/zh_cn/nis/2021-12-16/api-docs.php @@ -0,0 +1,8224 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'nis', + 'version' => '2021-12-16', + ], + 'directories' => [ + [ + 'id' => 391923, + 'title' => '流量分析器', + 'type' => 'directory', + 'children' => [ + 'StartNisTrafficRanking', + 'DescribeNisTrafficRanking', + ], + ], + [ + 'id' => 391926, + 'title' => '流量分析', + 'type' => 'directory', + 'children' => [ + 'GetNisNetworkRanking', + 'GetInternetTuple', + 'GetNatTopN', + 'GetVbrFlowTopN', + 'GetTransitRouterFlowTopN', + ], + ], + [ + 'id' => 391932, + 'title' => '自助诊断', + 'type' => 'directory', + 'children' => [ + 'CreateNetworkReachableAnalysis', + 'CreateNetworkPath', + 'CreateAndAnalyzeNetworkPath', + 'DeleteNetworkPath', + 'DeleteNetworkReachableAnalysis', + 'GetNetworkReachableAnalysis', + ], + ], + [ + 'id' => 391939, + 'title' => '网络Metric', + 'type' => 'directory', + 'children' => [ + 'GetNisNetworkMetrics', + ], + ], + [ + 'id' => 391941, + 'title' => '网络巡检', + 'type' => 'directory', + 'children' => [ + 'StartNisInspectionTask', + 'UpdateNisInspectionTask', + 'DeleteNisInspectionTask', + 'ListNisInspectionTasks', + 'DescribeNisInspectionTask', + 'ListNisInspectionResourceType', + 'DescribeNisInspectionReportStatus', + 'DescribeNisInspectionReportSummary', + 'DescribeNisInspectionReportCheckItems', + 'DescribeNisInspectionRecommendationResources', + 'ListNisInspectionTaskReports', + 'DeleteNisInspectionReport', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'StartNisTrafficRanking' => [ + 'summary' => '触发NIS流量分析器执行指定范围内的流量排序任务', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + '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-shanghai', + ], + ], + [ + 'name' => 'TrafficAnalyzerId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源所在地域。', + 'description' => '流量分析器ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'nta-262****ca07f', + ], + ], + [ + 'name' => 'TupleDimension', + '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', + ], + ], + ], + [ + 'name' => 'TrafficScenario', + 'in' => 'query', + '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', + ], + ], + ], + [ + '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', + ], + ], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + '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' => 'OrderBy', + 'in' => 'query', + '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', + ], + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '支持进一步指定流量的过滤条件，进行聚焦性流量分析。', + 'description' => '支持进一步指定流量的过滤条件，进行聚焦性流量分析。', + 'type' => 'array', + 'items' => [ + 'description' => '指定流量的过滤条件，Key-Value-Operator对象。', + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '起始时间戳，单位毫秒。未指定时默认查最近1小时。', + 'description' => '查询起始时间的毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1638239092000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间戳，单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。', + 'description' => '查询结束时间的毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1684373700099', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，'."\n" + .'asc：按正序排序。'."\n" + .'desc：按逆序排序。', + 'description' => '指定流量分析的排序方式'."\n" + .'- ASC：按正序排序。'."\n" + .'- DESC：按逆序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'Desc', + 'default' => 'Desc', + 'enum' => [ + 'Desc', + 'Asc', + ], + ], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => [ + 'title' => '展示排序靠前的数据。默认值：10。表示默认展示排序前 10 的数据。最大值：100。', + 'description' => '指定流量排序查询的条目数。'."\n" + ."\n" + .'支持自定义条数，当不传该字段时，在流量分析数据性能支持范围里，会进行用户指定条件下的全部流量数据排序分析。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言，枚举：zh-CN，en-US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + 'enum' => [ + 'zh-CN', + 'en-US', + ], + ], + ], + [ + '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<NtaNetworkRankingResponse>>', + 'description' => 'RpcResponse<ArrayList<NtaNetworkRankingResponse>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941', + ], + 'NisTrafficRankingId' => [ + 'description' => '返回本次流量排序分析的结果ID，需调用DescribeNisTrafficRanking接口获取最终分析结果。', + 'type' => 'string', + 'example' => 'task-6462a7b4c4a54b****', + ], + ], + ], + ], + ], + '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.', + ], + [ + 'errorCode' => 'MissingParam.TransitRouterId', + 'errorMessage' => 'When querying cross-region network connections, you need to specify the forwarding router ID.', + ], + [ + 'errorCode' => 'MissingParam.CbwpId', + 'errorMessage' => 'The CbwpId filtered during the query cannot be empty.', + ], + [ + 'errorCode' => 'ResourceNotFound.TrafficAnalyzerIdOneTupleDimension', + 'errorMessage' => 'The specified traffic analyzer does not have a corresponding one-element group storage configuration.', + ], + ], + 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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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**** | - |', + ], + 'DescribeNisTrafficRanking' => [ + 'summary' => '查询NIS流量排序分析结果', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREnetana5MCZ6K', + 'FEATUREnetanaOV20CD', + ], + ], + 'parameters' => [ + [ + 'name' => 'NisTrafficRankingId', + 'in' => 'query', + '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+', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，取值范围：1~100，默认值：20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '20', + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RpcResponse<QueryNtaNetworkRankingModel>', + 'description' => 'RpcResponse<QueryNtaNetworkRankingModel>', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'Direction' => [ + 'description' => '基于阿里云网络资源实例的流量方向。取值：'."\n" + .'- **in**：入流量。'."\n" + .'- **out**：出流量。', + 'type' => 'string', + '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*****', + ], + ], + ], + ], + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.NisTrafficRankingId', + 'errorMessage' => 'The specified parameter NisTrafficRankingId(%s) user does not have permission to operate.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound.NisTrafficRankingId', + 'errorMessage' => 'The specified parameter NisTrafficRankingId(%s) does not exist.', + ], + ], + ], + '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"}]', + '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 流日志 - 全部 VPC 流日志分析结果'."\n" + ."\n" + .'## 请求参数'."\n" + ."\n" + .'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| NisTrafficRankingId | string | 是 | 查询流量分析结果 ID。 | task-6462a7b4c4a54b**** | |'."\n" + .'| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 否 | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + ."\n" + .'## 返回参数'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| - | object | RpcResponse | | |'."\n" + .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | |'."\n" + .'| NisTrafficRankingId | string | 查询流量分析结果ID。 | task-7619ecb1db9148bab9f4 | |'."\n" + .'| Status | string | 任务运行状态。 | Complete | |'."\n" + .'| NextToken | string | 下一个查询开始的 Token。 | LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + .'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n" + .'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n" + ."\n" + .'### FlowRankingList 元素结构'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|--------------------|--------|--------------------------------------------------------------------------------------------|--------------------|----------|'."\n" + .'| RegionId | string | 流日志所在地域。 | cn-hangzhou | |'."\n" + .'| VpcId | string | 专有网络（VPC）ID。 | vpc-m5ec6i0h5xss*** | |'."\n" + .'| VSwitchId | string | 交换机 ID。 | vsw-2zeekevlh**** | |'."\n" + .'| NetworkInterfaceId | string | 弹性网卡 ID。 | eni-8vbf2jxul*** | |'."\n" + .'| EcsId | string | 管理节点 ECS 实例 ID。 | i-uf6i1zi6yhq7h*** | |'."\n" + .'| TrafficPath | string | 流量路径。 | all | |'."\n" + .'| Direction | string | 基于阿里云网络资源实例的流量方向。取值：<br>● in：入流量。<br>● out：出流量。 | in | -in / -out |'."\n" + .'| SourceIp | string | 源端 IP。<br>● 当统计二元组时，该字段才会返回。 | 47.92.245.*** | |'."\n" + .'| SourcePort | string | 源端端口。<br>● 当统计五元组时，该字段才会返回。 | 5432 | |'."\n" + .'| DestinationIp | string | 目的端 IP。<br>● 当统计二元组时，该字段才会返回。 | 192.168.***.0 | |'."\n" + .'| DestinationPort | string | 目的端端口。<br>● 当统计五元组时，该字段才会返回。 | 23 | |'."\n" + .'| Protocol | string | 网络协议。<br>● 当统计五元组时，该字段才会返回。 | TCP | |'."\n" + .'| Bytes | number | 带宽。 | 100 | |'."\n" + .'| Packets | number | 包数。 | 100 | |'."\n" + .'| RoundTripTime | number | TCP RTT。 | 2 | |'."\n" + .'| BytesRate | number | 流量占比。 | 0.2 | |'."\n" + ."\n\n" + .'---'."\n" + ."\n" + .'# VPC 流日志 - 公网 VPC 流日志分析结果'."\n" + ."\n" + .'## 请求参数'."\n" + ."\n" + .'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| NisTrafficRankingId | string | 是 | 查询流量分析结果 ID。 | task-6462a7b4c4a54b**** | |'."\n" + .'| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 否 | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + ."\n" + .'## 返回参数'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| - | object | RpcResponse | | |'."\n" + .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | |'."\n" + .'| NisTrafficRankingId | string | 查询流量分析结果ID。 | task-7619ecb1db9148bab9f4 | |'."\n" + .'| Status | string | 任务运行状态。 | Complete | |'."\n" + .'| NextToken | string | 下一个查询开始的 Token。 | LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + .'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n" + .'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n" + ."\n" + .'### FlowRankingList 元素结构'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|--------------------|--------|--------------------------------------------------------------------------------------------|------------------------|----------|'."\n" + .'| RegionId | string | 流日志所在地域。 | cn-hangzhou | |'."\n" + .'| VpcId | string | 专有网络（VPC）ID。 | vpc-m5ec6i0h5xss*** | |'."\n" + .'| VSwitchId | string | 交换机 ID。 | vsw-2zeekevlh**** | |'."\n" + .'| NetworkInterfaceId | string | 弹性网卡 ID。 | eni-8vbf2jxul*** | |'."\n" + .'| EcsId | string | 管理节点 ECS 实例 ID。 | i-uf6i1zi6yhq7h*** | |'."\n" + .'| TrafficPath | string | 流量路径。 | all | |'."\n" + .'| Direction | string | 基于阿里云网络资源实例的流量方向。取值：<br>● in：入流量。<br>● out：出流量。 | in | -in / -out |'."\n" + .'| SourceIp | string | 源端 IP。<br>● 当统计二元组时，该字段才会返回。 | 47.92.245.*** | |'."\n" + .'| SourcePort | string | 源端端口。<br>● 当统计五元组时，该字段才会返回。 | 5432 | |'."\n" + .'| DestinationIp | string | 目的端 IP。<br>● 当统计二元组时，该字段才会返回。 | 192.168.***.0 | |'."\n" + .'| DestinationPort | string | 目的端端口。<br>● 当统计五元组时，该字段才会返回。 | 23 | |'."\n" + .'| Protocol | string | 网络协议。<br>● 当统计五元组时，该字段才会返回。 | TCP | |'."\n" + .'| ClientCountry | string | 客户端所属的国家信息。 | 中国 | |'."\n" + .'| ClientProvince | string | 客户端所在省份。 | 香港特别行政区 | |'."\n" + .'| ClientCity | string | 客户端所在城市。 | 九龙 | |'."\n" + .'| ClientIsp | string | 网络服务提供商。 | 阿里云 | |'."\n" + .'| ClientAsn | string | 自治系统号码。 | 45102 | |'."\n" + .'| Bytes | number | 带宽。 | 100 | |'."\n" + .'| Packets | number | 包数。 | 100 | |'."\n" + .'| RoundTripTime | number | TCP RTT。 | 2 | |'."\n" + .'| BytesRate | number | 流量占比。 | 0.2 | |'."\n" + ."\n\n" + .'---'."\n" + ."\n" + .'# TR 流日志 - TR 跨地域场景分析结果'."\n" + ."\n" + .'## 请求参数'."\n" + ."\n" + .'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| NisTrafficRankingId | string | 是 | 查询流量分析结果 ID。 | task-6462a7b4c4a54b**** | |'."\n" + .'| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 否 | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + ."\n" + .'## 返回参数'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| - | object | RpcResponse | | |'."\n" + .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | |'."\n" + .'| NisTrafficRankingId | string | 查询流量分析结果ID。 | task-7619ecb1db9148bab9f4 | |'."\n" + .'| Status | string | 任务运行状态。 | Complete | |'."\n" + .'| NextToken | string | 下一个查询开始的 Token。 | LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + .'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n" + .'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n" + ."\n" + .'### FlowRankingList 元素结构'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------------|--------|--------------------------------------------------------------------------------------------|-------------------------|----------|'."\n" + .'| Direction | string | 基于阿里云网络资源实例的流量方向。取值：<br>● in：入流量。<br>● out：出流量。 | in | -in / -out |'."\n" + .'| SourceIp | string | 源端 IP。<br>● 当统计二元组时，该字段才会返回。 | 47.92.245.*** | |'."\n" + .'| SourcePort | string | 源端端口。<br>● 当统计五元组时，该字段才会返回。 | 5432 | |'."\n" + .'| DestinationIp | string | 目的端 IP。<br>● 当统计二元组时，该字段才会返回。 | 192.168.***.0 | |'."\n" + .'| DestinationPort | string | 目的端端口。<br>● 当统计五元组时，该字段才会返回。 | 23 | |'."\n" + .'| Protocol | string | 网络协议。<br>● 当统计五元组时，该字段才会返回。 | TCP | |'."\n" + .'| Dscp | string | 区分服务代码点。 | 0 | |'."\n" + .'| DestinationRegionNo | string | 目的端地域 ID。 | cn-hangzhou | |'."\n" + .'| SourceRegionNo | string | 源端地域ID。 | cn-hangzhou | |'."\n" + .'| TransitRouterAttachmentId | string | 网络实例连接 ID。 | tr-attach-bfde1cd4cj*** | |'."\n" + .'| TransitRouterId | string | 转发路由器实例 ID。 | tr-2zefvwy2fz3444*** | |'."\n" + .'| TransitRouterPairAttachmentId | string | 转发路由器对等连接实例 ID。 | tr-attach-okvj1cd4cjp*** | |'."\n" + .'| Bytes | number | 带宽。 | 100 | |'."\n" + .'| Packets | number | 包数。 | 100 | |'."\n" + .'| BytesRate | number | 流量占比。 | 0.2 | |'."\n" + .'| PacketsLostNoRoute | number | 无路由丢包数。 | 2 | |'."\n" + .'| PacketsLostBlackhole | number | 黑洞路由丢包数。 | 4 | |'."\n" + .'| PacketsLostTTLExpired | number | TTL 超时丢包数。 | 7 | |'."\n" + ."\n\n" + .'---'."\n" + ."\n" + .'# TR 流日志 - VPC 连接流量场景分析结果'."\n" + ."\n" + .'## 请求参数'."\n" + ."\n" + .'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| NisTrafficRankingId | string | 是 | 查询流量分析结果 ID。 | task-6462a7b4c4a54b**** | |'."\n" + .'| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 否 | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + ."\n" + .'## 返回参数'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| - | object | RpcResponse | | |'."\n" + .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | |'."\n" + .'| NisTrafficRankingId | string | 查询流量分析结果ID。 | task-7619ecb1db9148bab9f4 | |'."\n" + .'| Status | string | 任务运行状态。 | Complete | |'."\n" + .'| NextToken | string | 下一个查询开始的 Token。 | LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + .'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n" + .'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n" + ."\n" + .'### FlowRankingList 元素结构'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|----------------------------------------|--------|--------------------------------------------------------------------------------------------|---------------------------------|----------|'."\n" + .'| Direction | string | 基于阿里云网络资源实例的流量方向。取值：<br>● in：入流量。<br>● out：出流量。 | in | -in / -out |'."\n" + .'| SourceIp | string | 源端 IP。<br>● 当统计二元组时，该字段才会返回。 | 47.92.245.*** | |'."\n" + .'| SourcePort | string | 源端端口。<br>● 当统计五元组时，该字段才会返回。 | 5432 | |'."\n" + .'| DestinationIp | string | 目的端 IP。<br>● 当统计二元组时，该字段才会返回。 | 192.168.***.0 | |'."\n" + .'| DestinationPort | string | 目的端端口。<br>● 当统计五元组时，该字段才会返回。 | 23 | |'."\n" + .'| Protocol | string | 网络协议。<br>● 当统计五元组时，该字段才会返回。 | TCP | |'."\n" + .'| Dscp | string | 区分服务代码点。 | 0 | |'."\n" + .'| DestinationRegionNo | string | 目的端地域 ID。 | cn-hangzhou | |'."\n" + .'| SourceRegionNo | string | 源端地域ID。 | cn-hangzhou | |'."\n" + .'| TransitRouterAttachmentId | string | 网络实例连接 ID。 | tr-attach-bfde1cd4cj*** | |'."\n" + .'| TransitRouterId | string | 转发路由器实例 ID。 | tr-2zefvwy2fz3444*** | |'."\n" + .'| TransitRouterPairAttachmentId | string | 转发路由器对等连接实例 ID。 | tr-attach-okvj1cd4cjp*** | |'."\n" + .'| TransitRouterSourceResourceId | string | 源网络实例 ID。 | tr-attach-hvve1cd4cjpj*** | |'."\n" + .'| TransitRouterSourceAccountId | string | 源网络实例账号ID。 | 1906814138*** | |'."\n" + .'| TransitRouterSourceVSwitchId | string | 源TR ENI所在的vswitch ID。 | vsw-ikfdkevlhxpqxuz**** | |'."\n" + .'| TransitRouterSourceNetworkInterface | string | 源TR ENI。 | eni-8vbf2jxulma*** | |'."\n" + .'| TransitRouterSourceAvailableZone | string | 源AZ ID。 | cn-hangzhou-j | |'."\n" + .'| TransitRouterDestinationResourceId | string | 目的网络实例 ID。 | tr-attach-bfve1cd4cjp**** | |'."\n" + .'| TransitRouterDestinationAccountId | string | 目的网络实例账号ID。 | 1906814138*** | |'."\n" + .'| TransitRouterDestinationVSwitchId | string | 目的TR ENI所在的vswitch ID。 | vsw-ikfdkevlhxpqxuz**** | |'."\n" + .'| TransitRouterDestinationNetworkInterface | string | 目的TR ENI。 | eni-7kcf2jxulma*** | |'."\n" + .'| TransitRouterDestinationAvailableZone | string | 目的AZ ID。 | cn-hangzhou-j | |'."\n" + .'| Bytes | number | 带宽。 | 100 | |'."\n" + .'| Packets | number | 包数。 | 100 | |'."\n" + .'| BytesRate | number | 流量占比。 | 0.2 | |'."\n" + .'| PacketsLostNoRoute | number | 无路由丢包数。 | 2 | |'."\n" + .'| PacketsLostBlackhole | number | 黑洞路由丢包数。 | 4 | |'."\n" + .'| PacketsLostTTLExpired | number | TTL 超时丢包数。 | 7 | |'."\n" + ."\n\n" + .'---'."\n" + ."\n" + .'# TR 流日志 - VBR 访问流量场景分析结果'."\n" + ."\n" + .'## 请求参数'."\n" + ."\n" + .'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| NisTrafficRankingId | string | 是 | 查询流量分析结果 ID。 | task-6462a7b4c4a54b**** | |'."\n" + .'| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 否 | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + ."\n" + .'## 返回参数'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| - | object | RpcResponse | | |'."\n" + .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | |'."\n" + .'| NisTrafficRankingId | string | 查询流量分析结果ID。 | task-7619ecb1db9148bab9f4 | |'."\n" + .'| Status | string | 任务运行状态。 | Complete | |'."\n" + .'| NextToken | string | 下一个查询开始的 Token。 | LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + .'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n" + .'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n" + ."\n" + .'### FlowRankingList 元素结构'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|-----------------------------------|--------|--------------------------------------------------------------------------------------------|---------------------------------|----------|'."\n" + .'| Direction | string | 基于阿里云网络资源实例的流量方向。取值：<br>● in：入流量。<br>● out：出流量。 | in | -in / -out |'."\n" + .'| SourceIp | string | 源端 IP。<br>● 当统计二元组时，该字段才会返回。 | 47.92.245.*** | |'."\n" + .'| SourcePort | string | 源端端口。<br>● 当统计五元组时，该字段才会返回。 | 5432 | |'."\n" + .'| DestinationIp | string | 目的端 IP。<br>● 当统计二元组时，该字段才会返回。 | 192.168.***.0 | |'."\n" + .'| DestinationPort | string | 目的端端口。<br>● 当统计五元组时，该字段才会返回。 | 23 | |'."\n" + .'| Protocol | string | 网络协议。<br>● 当统计五元组时，该字段才会返回。 | TCP | |'."\n" + .'| Dscp | string | 区分服务代码点。 | 0 | |'."\n" + .'| DestinationRegionNo | string | 目的端地域 ID。 | cn-hangzhou | |'."\n" + .'| SourceRegionNo | string | 源端地域ID。 | cn-hangzhou | |'."\n" + .'| TransitRouterAttachmentId | string | 网络实例连接 ID。 | tr-attach-bfde1cd4cj*** | |'."\n" + .'| TransitRouterId | string | 转发路由器实例 ID。 | tr-2zefvwy2fz3444*** | |'."\n" + .'| TransitRouterPairAttachmentId | string | 转发路由器对等连接实例 ID。 | tr-attach-okvj1cd4cjp*** | |'."\n" + .'| TransitRouterSourceResourceId | string | 源网络实例 ID。 | tr-attach-hvve1cd4cjpj*** | |'."\n" + .'| TransitRouterSourceAccountId | string | 源网络实例账号ID。 | 1906814138*** | |'."\n" + .'| TransitRouterDestinationResourceId| string | 目的网络实例 ID。 | tr-attach-bfve1cd4cjp**** | |'."\n" + .'| TransitRouterDestinationAccountId | string | 目的网络实例账号ID。 | 1906814138*** | |'."\n" + .'| Bytes | number | 带宽。 | 100 | |'."\n" + .'| Packets | number | 包数。 | 100 | |'."\n" + .'| BytesRate | number | 流量占比。 | 0.2 | |'."\n" + .'| PacketsLostNoRoute | number | 无路由丢包数。 | 2 | |'."\n" + .'| PacketsLostBlackhole | number | 黑洞路由丢包数。 | 4 | |'."\n" + .'| PacketsLostTTLExpired | number | TTL 超时丢包数。 | 7 | |'."\n" + ."\n\n" + .'---'."\n" + ."\n" + .'# TR 流日志 - ECR 访问流量场景分析结果'."\n" + ."\n" + .'## 请求参数'."\n" + ."\n" + .'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| NisTrafficRankingId | string | 是 | 查询流量分析结果 ID。 | task-6462a7b4c4a54b**** | |'."\n" + .'| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 否 | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + ."\n" + .'## 返回参数'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| - | object | RpcResponse | | |'."\n" + .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | |'."\n" + .'| NisTrafficRankingId | string | 查询流量分析结果ID。 | task-7619ecb1db9148bab9f4 | |'."\n" + .'| Status | string | 任务运行状态。 | Complete | |'."\n" + .'| NextToken | string | 下一个查询开始的 Token。 | LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + .'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n" + .'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n" + ."\n" + .'### FlowRankingList 元素结构'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|-----------------------------------|--------|--------------------------------------------------------------------------------------------|---------------------------------|----------|'."\n" + .'| Direction | string | 基于阿里云网络资源实例的流量方向。取值：<br>● in：入流量。<br>● out：出流量。 | in | -in / -out |'."\n" + .'| SourceIp | string | 源端 IP。<br>● 当统计二元组时，该字段才会返回。 | 47.92.245.*** | |'."\n" + .'| SourcePort | string | 源端端口。<br>● 当统计五元组时，该字段才会返回。 | 5432 | |'."\n" + .'| DestinationIp | string | 目的端 IP。<br>● 当统计二元组时，该字段才会返回。 | 192.168.***.0 | |'."\n" + .'| DestinationPort | string | 目的端端口。<br>● 当统计五元组时，该字段才会返回。 | 23 | |'."\n" + .'| Protocol | string | 网络协议。<br>● 当统计五元组时，该字段才会返回。 | TCP | |'."\n" + .'| Dscp | string | 区分服务代码点。 | 0 | |'."\n" + .'| DestinationRegionNo | string | 目的端地域 ID。 | cn-hangzhou | |'."\n" + .'| SourceRegionNo | string | 源端地域ID。 | cn-hangzhou | |'."\n" + .'| TransitRouterAttachmentId | string | 网络实例连接 ID。 | tr-attach-bfde1cd4cj*** | |'."\n" + .'| TransitRouterId | string | 转发路由器实例 ID。 | tr-2zefvwy2fz3444*** | |'."\n" + .'| TransitRouterPairAttachmentId | string | 转发路由器对等连接实例 ID。 | tr-attach-okvj1cd4cjp*** | |'."\n" + .'| TransitRouterSourceResourceId | string | 源网络实例 ID。 | tr-attach-hvve1cd4cjpj*** | |'."\n" + .'| TransitRouterSourceAccountId | string | 源网络实例账号ID。 | 1906814138*** | |'."\n" + .'| TransitRouterDestinationResourceId| string | 目的网络实例 ID。 | tr-attach-bfve1cd4cjp**** | |'."\n" + .'| TransitRouterDestinationAccountId | string | 目的网络实例账号ID。 | 1906814138*** | |'."\n" + .'| Bytes | number | 带宽。 | 100 | |'."\n" + .'| Packets | number | 包数。 | 100 | |'."\n" + .'| BytesRate | number | 流量占比。 | 0.2 | |'."\n" + .'| PacketsLostNoRoute | number | 无路由丢包数。 | 2 | |'."\n" + .'| PacketsLostBlackhole | number | 黑洞路由丢包数。 | 4 | |'."\n" + .'| PacketsLostTTLExpired | number | TTL 超时丢包数。 | 7 | |'."\n" + ."\n\n" + .'---'."\n" + ."\n" + .'# TR 流日志 - VPN 访问流量场景分析结果'."\n" + ."\n" + .'## 请求参数'."\n" + ."\n" + .'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| NisTrafficRankingId | string | 是 | 查询流量分析结果 ID。 | task-6462a7b4c4a54b**** | |'."\n" + .'| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 否 | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + ."\n" + .'## 返回参数'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| - | object | RpcResponse | | |'."\n" + .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | |'."\n" + .'| NisTrafficRankingId | string | 查询流量分析结果ID。 | task-7619ecb1db9148bab9f4 | |'."\n" + .'| Status | string | 任务运行状态。 | Complete | |'."\n" + .'| NextToken | string | 下一个查询开始的 Token。 | LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + .'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n" + .'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n" + ."\n" + .'### FlowRankingList 元素结构'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|-----------------------------------|--------|--------------------------------------------------------------------------------------------|---------------------------------|----------|'."\n" + .'| Direction | string | 基于阿里云网络资源实例的流量方向。取值：<br>● in：入流量。<br>● out：出流量。 | in | -in / -out |'."\n" + .'| SourceIp | string | 源端 IP。<br>● 当统计二元组时，该字段才会返回。 | 47.92.245.*** | |'."\n" + .'| SourcePort | string | 源端端口。<br>● 当统计五元组时，该字段才会返回。 | 5432 | |'."\n" + .'| DestinationIp | string | 目的端 IP。<br>● 当统计二元组时，该字段才会返回。 | 192.168.***.0 | |'."\n" + .'| DestinationPort | string | 目的端端口。<br>● 当统计五元组时，该字段才会返回。 | 23 | |'."\n" + .'| Protocol | string | 网络协议。<br>● 当统计五元组时，该字段才会返回。 | TCP | |'."\n" + .'| Dscp | string | 区分服务代码点。 | 0 | |'."\n" + .'| DestinationRegionNo | string | 目的端地域 ID。 | cn-hangzhou | |'."\n" + .'| SourceRegionNo | string | 源端地域ID。 | cn-hangzhou | |'."\n" + .'| TransitRouterAttachmentId | string | 网络实例连接 ID。 | tr-attach-bfde1cd4cj*** | |'."\n" + .'| TransitRouterId | string | 转发路由器实例 ID。 | tr-2zefvwy2fz3444*** | |'."\n" + .'| TransitRouterPairAttachmentId | string | 转发路由器对等连接实例 ID。 | tr-attach-okvj1cd4cjp*** | |'."\n" + .'| TransitRouterSourceResourceId | string | 源网络实例 ID。 | tr-attach-hvve1cd4cjpj*** | |'."\n" + .'| TransitRouterSourceAccountId | string | 源网络实例账号ID。 | 1906814138*** | |'."\n" + .'| TransitRouterDestinationResourceId| string | 目的网络实例 ID。 | tr-attach-bfve1cd4cjp**** | |'."\n" + .'| TransitRouterDestinationAccountId | string | 目的网络实例账号ID。 | 1906814138*** | |'."\n" + .'| Bytes | number | 带宽。 | 100 | |'."\n" + .'| Packets | number | 包数。 | 100 | |'."\n" + .'| BytesRate | number | 流量占比。 | 0.2 | |'."\n" + .'| PacketsLostNoRoute | number | 无路由丢包数。 | 2 | |'."\n" + .'| PacketsLostBlackhole | number | 黑洞路由丢包数。 | 4 | |'."\n" + .'| PacketsLostTTLExpired | number | TTL 超时丢包数。 | 7 | |'."\n" + ."\n\n" + .'---'."\n" + ."\n" + .'# 共享带宽指标分析（CBWP 指标分析）'."\n" + ."\n" + .'## 请求参数'."\n" + ."\n" + .'| 名称 | 类型 | 必填 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------|----------------------------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| NisTrafficRankingId | string | 是 | 查询流量分析结果 ID。 | task-6462a7b4c4a54b**** | |'."\n" + .'| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 否 | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + ."\n" + .'## 返回参数'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|---------------------|---------|------------------------------------------------|---------------------------------------------|--------|'."\n" + .'| - | object | RpcResponse | | |'."\n" + .'| RequestId | string | 请求ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | |'."\n" + .'| NisTrafficRankingId | string | 查询流量分析结果ID。 | task-7619ecb1db9148bab9f4 | |'."\n" + .'| Status | string | 任务运行状态。 | Complete | |'."\n" + .'| NextToken | string | 下一个查询开始的 Token。 | LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+ | |'."\n" + .'| MaxResults | integer | 分页大小，取值范围：1~100，默认值：20。 | 20 | |'."\n" + .'| TotalCount | integer | 返回的条目总数。 | 72 | |'."\n" + .'| FlowRankingList | array | 查询流量分析结果列表。 | | |'."\n" + ."\n" + .'### FlowRankingList 元素结构'."\n" + ."\n" + .'| 名称 | 类型 | 描述 | 示例值 | 枚举值 |'."\n" + .'|--------------------|--------|----------------------------------------------------------------------------------------------------|-----------------------|------------------------------------------------------------------------|'."\n" + .'| Direction | string | 基于阿里云网络资源实例的流量方向。取值：<br>● in：入流量。<br>● out：出流量。 | in | -in / -out |'."\n" + .'| PublicIpAddress | string | 绑定的 EIP 的公网 IP 地址。 | 118.31.***.86 | |'."\n" + .'| InstanceId | string | 共享带宽所绑定的 EIP ID。 | eip-fb6wzjl9hm**** | |'."\n" + .'| BindingResourceType| string | EIP 所绑定的实例资源类型。<br>● 枚举有：<br> ○ EIP_ECS：云服务器 ECS 实例类型<br> ○ EIP_ENI：负载均衡 SLB 实例类型<br> ○ EIP_NAT：NAT 网关实例类型<br> ○ EIP_SLB：弹性网卡实例类型<br> ○ HAVIP_ECS：高可用虚拟 IP 类型<br> ○ TARGET_IP：IP 类型 | EIP_NAT | EIP_ECS / EIP_ENI / EIP_NAT / EIP_SLB / HAVIP_ECS / TARGET_IP |'."\n" + .'| BindingResourceId | string | EIP 所绑定的实例资源。 | ngw-ufwerthgvc***** | |'."\n" + .'| Bytes | number | 带宽。 | 100 | |'."\n" + .'| Packets | number | 包数。 | 100 | |', + ], + 'GetNisNetworkRanking' => [ + 'summary' => '支持通过排序算法和数据处理能力，对流经不同云网络资源的流量进行排名分析，以及对阿里云性能观测的探测指标进行排序，帮助您快速识别网络瓶颈、优化资源配置和提升整体网络效能。', + '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' => [ + '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" + .'- 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：内网探测质量数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'AccessInternetIpV4', + 'enum' => [ + 'AccessInternetIpV4', + 'AccessInternetIpV4Limited', + 'ElasticIP', + 'PublicIpEcs', + 'PublicIpClb', + 'NAT', + 'TR', + 'TRAttachment', + 'VBR', + 'GA', + 'InternetProbing', + 'IntranetProbing', + ], + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'title' => '基于阿里云资源的网络流量方向：'."\n" + .'in：流入资源的流量方向。'."\n" + .'out：流出资源的流量方向。'."\n" + .'跨域流量分析因只采集出向流量，所以传入in也以out处理。'."\n" + .'地域内性能观测和地域间性能观测因需在Filter内指定源或目的，所以可以任意指定Direction。', + 'description' => '基于阿里云资源的网络流量方向，取值：'."\n" + ."\n" + .'- in：流入资源的流量方向。'."\n" + .'- out：流出资源的流量方向。'."\n" + ."\n" + .'><notice>跨域流量分析因只采集出向流量，所以传入in也以out处理。'."\n" + .'地域内性能观测和地域间性能观测因需在Filter内指定源或目的，所以指定Direction无效。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'in', + 'enum' => [ + 'in', + 'out', + ], + ], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => [ + 'title' => '指定指标排名的维度，通用枚举如下：'."\n" + .' Tuple1：表示一元组，按资源端IP粒度聚合流量进行分析。'."\n" + .' Tuple2：表示二元组，按流的源目IP聚合进行分析。'."\n" + .' Tuple5：表示五元组，按流的源目IP、端口和协议进行分析。'."\n" + .' Protocol: 按协议类型维度进行聚合分析。'."\n" + .' SourcePort: 按源端口维度进行聚合分析。'."\n" + .' DestinationPort: 按目的端口维度进行聚合分析。'."\n" + .' InstanceId：按云上实例ID进行聚合分析。'."\n" + .'在公网流量分析场景，支持按互联网位置分布进行聚合排序，枚举值有：'."\n" + .' IpPair：按源和目的IP进行聚合分析。'."\n" + .' Country：按客户端国家维度进行聚合分析。'."\n" + .' City：按客户端城市维度进行聚合分析。'."\n" + .' ISP：按客户端运营商维度进行聚合分析。'."\n" + .' ASN：按客户端运营商ASN维度进行聚合分析。'."\n" + .' CityASN：按客户端城市和运营商维度进行聚合分析。'."\n" + .'在跨域流量分析场景，支持的枚举有：'."\n" + .' RegionPair：按云企业网联通的两端Region进行聚合分析。'."\n" + .'在NAT流量分析场景，支持的枚举有：'."\n" + .' IP：按ECS私网IP维度聚合分析。'."\n" + .'在公网探测场景，支持的枚举有：'."\n" + .' CountryIsp：按探测国家和探测运营商进行聚合分析。'."\n" + .' Province：按探测省份进行聚合分析。'."\n" + .' ProvinceIsp:按探测省份和探测运营商进行聚合分析。'."\n" + .'在云上内网探测场景，支持的枚举有：'."\n" + .' RegionPair：按探测地域对进行聚合分析。'."\n" + .' ZonePair：按某个地域内可用区对进行聚合分析。', + 'description' => '指定指标排名的维度，各场景取值：'."\n" + .' <br>完整流数据排名分析：'."\n" + ."\n" + .'- Tuple1：表示一元组，提供云端IP粒度完整流数据排名分析。 '."\n" + .'- Tuple2：表示二元组，提供源和目的IP粒度完整流数据排名分析。 '."\n" + .'- Tuple5：表示五元组，提供源和目的IP、端口、协议粒度完整流数据排名分析。'."\n" + ."\n" + .' 流量统计排名分析： '."\n" + ."\n" + .'- Protocol：按协议类型统计流量。'."\n" + .'- SourcePort：按源端口统计流量。'."\n" + .'- DestinationPort：按目的端口统计流量。'."\n" + .'- InstanceId：按云上资源ID统计流量。'."\n" + .'- IpPair：按源和目的IP对统计流量。'."\n" + .'- Country：按客户端国家来源统计流量。'."\n" + .'- Province：指定客户端省份来源统计流量。'."\n" + .'- City：按客户端城市来源统计流量。'."\n" + .'- ISP：按客户端运营商来源统计流量。'."\n" + .'- ASN：按客户端运营商ASN来源统计流量。'."\n" + .'- CityASN：按客户端城市和运营商ASN来源统计流量。'."\n" + .'- RegionPair：按云企业网跨地域访问统计流量。'."\n" + ."\n" + .'网络访问性能排名分析： '."\n" + ."\n" + .'- CountryIsp：指定Region访问互联网国家和运营商性能排名。 '."\n" + .'- Province：指定Region访问国内省份性能排名。'."\n" + .'- ProvinceIsp：指定Region访问国内省份和运营商性能排名。'."\n" + .'- RegionPair：阿里云跨地域互访性能排名。 '."\n" + .'- ZonePair：指定地域内可用区互访性能排名。', + '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', + ], + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + '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' => '指定公网流量进行排名的指标。大小写敏感，取值：'."\n" + .' '."\n" + .'- bps：每秒比特数。'."\n" + .'- pps：每秒包数。'."\n" + .'- ByteCount：累计字节数。'."\n" + .'- PacketCount：累计包数。'."\n" + .'- rtt：tcp协议建立连接时的往返延迟。'."\n" + .'- RetransmitRate：重传率。'."\n" + .'- RatelimitDropPps：限速丢包速率。'."\n" + .'- ActiveSessionCount：并发会话数。'."\n" + .'- NewSessionPerSecond：每秒新建会话数。', + 'type' => 'string', + 'required' => true, + 'example' => 'bps', + 'enum' => [ + 'rtt', + 'bps', + 'pps', + 'RetransmitRate', + 'ActiveSessionCount', + 'NewSessionPerSecond', + 'RatelimitDropPps', + 'ByteCount', + 'PacketCount', + ], + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '支持进一步指定流量的过滤条件，进行聚焦性流量分析。', + 'description' => '支持进一步指定流量的过滤条件，进行聚焦性流量分析。', + 'type' => 'array', + 'items' => [ + 'description' => '查询资源时的筛选条件列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '过滤条件的名字。', + 'type' => 'string', + 'required' => false, + 'example' => 'instanceId', + ], + 'Value' => [ + 'description' => '过滤条件的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'lb-2zxxxxz1d', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，'."\n" + .'asc：按正序排序。'."\n" + .'desc：按逆序排序。', + 'description' => '排序方式，默认desc，取值：'."\n" + ."\n" + .'- asc：按正序排序。'."\n" + .'- desc：按逆序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'default' => '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', + ], + ], + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>', + 'description' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'Data' => [ + 'description' => '云网络指标排名数据集合。', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + ], + '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"}]', + 'title' => '获取云网络指标排名', + 'description' => '支持分析场景： '."\n" + .'- 公网性能观测大盘场景'."\n" + ."\n" + .'- 跨可用区内网性能观测大盘场景'."\n" + ."\n" + .'- 跨地域内网性能观测大盘场景'."\n" + ."\n\n" + ."\n" + .'## 公网性能观测大盘场景'."\n" + ."\n" + .'**说明**'."\n" + ."\n" + .'不需要指定时间，查询最新探测结果'."\n" + ."\n" + .'### **请求参数**'."\n" + ."\n" + .'| **名称** | **类型** | **必填** | **描述** |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| RegionNo | string | 是 | 探测源所在阿里云地域。 |'."\n" + .'| ResourceType | string | 是 | 固定选择**InternetProbing**，表示查询公网性能观测排名。 |'."\n" + .'| Direction | string | 是 | 固定选择**out**，探测方向为出向流量。 |'."\n" + .'| GroupBy | string | 是 | 指定指标排名的维度，枚举如下： - **Country**：探测的国家。 - **CountryIsp**：探测的国家及运营商。 - **Province**：探测的省份。 - **ProvinceIsp**：探测的省份及运营商。 |'."\n" + .'| OrderBy | string | 是 | 指定进行排名的指标，取值：**rtt**，探测的往返延迟。 |'."\n" + .'| Filter | object\\[\\] | 否 | 过滤信息。 |'."\n" + .'| \\-Name | string | 否 | 过滤条件，取值：<br> - **Country**：探测的国家。<br> - **Province**：探测的省份。 <br>- **Isp**：探测的运营商。 |'."\n" + .'| \\-Value | string | 否 | 过滤条件对应的过滤值。 |'."\n" + ."\n" + .'### **返回参数**'."\n" + ."\n" + .'| **名称** | **类型** | **描述** |'."\n" + .'| --- | --- | --- |'."\n" + .'| RequestId | string | 请求ID。 |'."\n" + .'| Data | array | 云网络指标排名数据集合。 |'."\n" + .'| Country | string | 探测的国家。 |'."\n" + .'| Province | string | 探测的省份。 |'."\n" + .'| Isp | string | 探测的运营商。 |'."\n" + .'| RTT | double | 探测的往返延迟，单位ms。 |'."\n" + ."\n" + .'## 跨可用区内网性能观测大盘场景'."\n" + ."\n" + .'**说明**'."\n" + ."\n" + .'支持最大查询时间跨度为1小时。'."\n" + ."\n" + .'### **请求参数**'."\n" + ."\n" + .'| **名称** | **类型** | **必填** | **描述** |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| RegionNo | string | 是 | 阿里云地域。 |'."\n" + .'| ResourceType | string | 是 | 固定选择**IntranetProbing**，表示查询跨可用区性能观测排名。 |'."\n" + .'| Direction | string | 是 | 因需在**Filter**参数内指定探测源或目的，意味着方向已定，所以选择**in**或**out**无影响。 |'."\n" + .'| GroupBy | string | 是 | 指定指标排名的维度，取值：**ZonePair**，按可用区对进行聚合分析。 |'."\n" + .'| OrderBy | string | 是 | 指定进行排名的指标，取值：**rtt**，探测的往返延迟。 |'."\n" + .'| Filter | object\\[\\] | 是 | 过滤信息。 |'."\n" + .'| \\-Name | string | 是 | 过滤条件，取值：<br> - **SourceZone**：探测的源可用区。<br> - **DestinationZone**：探测的目的可用区。<br> **说明:** **SourceZone**和**DestinationZone**必须至少选择一个。 |'."\n" + .'| \\-Value | string | 是 | 过滤条件对应的过滤值。 |'."\n" + ."\n" + .'### **返回参数**'."\n" + ."\n" + .'| **名称** | **类型** | **描述** |'."\n" + .'| --- | --- | --- |'."\n" + .'| RequestId | string | 请求ID。 |'."\n" + .'| Data | array | 云网络指标排名数据集合。 |'."\n" + .'| SourceZone | string | 探测的源可用区。 |'."\n" + .'| DestinationZone | string | 探测的目的可用区。 |'."\n" + .'| RTT | double | 探测的往返延迟，单位ms。 |'."\n" + ."\n" + .'## **跨地域内网性能观测大盘场景**'."\n" + ."\n" + .'**说明**'."\n" + ."\n" + .'支持最大查询时间跨度为24小时，不指定时默认查询最近1小时。'."\n" + ."\n" + .'### **请求参数**'."\n" + ."\n" + .'| **名称** | **类型** | **必填** | **描述** |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| RegionNo | string | 是 | 阿里云地域。 |'."\n" + .'| ResourceType | string | 是 | 固定选择**IntranetProbing**，表示查询跨地域性能观测排名。 |'."\n" + .'| Direction | string | 是 | 探测方向，取值： - **in**：以RegionNo为目的的探测。 - **out**：以RegionNo为源的探测。 |'."\n" + .'| GroupBy | string | 是 | 指定指标排名的维度，取值：**RegionPair**，按地域区对进行聚合分析。 |'."\n" + .'| OrderBy | string | 是 | 指定进行排名的指标，取值：**rtt**，探测的往返延迟。 |'."\n" + .'| Filter | object\\[\\] | 否 | 过滤信息。 |'."\n" + .'| \\-Name | string | 否 | 过滤条件，取值：**DestinationRegionNo**，当**Direction**为**out**时，可指定此参数表示探测的目的地域。 |'."\n" + .'| \\-Value | string | 否 | 目的地域。 |'."\n" + ."\n" + .'### **返回参数**'."\n" + ."\n" + .'| **名称** | **类型** | **描述** |'."\n" + .'| --- | --- | --- |'."\n" + .'| RequestId | string | 请求ID。 |'."\n" + .'| Data | array | 云网络指标排名数据集合。 |'."\n" + .'| RegionNo | string | 探测的源地域。 |'."\n" + .'| DestinationRegionNo | string | 探测的目的地域。 |'."\n" + .'| RTT | double | 探测的往返延迟，单位ms。 |', + ], + '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' => '阿里巴巴', + ], + ], + [ + 'name' => 'OtherIsp', + 'in' => 'query', + 'schema' => [ + 'title' => '对端运营商，查看运营商情况时，请指定此参数。', + 'description' => '对端运营商。 '."\n" + .'> 查看运营商情况时，请指定此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '移动', + ], + ], + [ + 'name' => 'OtherCountry', + 'in' => 'query', + 'schema' => [ + 'title' => '对端国家。仅TupleType配置为5时，才需要配置该参数。', + 'description' => '对端国家。'."\n" + .'>仅**TupleType**配置为**2**或**5**时，才需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '中国', + ], + ], + [ + 'name' => 'OtherCity', + 'in' => 'query', + 'schema' => [ + 'title' => '对端城市。仅TupleType配置为5时，才需要配置该参数。', + 'description' => '对端城市。'."\n" + .'>仅**TupleType**配置为**2**或**5**时，才需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '杭州市', + ], + ], + [ + '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' => '移动', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + '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', + ], + ], + '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', + ], + ], + ], + ], + ], + '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转发实时数据排名', + ], + 'GetVbrFlowTopN' => [ + 'summary' => '调用GetVbrFlowTopN接口，获取混合云流量详情数据排名，覆盖一元组、二元组、五元组粒度，支持按流量、包数等指标排序。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '178894', + 'abilityTreeNodes' => [ + 'FEATUREnetanaOV20CD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。', + 'description' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1638239093000', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'title' => '对于当前地域或IP的流量方向。'."\n" + .'in：从IDC访问阿里云'."\n" + .'out：从阿里云访问IDC', + 'description' => '对于当前地域或IP的流量方向。'."\n" + .'- **in**：从IDC访问阿里云。'."\n" + .'- **out**：从阿里云访问IDC。', + 'type' => 'string', + 'required' => true, + 'example' => 'in', + 'enum' => [ + 'in', + 'out', + ], + ], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => [ + 'title' => '指定混合云流量排名的维度，大小写敏感。'."\n" + .'1Tuple：查询混合云流量中CEN、连接、VBR、IP维度的排名。'."\n" + .'2Tuple：查询混合云流量中两端IP维度的排名。'."\n" + .'5Tuple：查询混合云流量中两端IP、两端端口和协议维度的排名。'."\n" + .'CloudPort：查询混合云流量中云端端口的排名。'."\n" + .'OtherPort：查询混合云流量中IDC端端口的排名。'."\n" + .'Protocol：查询混合云流量中协议维度的排名。', + 'description' => '指定混合云流量排名的维度，大小写敏感，注意区分大小写。取值：'."\n" + .'- **1Tuple**：查询混合云流量中云企业网CEN（Cloud Enterprise Network）、连接、改为边界路由器VBR（Virtual Border Router）、IP维度的排名。'."\n" + .'- **2Tuple**：查询混合云流量中两端IP维度的排名。'."\n" + .'- **5Tuple**：查询混合云流量中两端IP、两端端口和协议维度的排名。'."\n" + .'- **CloudPort**：查询混合云流量中云端端口的排名。'."\n" + .'- **OtherPort**：查询混合云流量中IDC端端口的排名。'."\n" + .'- **Protocol**：查询混合云流量中协议维度的排名。', + 'type' => 'string', + 'required' => true, + 'example' => '1Tuple', + 'enum' => [ + '1Tuple', + '2Tuple', + '5Tuple', + 'CloudPort', + 'OtherPort', + 'Protocol', + ], + ], + ], + [ + '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' => [ + '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', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + '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****', + ], + ], + [ + 'name' => 'AttachmentId', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'CloudIp', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'CloudPort', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'AccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '子账号ID', + 'description' => '成员账号ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '某个成员账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '[\\"118639953821****\\"]', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'UseMultiAccount', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用多账号管理功能。默认值：**false**。表示不使用。 '."\n" + .'> 多账号管理功能默认不开放，如需使用，请联系商务经理申请使用权限。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RpcResponse<VbrFlowlogTopNResponse>', + 'description' => 'RpcResponse<ArrayList>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'VirtualBorderRouterFlowlogTopN' => [ + 'description' => '混合云流量详情排名列表。', + 'type' => 'array', + 'items' => [ + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RpcResponse<TrFlowlogTopNResponse>', + 'description' => 'RpcResponse<TrFlowlogTopNResponse>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B', + ], + 'TransitRouterFlowTopN' => [ + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => '获取跨域流量详情数据排名', + ], + 'CreateNetworkReachableAnalysis' => [ + 'summary' => '调用CreateNetworkReachableAnalysis接口，创建网络可达性分析任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + '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' => [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + 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' => [], + ], + ], + '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', + ], + ], + ], + ], + ], + '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条路径。', + ], + 'CreateAndAnalyzeNetworkPath' => [ + 'summary' => '调用CreateAndAnalyzeNetworkPath接口，发起网络可达性分析任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '178742', + 'abilityTreeNodes' => [ + 'FEATUREnetana59X9GB', + 'FEATUREnetana98CV3P', + 'FEATUREnetanaWZGUR4', + 'FEATUREnetanaDZZVCZ', + 'FEATUREnetana0CBIRP', + 'FEATUREnetanaJGHZ2X', + 'FEATUREnetanaRD137H', + 'FEATUREnetanaCAWHBE', + 'FEATUREnetana8JUW6E', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '源资源ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-uf62y8khhbkbdrp6****', + ], + ], + [ + 'name' => 'SourceIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'TargetIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '目的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.50.XX.XX', + ], + ], + [ + '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' => '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.', + ], + [ + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.NetworkPath', + 'errorMessage' => 'The current user has not activated NIS and is not authorized to use the path analysis interface.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + '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' => [ + 'description' => '网络分析路径集合。', + 'type' => 'array', + 'items' => [ + 'description' => '您可以通过调用[CreateNetworkPath](~~2366522~~)接口获取网络分析路径ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'np-10c31b7aca0e4486****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C4331873-C534-590F-A905-F66C53B88A47', + ], + '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.NetworkPathId', + 'errorMessage' => 'The parameter (%s) cannot be empty.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.NetworkPathId', + 'errorMessage' => 'The user does not have permission on the instance parameter (%s).', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound.NetworkPathId', + 'errorMessage' => 'The instance resource (%s) does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C4331873-C534-590F-A905-F66C53B88A47\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '删除网络分析路径', + ], + 'DeleteNetworkReachableAnalysis' => [ + 'summary' => '调用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' => [ + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + '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" + .'}', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + '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', + ], + ], + ], + [ + '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' => '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, + ], + ], + ], + '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.', + ], + [ + '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.', + ], + ], + 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.', + ], + ], + ], + '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" + ."\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**的单位。 |', + ], + '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****', + ], + ], + ], + ], + ], + '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' => '发起巡检任务', + ], + 'UpdateNisInspectionTask' => [ + 'summary' => '更新巡检任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '226556', + 'abilityTreeNodes' => [ + 'FEATUREnetanaS7CH2P', + ], + ], + 'parameters' => [ + [ + 'name' => 'InspectionTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '巡检任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ni-8svmpe0yso2bhzr7fh79', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务运行状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'Active', + 'enum' => [ + 'Inactive', + 'Active', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + 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' => '更新巡检任务', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => [ + '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' => [], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.InspectionTaskId', + 'errorMessage' => 'The specified InspectionTaskId(%s) is not found.', + ], + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [ + '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<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' => '默认', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => [], + ], + ], + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + ], + ], + ], + '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", + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + ], +]; |