diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/nis | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/nis')
| -rw-r--r-- | data/en_us/nis/2021-12-16/api-docs.php | 7058 |
1 files changed, 7058 insertions, 0 deletions
diff --git a/data/en_us/nis/2021-12-16/api-docs.php b/data/en_us/nis/2021-12-16/api-docs.php new file mode 100644 index 0000000..a0163a1 --- /dev/null +++ b/data/en_us/nis/2021-12-16/api-docs.php @@ -0,0 +1,7058 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'nis', + 'version' => '2021-12-16', + ], + 'directories' => [ + [ + 'id' => 391923, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'StartNisTrafficRanking', + 'DescribeNisTrafficRanking', + ], + ], + [ + 'id' => 391926, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetNisNetworkRanking', + 'GetInternetTuple', + 'GetNatTopN', + 'GetVbrFlowTopN', + 'GetTransitRouterFlowTopN', + ], + ], + [ + 'id' => 391932, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateNetworkReachableAnalysis', + 'CreateNetworkPath', + 'CreateAndAnalyzeNetworkPath', + 'DeleteNetworkPath', + 'DeleteNetworkReachableAnalysis', + 'GetNetworkReachableAnalysis', + ], + ], + [ + 'id' => 391939, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetNisNetworkMetrics', + ], + ], + [ + 'id' => 391941, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'StartNisInspectionTask', + 'UpdateNisInspectionTask', + 'DeleteNisInspectionTask', + 'ListNisInspectionTasks', + 'DescribeNisInspectionTask', + 'ListNisInspectionResourceType', + 'DescribeNisInspectionReportStatus', + 'DescribeNisInspectionReportSummary', + 'DescribeNisInspectionReportCheckItems', + 'DescribeNisInspectionRecommendationResources', + 'ListNisInspectionTaskReports', + 'DeleteNisInspectionReport', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'StartNisTrafficRanking' => [ + 'summary' => '获取云网络流量指标排名', + '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' => [ + 'description' => '', + 'example' => 'cn-shanghai', + 'required' => true, + 'title' => '资源所在地域。', + 'type' => 'string', + ], + ], + [ + 'name' => 'TrafficAnalyzerId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'nta-262****ca07f', + 'required' => true, + 'title' => '资源所在地域。', + 'type' => 'string', + ], + ], + [ + 'name' => 'TupleDimension', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'enumValueTitles' => [ + 'Tuple5' => '', + 'Tuple1' => '', + 'Tuple2' => '', + ], + 'example' => 'Tuple1', + 'required' => false, + 'title' => '资源所在地域。', + 'type' => 'string', + 'enum' => [ + 'Tuple1', + 'Tuple2', + 'Tuple5', + ], + ], + ], + [ + 'name' => 'TrafficScenario', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'VpcFlowLogAll', + 'required' => true, + '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: 内网探测数据。', + 'type' => 'string', + 'enum' => [ + 'VpcFlowLogAll', + 'VpcFlowLogInternet', + 'TRFlowLog', + 'CbwpMetric', + ], + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'Out', + 'required' => true, + 'title' => '基于阿里云资源的网络流量方向：'."\n" + .'in：流入资源的流量方向。'."\n" + .'out：流出资源的流量方向。'."\n" + .'跨域流量分析因只采集出向流量，所以传入in也以out处理。'."\n" + .'地域内性能观测和地域间性能观测因需在Filter内指定源或目的，所以可以任意指定Direction。', + 'type' => 'string', + 'enum' => [ + 'In', + 'Out', + ], + ], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => '["VpcId"]', + 'required' => false, + 'type' => 'string', + '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, + 'type' => 'array', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'Bytes', + 'required' => true, + 'title' => '指定公网流量进行排名的指标。大小写敏感。'."\n" + .' bps：每秒比特数。'."\n" + .' pps：每秒包数。'."\n" + .' ByteCount：累计字节数。'."\n" + .' PacketCount：累计包数。'."\n" + .'公网场景特有参数：'."\n" + .' rtt：tcp协议建立连接时的往返延迟。'."\n" + .' RetransmitRate：重传率。'."\n" + .'区域级限速场景特有参数：'."\n" + .' RatelimitDropPps：限速丢包速率。'."\n" + .'NAT场景特有参数：'."\n" + .' ActiveSessionCount：并发会话数。'."\n" + .' NewSessionPerSecond：每秒新建会话数。', + 'type' => 'string', + 'enum' => [ + 'Bytes', + 'Packets', + 'RoundTripTime', + 'PacketsLostNoRoute', + 'PacketsLostBlackhole', + 'PacketsLostTTLExpired', + ], + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'properties' => [ + 'Key' => [ + 'description' => '', + 'example' => 'FlowAction', + 'required' => false, + 'type' => 'string', + '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' => '', + 'items' => [ + 'description' => '', + 'example' => 'Accept', + 'required' => false, + 'type' => 'string', + ], + 'required' => false, + 'type' => 'array', + ], + 'Operator' => [ + 'description' => '', + 'enumValueTitles' => [ + 'not in' => 'not in', + 'in' => 'in', + 'like' => 'like', + ], + 'example' => 'in', + 'required' => false, + 'type' => 'string', + ], + ], + 'required' => false, + 'type' => 'object', + ], + 'required' => false, + 'title' => '支持进一步指定流量的过滤条件，进行聚焦性流量分析。', + 'type' => 'array', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '1638239092000', + 'format' => 'int64', + 'required' => true, + 'title' => '起始时间戳，单位毫秒。未指定时默认查最近1小时。', + 'type' => 'integer', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '1684373700099', + 'format' => 'int64', + 'required' => true, + 'title' => '结束时间戳，单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。', + 'type' => 'integer', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'Desc', + 'required' => false, + 'title' => '排序方式，'."\n" + .'asc：按正序排序。'."\n" + .'desc：按逆序排序。', + 'type' => 'string', + 'default' => 'Desc', + 'enum' => [ + 'Desc', + 'Asc', + ], + ], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '10', + 'format' => 'int32', + 'required' => false, + 'title' => '展示排序靠前的数据。默认值：10。表示默认展示排序前 10 的数据。最大值：100。', + 'type' => 'integer', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'zh-CN', + 'required' => false, + 'type' => 'string', + 'enum' => [ + 'zh-CN', + 'en-US', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '20', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '1', + 'required' => false, + 'type' => 'integer', + 'default' => '20', + ], + ], + [ + 'name' => 'StorageInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'enumValueTitles' => [ + 1 => '1', + 10 => '10', + 60 => '60', + 1440 => '1440', + ], + 'example' => '10', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'RpcResponse<ArrayList<NtaNetworkRankingResponse>>', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'example' => '4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941', + 'type' => 'string', + ], + 'NisTrafficRankingId' => [ + 'description' => '', + 'example' => 'task-6462a7b4c4a54b****', + 'type' => 'string', + ], + ], + 'title' => 'RpcResponse<ArrayList<NtaNetworkRankingResponse>>', + 'type' => 'object', + ], + ], + ], + '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"}]', + ], + 'DescribeNisTrafficRanking' => [ + 'summary' => '查询流量分析topN异步任务结果', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'task-6462a7b4c4a54b****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941', + ], + 'FlowRankingList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-m5ec6i0h5xss***', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2zeekevlh****', + ], + 'NetworkInterfaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'eni-8vbf2jxul***', + ], + 'EcsId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-uf6i1zi6yhq7h***', + ], + 'TrafficPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'all', + ], + 'Direction' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'in' => 'in', + 'out' => 'out', + ], + 'example' => 'in', + ], + 'SourceIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.92.245.***', + ], + 'SourcePort' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5432', + ], + 'DestinationIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.***.0', + ], + 'DestinationPort' => [ + 'description' => '', + 'type' => 'string', + 'example' => '23', + ], + 'Protocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'TCP', + ], + 'ClientCountry' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ClientProvince' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ClientCity' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ClientIsp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ClientAsn' => [ + 'description' => '', + 'type' => 'string', + 'example' => '45102', + ], + 'Bytes' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'Packets' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'RoundTripTime' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'BytesRate' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.2', + ], + 'PacketsLostNoRoute' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'PacketsLostBlackhole' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'PacketsLostTTLExpired' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '7', + ], + 'TransitRouterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tr-2zefvwy2fz3444***', + ], + 'TransitRouterAttachmentId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tr-attach-bfde1cd4cj***', + ], + 'Dscp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'DestinationRegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TransitRouterPairAttachmentId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tr-attach-okvj1cd4cjp***', + ], + 'TransitRouterSourceResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tr-attach-hvve1cd4cjpj***', + ], + 'TransitRouterSourceAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1906814138***', + ], + 'TransitRouterDestinationResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tr-attach-bfve1cd4cjp****', + ], + 'TransitRouterDestinationAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1906814138****', + ], + 'SourceRegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TransitRouterSourceAvailableZone' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'TransitRouterDestinationAvailableZone' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'TransitRouterDestinationVSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2zeekevlhxpqxu****', + ], + 'TransitRouterSourceVSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-ikfdkevlhxpqxuz****', + ], + 'TransitRouterSourceNetworkInterface' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'eni-8vbf2jxulma***', + ], + 'TransitRouterDestinationNetworkInterface' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'eni-fdbf2jxulm***', + ], + 'PublicIpAddress' => [ + 'description' => '', + 'type' => 'string', + 'example' => '118.31.***.86', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'eip-fb6wzjl9hm****', + ], + 'BindingResourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EIP_NAT', + ], + 'BindingResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-ufwerthgvc*****', + ], + ], + ], + ], + 'NisTrafficRankingId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'task-7619ecb1db9148bab9f4', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Complete', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'LoeJLhK0fsDqYoXkXieZUqB2vWnccJtVnsyKu9KxFFOMQxtV8XckOg5lk7F2bhC+', + ], + 'MaxResults' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AccessInternetIpV4', + 'enum' => [ + 'AccessInternetIpV4', + 'AccessInternetIpV4Limited', + 'ElasticIP', + 'PublicIpEcs', + 'PublicIpClb', + 'NAT', + 'TR', + 'TRAttachment', + 'VBR', + 'GA', + 'ECR', + 'VPC', + 'InternetProbing', + 'IntranetProbing', + ], + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'title' => '基于阿里云资源的网络流量方向：'."\n" + .'in：流入资源的流量方向。'."\n" + .'out：流出资源的流量方向。'."\n" + .'跨域流量分析因只采集出向流量，所以传入in也以out处理。'."\n" + .'地域内性能观测和地域间性能观测因需在Filter内指定源或目的，所以可以任意指定Direction。', + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Protocol', + 'enum' => [ + 'Tuple1', + 'Tuple2', + 'Tuple5', + 'Protocol', + 'SourcePort', + 'DestinationPort', + 'Country', + 'City', + 'ASN', + 'CityASN', + 'RegionPair', + 'InstanceId', + 'Ip', + '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' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '253402271999000', + 'minimum' => '0', + 'example' => '1684373600099', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间戳，单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的1小时。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '253402271999000', + 'minimum' => '0', + 'example' => '1684379093000', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，'."\n" + .'asc：按正序排序。'."\n" + .'desc：按逆序排序。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'default' => 'desc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => [ + 'title' => '展示排序靠前的数据。默认值：10。表示默认展示排序前 10 的数据。最大值：100。', + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionNo' => [ + 'title' => '阿里云地域ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'InstanceId' => [ + 'title' => '各场景下表示对应的云上资源实例ID，如跨域流量分析场景表示CenID，公网场景表示EipId、EcsId、ClbId等。', + 'description' => '', + 'type' => 'string', + 'example' => 'eip-sample*', + ], + 'BandwidthPackageId' => [ + 'title' => '带宽包实例ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'cbwp-sample*', + ], + 'SourceIp' => [ + 'title' => '源端IP。', + 'description' => '', + 'type' => 'string', + 'example' => '42.120.XX.XX', + ], + 'SourcePort' => [ + 'title' => '源端端口。', + 'description' => '', + 'type' => 'string', + 'example' => '443', + ], + 'SourceIsp' => [ + 'title' => '源端运营商。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'DestinationIp' => [ + 'title' => '目的端IP。', + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '120.238.XX.XX', + ], + 'DestinationRegionNo' => [ + 'title' => '目的端地域ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VbrId' => [ + 'title' => '边界路由器实例ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'vbr-sample*', + ], + 'AttachmentId' => [ + 'title' => '转发路由器链接ID。', + 'description' => '', + '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' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '1024', + ], + 'PacketCount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '66', + ], + 'RTT' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '23', + ], + 'RetransmitRate' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + ], + 'InBps' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'InPps' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'OutBps' => [ + 'description' => '', + '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"}]', + ], + 'GetInternetTuple' => [ + 'summary' => 'Queries the rankings of Internet traffic data in the form of 1-tuple, 2-tuple, or 5-tuple. Internet traffic data can be ranked by metrics such as traffic volumes and the number of packets.', + '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' => 'The ID of the region for which you want to query the Internet traffic.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TupleType', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的元组类型，枚举：1，2，5，分别表示一元组、二元组、五元组', + 'description' => 'The type of the tuple. Valid values:'."\n" + ."\n" + .'* **1**: 1-tuple'."\n" + .'* **2**: 2-tuple'."\n" + .'* **5**: 5-tuple', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'enum' => [ + '1', + '2', + '5', + ], + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询起始时间的毫秒时间戳。', + 'description' => 'The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '253402271999000', + 'minimum' => '0', + 'example' => '1684373600099', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询结束时间的毫秒时间戳。', + 'description' => 'The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '253402271999000', + 'minimum' => '0', + 'example' => '1684373700099', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'title' => '查询流量方向，取值：'."\n" + .'in：入云方向'."\n" + .'out：出云方向', + 'description' => 'The direction of the Internet traffic that you want to query. Valid values:'."\n" + ."\n" + .'* **in**: inbound'."\n" + .'* **out**: outbound', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'in' => 'in', + 'out' => 'out', + ], + 'example' => 'in', + 'enum' => [ + 'in', + 'out', + ], + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '根据什么指标排序，默认值为ByteCount，即按流量排序。', + 'description' => 'The metric for data ranking. Default value: **ByteCount**. This value indicates that Internet traffic data is ranked by traffic volume.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Rtt'."\n" + .'* ByteCount'."\n" + .'* PacketCount'."\n" + .'* RetransmitRate', + 'type' => 'string', + 'required' => false, + 'example' => 'ByteCount', + 'enum' => [ + 'Rtt', + 'ByteCount', + 'PacketCount', + 'RetransmitRate', + ], + ], + ], + [ + 'name' => 'CloudIp', + 'in' => 'query', + 'schema' => [ + 'title' => '五元组：云端IP。', + 'description' => 'The local IP address.', + 'type' => 'string', + 'required' => false, + 'example' => '112.74.XX.XX', + ], + ], + [ + 'name' => 'CloudPort', + 'in' => 'query', + 'schema' => [ + 'title' => '五元组：云端端口', + 'description' => 'The local port.'."\n" + ."\n" + .'> This parameter is required only if you set GroupBy to CloudPort.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '443', + ], + ], + [ + 'name' => 'OtherIp', + 'in' => 'query', + 'schema' => [ + 'title' => '五元组：对端IP', + 'description' => 'The remote IP address.'."\n" + ."\n" + .'> This parameter is required only when you set **TupleType** to **2** or **5**.', + 'type' => 'string', + 'required' => false, + 'example' => '122.112.XX.XX', + ], + ], + [ + 'name' => 'OtherPort', + 'in' => 'query', + 'schema' => [ + 'title' => '五元组：对端端口', + 'description' => 'The remote port.'."\n" + ."\n" + .'> This parameter is required only when you set **TupleType** to **5**.', + 'type' => 'string', + 'required' => false, + 'example' => '40002', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例Id', + 'description' => 'The ID of the Alibaba Cloud instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'eip-sample*', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'title' => '五元组：协议', + 'description' => 'The protocol number.'."\n" + ."\n" + .'> All protocols are supported. This parameter is required only when you set **TupleType** to **5**.', + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向：desc从大到小排序，asc从小到大排序。', + 'description' => 'The order in which instances are ranked by Internet traffic. Valid values:'."\n" + ."\n" + .'* **desc**: the descending order'."\n" + .'* **asc**: the ascending order', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + ], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => [ + 'title' => '默认10', + 'description' => 'Specifies top-N traffic data to display. Default value: **10**. This value specifies to display top-10 traffic data by default. Max value: **100**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'CloudIsp', + 'in' => 'query', + 'schema' => [ + 'title' => '云端运营商。', + 'description' => 'The local Internet service provider (ISP).'."\n" + ."\n" + .'> In most cases, the value is Alibaba or Alibaba Cloud.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Alibaba', + ], + ], + [ + 'name' => 'OtherIsp', + 'in' => 'query', + 'schema' => [ + 'title' => '对端运营商，查看运营商情况时，请指定此参数。', + 'description' => 'The remote ISP.'."\n" + ."\n" + .'> This parameter is required if you want to view the information about the remote ISP.', + 'type' => 'string', + 'required' => false, + 'example' => 'China Mobile', + ], + ], + [ + 'name' => 'OtherCountry', + 'in' => 'query', + 'schema' => [ + 'title' => '对端国家。仅TupleType配置为5时，才需要配置该参数。', + 'description' => 'The remote country.'."\n" + ."\n" + .'> This parameter is required only if you set **TupleType** to **2** or **5**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'China', + ], + ], + [ + 'name' => 'OtherCity', + 'in' => 'query', + 'schema' => [ + 'title' => '对端城市。仅TupleType配置为5时，才需要配置该参数。', + 'description' => 'The remote city.'."\n" + ."\n" + .'> This parameter is required only if you set **TupleType** to **2** or **5**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Hangzhou', + ], + ], + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The instance IDs for filtering.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance ID for filtering.', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"eip-sample*\\"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CloudIpList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The local IP addresses for filtering.', + 'type' => 'array', + 'items' => [ + 'description' => 'The local IP address for filtering.', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"103.202.XX.XX\\"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'UseMultiAccount', + 'in' => 'query', + 'schema' => [ + 'title' => '是否使用多账号访问模式', + 'description' => 'Specifies whether to enable the multi-account management feature. Default value: **false**. This value specifies that the multi-account management feature is disabled.'."\n" + ."\n" + .'> By default, the multi-account management feature is not available. If you want to use this feature, contact your account manager to apply for permissions.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AccountIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '显式传递子账号ID', + 'description' => 'The IDs of member accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the member account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '[123]', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RpcResponse<ArrayList<PublicFlowTupleModel>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B', + ], + 'Data' => [ + 'description' => 'The ranking result of Internet traffic data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ranking result of instances by Internet traffic.', + 'type' => 'object', + 'properties' => [ + 'BeginTime' => [ + 'title' => '数据时间点', + 'description' => 'The beginning of the time range that you queried. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'string', + 'example' => '1684373600099', + ], + 'Direction' => [ + 'title' => '数据方向', + 'description' => 'The direction of Internet traffic. Valid values:'."\n" + ."\n" + .'* **in**: inbound'."\n" + .'* **out**: outbound'."\n", + 'type' => 'string', + 'example' => 'in', + ], + 'InstanceId' => [ + 'title' => '阿里侧IP归属的实例。', + 'description' => 'The ID of the instance to which the local IP address belongs.'."\n", + 'type' => 'string', + 'example' => 'eip-sample*', + ], + 'AccessRegion' => [ + 'title' => 'InstanceId为AnyCastEip时，流量进入阿里云的Pop点。', + 'description' => 'The access point of Alibaba Cloud.'."\n" + ."\n" + .'> This parameter is valid only if you set **InstanceId** to the instance ID of an Anycast elastic IP address (EIP).'."\n", + 'type' => 'string', + 'example' => 'cn-hongkong-pop', + ], + 'CloudIp' => [ + 'title' => '五元组云端IP', + 'description' => 'The local IP address.'."\n", + 'type' => 'string', + 'example' => '112.74.XX.XX', + ], + 'CloudPort' => [ + 'title' => '五元组云端端口', + 'description' => 'The local port.'."\n", + 'type' => 'string', + 'example' => '443', + ], + 'OtherIp' => [ + 'title' => '五元组对端IP', + 'description' => 'The remote IP address.'."\n", + 'type' => 'string', + 'example' => '122.112.XX.XX', + ], + 'OtherPort' => [ + 'title' => '五元组对端端口', + 'description' => 'The remote port.'."\n", + 'type' => 'string', + 'example' => '40002', + ], + 'Protocol' => [ + 'title' => '五元组协议', + 'description' => 'The protocol number.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'CloudCountry' => [ + 'title' => '云端国家/地区', + 'description' => 'The local country or region.'."\n", + 'type' => 'string', + 'example' => 'China', + ], + 'CloudProvince' => [ + 'title' => '云端省份', + 'description' => 'The local province.'."\n", + 'type' => 'string', + 'example' => 'Jiangsu', + ], + 'CloudCity' => [ + 'title' => '云端城市', + 'description' => 'The local city.'."\n", + 'type' => 'string', + 'example' => 'Nanjing', + ], + 'CloudIsp' => [ + 'title' => '云端ISP', + 'description' => 'The local ISP.'."\n", + 'type' => 'string', + 'example' => 'China Mobile', + ], + 'CloudProduct' => [ + 'title' => '云端ISP', + 'description' => 'The service code of the instance to which the local IP address belongs.'."\n", + 'type' => 'string', + 'example' => 'EIP', + ], + 'OtherCountry' => [ + 'title' => '对端国家/地区', + 'description' => 'The remote country or region.'."\n", + 'type' => 'string', + 'example' => 'United States', + ], + 'OtherProvince' => [ + 'title' => '对端省份', + 'description' => 'The remote province. In most cases, this parameter is empty if you set **OtherCountry** to a country except China.'."\n", + 'type' => 'string', + 'example' => 'Texas', + ], + 'OtherCity' => [ + 'title' => '对端城市', + 'description' => 'The remote city. In most cases, this parameter is empty if you set **OtherCountry** to a country except China.'."\n", + 'type' => 'string', + 'example' => 'Austin', + ], + 'OtherIsp' => [ + 'title' => '对端ISP', + 'description' => 'The remote ISP.'."\n", + 'type' => 'string', + 'example' => 'amazon.com', + ], + 'OtherProduct' => [ + 'title' => '对端ISP', + 'description' => 'The service code of the instance to which the remote IP address belongs. If the IP address is not on the cloud, this parameter is empty.'."\n", + 'type' => 'string', + 'example' => 'ECS', + ], + 'Rtt' => [ + 'title' => 'RTT 指标(us)', + 'description' => 'The round-trip time (RTT). Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '10000', + ], + 'ByteCount' => [ + 'title' => '流量指标(byte)', + 'description' => 'The traffic volume. Unit: bytes.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '88', + ], + 'PacketCount' => [ + 'title' => '包数指标(个)', + 'description' => 'The number of packets.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '66', + ], + 'OutOrderCount' => [ + 'title' => '包数指标(个)', + 'description' => 'The number of disordered packets.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'InByteCount' => [ + 'title' => '包数指标(个)', + 'description' => 'The inbound traffic volume. Unit: bytes.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '88', + ], + 'OutByteCount' => [ + 'title' => '包数指标(个)', + 'description' => 'The outbound traffic volume. Unit: bytes.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '66', + ], + 'InPacketCount' => [ + 'title' => '入方向包数指标(个)', + 'description' => 'The number of inbound packets.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '33', + ], + 'OutPacketCount' => [ + 'title' => '出方向包数指标(个)', + 'description' => 'The number of outbound packets.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '22', + ], + 'InOutOrderCount' => [ + 'title' => '入方向乱序包数指标(个)', + 'description' => 'The number of inbound disordered packets.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'OutOutOrderCount' => [ + 'title' => '出方向乱序包数指标(个)', + 'description' => 'The number of outbound disordered packets.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'InRetranCount' => [ + 'title' => '入方向重传包数指标(个)', + 'description' => 'The number of inbound repeated packets.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'OutRetranCount' => [ + 'title' => '出方向重传包数指标(个)', + 'description' => 'The number of outbound repeated packets.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'RetransmitRate' => [ + 'title' => '重传率。', + 'description' => 'The retransmission rate of TCP packets.'."\n", + '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' => 'GetInternetTuple', + ], + 'GetNatTopN' => [ + 'summary' => 'Queries the real-time SNAT performance ranking of a NAT gateway.', + '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' => 'The ID of the region in which the NAT gateway is deployed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Nat网关实例ID', + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-sample***', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询指标的开始毫秒时间戳。如果不指定EndTime，则查询的是BeginTime指定的时间点的TopN情况。', + 'description' => 'The beginning of the time range to query in milliseconds. If you do not specify **EndTime**, the point in time specified by **BeginTime** is queried.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1638239092000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询指标的结束毫秒时间戳。BeginTime和EndTime的最大差距不能超过24小时，即86400000。', + 'description' => 'The end of the time range to query in milliseconds. The time range specified by **BeginTime** and **EndTime** cannot exceed **86400000** milliseconds (24 hours).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1638239093000', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '按哪个指标倒叙排序取TopN。', + 'description' => 'The metric that is used for real-time SNAT performance ranking. Valid values:'."\n" + ."\n" + .'* **InBps**: inbound data transfer. Unit: bit/s.'."\n" + .'* **OutBps**: outbound data transfer. Unit: bit/s.'."\n" + .'* **InPps**: inbound packet forwarding rate. Unit: packets per second.'."\n" + .'* **OutPps**: outbound packet forwarding rate. Unit: packets per second.'."\n" + .'* **NewSessionPerSecond**: new connection creation rate. Unit: connections per second.'."\n" + .'* **ActiveSessionCount**: number of concurrent connections. Unit: connections.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'InBps', + ], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => [ + 'title' => '取最大多少条数据，默认10，最大100。', + 'description' => 'The number of entries to return for real-time SNAT performance ranking. Valid values: **1 to 100**. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'title' => '查指定ip的指标，此时无需传topN和orderBy', + 'description' => 'Query ranking statistics for a specific IP address. If you specify this parameter, you do not need to specify **TopN** or **OrderBy**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.156.101', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '77C512B5-12f3-f892-BD94-88A98271C1A0', + ], + 'NatGatewayTopN' => [ + 'title' => '以下指标取BeginTime到EndTime的均值。', + 'description' => 'An array of statistics about real-time SNAT performance ranking.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The fields that are included in the statistics about real-time SNAT performance ranking. The values of the fields are averages within the time range from **BeginTime** to **EndTime**.'."\n", + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'title' => 'IP地址', + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '192.168.156.101', + ], + 'InBps' => [ + 'title' => '入方向流量，单位bps', + 'description' => 'The inbound data transfer. Unit: bit/s.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'OutBps' => [ + 'title' => '出方向流量，单位bps', + 'description' => 'The outbound data transfer. Unit: bit/s.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'InPps' => [ + 'title' => '入方向包速率（个/秒）', + 'description' => 'The inbound packet forwarding rate. Unit: packets per second.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'OutPps' => [ + 'title' => '出方向包速率', + 'description' => 'The outbound packet forwarding rate. Unit: packets per second.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'InFlowPerMinute' => [ + 'description' => 'This field is reserved and not in use.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'OutFlowPerMinute' => [ + 'description' => 'This field is reserved and not in use.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'NewSessionPerSecond' => [ + 'title' => '新建连接数（个/秒）', + 'description' => 'The new connection creation rate. Unit: connections per second.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'ActiveSessionCount' => [ + 'title' => '并发连接数（个）', + 'description' => 'The number of concurrent connections. Unit: connections.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + ], + ], + ], + 'IsTopNOpen' => [ + 'title' => '该实例是否开通TopN功能', + 'description' => 'Indicates whether Network Intelligence Service (NIS) is activated. The NatGatewayTopN parameter returns an empty array when NIS is not activated.'."\n" + ."\n" + .'* **true**: activated'."\n" + .'* **false**: not activated'."\n", + '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' => 'GetNatTopN', + ], + 'GetVbrFlowTopN' => [ + 'summary' => 'Queries the rankings of hybrid cloud traffic data in the form of 1-tuple, 2-tuple, or 5-tuple. Hybrid cloud traffic data can be ranked by metrics such as traffic volumes and the number of packets.', + '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' => 'The local region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询起始时间的毫秒时间戳。最大支持查24小时跨度的数据。', + 'description' => 'The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. The maximum time range that you can query is 24 hours.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1638239092000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。', + 'description' => 'The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. The maximum time range that you can query is 24 hours.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1638239093000', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'title' => '对于当前地域或IP的流量方向。'."\n" + .'in：从IDC访问阿里云'."\n" + .'out：从阿里云访问IDC', + 'description' => 'The direction of the hybrid cloud traffic in the local regions or for the local IP addresses. Valid values:'."\n" + ."\n" + .'* **in**: traffic from a data center to Alibaba Cloud'."\n" + .'* **out**: traffic from Alibaba Cloud to a data center'."\n", + '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' => 'The dimension for ranking hybrid cloud traffic data. The value of this parameter is case-sensitive. Valid values:'."\n" + ."\n" + .'* **1Tuple**: queries the rankings of hybrid cloud traffic data for the Cloud Enterprise Network (CEN) instances, CEN connections, virtual border routers (VBRs), and IP addresses.'."\n" + .'* **2Tuple**: queries the rankings of hybrid cloud traffic data for the local and remote IP addresses.'."\n" + .'* **5Tuple**: queries the rankings of hybrid cloud traffic data for the local and remote IP addresses, local and remote ports, and protocols.'."\n" + .'* **CloudPort**: queries the rankings of hybrid cloud traffic data for the local ports.'."\n" + .'* **OtherPort**: queries the rankings of hybrid cloud traffic data for the remote ports.'."\n" + .'* **Protocol**: queries the rankings of hybrid cloud traffic data for the protocols.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1Tuple', + 'enum' => [ + '1Tuple', + '2Tuple', + '5Tuple', + 'CloudPort', + 'OtherPort', + 'Protocol', + ], + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '按哪个指标倒序排序', + 'description' => 'The metric for ranking hybrid cloud traffic data. Default value: Bytes. This value specifies that hybrid cloud traffic data is ranked by traffic volumes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Bytes', + 'default' => 'Bytes', + 'enum' => [ + 'Bytes', + 'Packets', + ], + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式。'."\n" + .'desc：降序'."\n" + .'asc：升序', + 'description' => 'The order for ranking hybrid cloud traffic data. Valid values:'."\n" + ."\n" + .'* **desc**: descending order'."\n" + .'* **asc**: ascending order'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'default' => 'desc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => [ + 'title' => '取最大多少条数据，默认10，最大100。', + 'description' => 'Specifies top-N traffic data to display. Default value: **10**. This value specifies that top-10 traffic data is displayed by default. Maximum value: **100**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'title' => 'CEN实例ID。', + 'description' => 'The CEN instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cen-ia8kw1zjv4hyal****', + ], + ], + [ + 'name' => 'VirtualBorderRouterId', + 'in' => 'query', + 'schema' => [ + 'title' => '专线ID。', + 'description' => 'The ID of the VBR that is associated with the Express Connect circuit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vbr-k1atj46citwuek42j****', + ], + ], + [ + 'name' => 'AttachmentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'CEN的连接ID。', + 'description' => 'The CEN connection ID.'."\n", + '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' => 'The protocol number.'."\n" + ."\n" + .'> All protocols are supported. This parameter is required only if you set **GroupBy** to **5Tuple** or **Protocol**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'CloudIp', + 'in' => 'query', + 'schema' => [ + 'title' => '云端IP', + 'description' => 'The local IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '112.74.XX.XX', + ], + ], + [ + 'name' => 'OtherIp', + 'in' => 'query', + 'schema' => [ + 'title' => 'IDC侧IP', + 'description' => 'The remote IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '122.112.XX.XX', + ], + ], + [ + 'name' => 'CloudPort', + 'in' => 'query', + 'schema' => [ + 'title' => '云端端口号', + 'description' => 'The local port.'."\n" + ."\n" + .'> This parameter is required only if you set **GroupBy** to **CloudPort**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '443', + ], + ], + [ + 'name' => 'OtherPort', + 'in' => 'query', + 'schema' => [ + 'title' => 'IDC侧端口号', + 'description' => 'The remote port.'."\n" + ."\n" + .'> This parameter is required only if you set **GroupBy** to **OtherPort**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '40002', + ], + ], + [ + 'name' => 'AccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '子账号ID', + 'description' => 'The IDs of member accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the member account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '[\\"118639953821****\\"]', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'UseMultiAccount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the multi-account management feature. Default value: **false**. This value specifies that the multi-account management feature is disabled.'."\n" + ."\n" + .'> By default, the multi-account management feature is not available. If you want to use this feature, contact your account manager to apply for permissions.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RpcResponse<VbrFlowlogTopNResponse>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'VirtualBorderRouterFlowlogTopN' => [ + 'description' => 'The ranking result of hybrid cloud traffic data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CloudRegion' => [ + 'title' => 'region', + 'description' => 'The local region where the local IP address resides.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'CloudIp' => [ + 'title' => '源IP', + 'description' => 'The local IP address.'."\n", + 'type' => 'string', + 'example' => '120.24.X.X', + ], + 'OtherIp' => [ + 'title' => '目的IP', + 'description' => 'The remote IP address.'."\n", + 'type' => 'string', + 'example' => '222.85.X.X', + ], + 'CloudPort' => [ + 'title' => '源端口', + 'description' => 'The local port.'."\n", + 'type' => 'string', + 'example' => '80', + ], + 'OtherPort' => [ + 'title' => '目的端口', + 'description' => 'The remote port.'."\n", + 'type' => 'string', + 'example' => '10965', + ], + 'Protocol' => [ + 'title' => '协议', + 'description' => 'The protocol number.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'AttachmentId' => [ + 'title' => 'attachmentId', + 'description' => 'The CEN connection ID.'."\n", + 'type' => 'string', + 'example' => 'tr-attach-u6v1j3jre0fe9h****', + ], + 'VirtualBorderRouterId' => [ + 'title' => '专线Id', + 'description' => 'The ID of the VBR that is associated with the Express Connect circuit.'."\n", + 'type' => 'string', + 'example' => 'vbr-k1atj46citwuek42j****', + ], + 'Bytes' => [ + 'description' => 'The total volume of traffic in the specified time range.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '108', + ], + 'Packets' => [ + 'description' => 'The total number of packets in the specified time range.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '66', + ], + 'AccountId' => [ + 'title' => '子账号ID', + 'description' => 'The account ID.'."\n", + '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' => 'GetVbrFlowTopN', + ], + 'GetTransitRouterFlowTopN' => [ + 'summary' => 'Queries the rankings of inter-region traffic data in the form of 1-tuple, 2-tuple, or 5-tuple. Inter-region traffic data can be ranked by metrics such as traffic volumes and the number of packets.', + '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' => 'The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. The maximum time range that you can query is 24 hours.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1684373600099', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询结束时间的毫秒时间戳。最大支持查24小时跨度的数据。', + 'description' => 'The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. The maximum time range that you can query is 24 hours.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1638239093000', + ], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => [ + 'title' => '取最大多少条数据，默认10，最大100。', + 'description' => 'Specifies the maximum number of data entries to display. Default value: **10**. Maximum value: 100.'."\n", + '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' => 'The direction of the inter-region traffic in the local regions or for the local IP addresses. Valid values:'."\n" + ."\n" + .'* **in**: inbound traffic'."\n" + .'* **out**: outbound traffic'."\n", + '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' => 'The dimension for ranking inter-region traffic data. The value of this parameter is case-sensitive. Valid values:'."\n" + ."\n" + .'* **1Tuple**: queries the rankings of inter-region traffic data for the local regions, Cloud Enterprise Network (CEN) instances, and IP addresses.'."\n" + .'* **2Tuple**: queries the rankings of inter-region traffic data for the local and remote regions, and the local and remote IP addresses.'."\n" + .'* **5Tuple**: queries the rankings of inter-region traffic data for the local and remote IP addresses, local and remote ports, and protocols.'."\n" + .'* **Cen**: queries the rankings of inter-region traffic data for CEN instances.'."\n" + .'* **RegionPair**: queries the rankings of inter-region traffic data for the local and remote regions.'."\n" + .'* **Port**: queries the rankings of inter-region traffic data for the local and remote ports.'."\n" + .'* **Protocol**: queries the rankings of inter-region traffic data for the protocols.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1Tuple', + 'enum' => [ + '1Tuple', + '2Tuple', + '5Tuple', + 'Cen', + 'RegionPair', + 'Port', + 'Protocol', + ], + ], + ], + [ + 'name' => 'ThisRegion', + 'in' => 'query', + 'schema' => [ + 'title' => '当前地域。', + 'description' => 'The local region where the **local IP address** resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ThisIp', + 'in' => 'query', + 'schema' => [ + 'title' => '当前IP地址。', + 'description' => 'The local IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.8.XX.XX', + ], + ], + [ + 'name' => 'ThisPort', + 'in' => 'query', + 'schema' => [ + 'title' => '当前端口。', + 'description' => 'The local port.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'OtherRegion', + 'in' => 'query', + 'schema' => [ + 'title' => '对端地域。', + 'description' => 'The remote region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + ], + ], + [ + 'name' => 'OtherIp', + 'in' => 'query', + 'schema' => [ + 'title' => '对端IP地址。', + 'description' => 'The remote IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '122.112.XX.XX', + ], + ], + [ + 'name' => 'OtherPort', + 'in' => 'query', + 'schema' => [ + 'title' => '对端端口。', + 'description' => 'The remote port.'."\n", + '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' => 'The protocol number.'."\n" + ."\n" + .'> All protocols are supported. This parameter is required only if you set **GroupBy** to **5Tuple** or **Protocol**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '按哪个指标排序。', + 'description' => 'The metric for ranking inter-region traffic data. Default value: Bytes. This value specifies that inter-region traffic data is ranked by traffic volume.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Bytes', + 'default' => 'Bytes', + 'enum' => [ + 'Bytes', + 'Packets', + ], + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式。'."\n" + .'desc：降序'."\n" + .'asc：升序', + 'description' => 'The order for ranking inter-region traffic data. Valid values:'."\n" + ."\n" + .'* **desc**: descending order'."\n" + .'* **asc**: ascending order'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'title' => 'CEN实例ID。', + 'description' => 'The CEN instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cen-ia8kw1zjv4hyal****', + ], + ], + [ + 'name' => 'BandwithPackageId', + 'in' => 'query', + 'schema' => [ + 'title' => 'CEN带宽包ID。', + 'description' => 'The ID of the CEN bandwidth plan.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cenbwp-ia8kw1zjv4hyal*****', + ], + ], + [ + 'name' => 'AccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the member accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the member account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '[\\"118639953821xxxx\\"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'UseMultiAccount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the multi-account management feature. Default value: **false**. This value specifies that the multi-account management feature is disabled.'."\n" + ."\n" + .'> By default, the multi-account management feature is not available. If you want to use this feature, contact your account manager to apply for permissions.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RpcResponse<TrFlowlogTopNResponse>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B', + ], + 'TransitRouterFlowTopN' => [ + 'description' => 'The ranking result of inter-region traffic data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'title' => '账号ID。', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => '118639953821xxxx', + ], + 'CenId' => [ + 'title' => '跨域ID', + 'description' => 'The CEN instance ID.'."\n", + 'type' => 'string', + 'example' => 'cen-ia8kw1zjv4hyal****', + ], + 'ThisRegion' => [ + 'title' => '源regionId', + 'description' => 'The local region where the **local IP address** resides.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ThisIp' => [ + 'title' => '源IP地址', + 'description' => 'The local IP address.'."\n", + 'type' => 'string', + 'example' => '1.8.XX.XX', + ], + 'ThisPort' => [ + 'title' => '源端口号', + 'description' => 'The local port.'."\n", + 'type' => 'string', + 'example' => '80', + ], + 'OtherRegion' => [ + 'title' => '目的regionId', + 'description' => 'The remote region where the **remote IP address** resides.'."\n", + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'OtherIp' => [ + 'title' => '目的IP地址', + 'description' => 'The remote IP address.'."\n", + 'type' => 'string', + 'example' => '47.216.XX.XX', + ], + 'OtherPort' => [ + 'title' => '目的端口号', + 'description' => 'The remote port.'."\n", + 'type' => 'string', + 'example' => '53470', + ], + 'Protocol' => [ + 'title' => '协议号', + 'description' => 'The protocol number.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => 'The beginning of the time range that you queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-01-31T05:40:00Z', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range that you queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-01-31T06:40:00Z', + ], + 'Packets' => [ + 'description' => 'The total number of packets in the specified time range.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '88', + ], + 'Bytes' => [ + 'description' => 'The total volume of traffic in the specified time range.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '188', + ], + 'BandwithPackageId' => [ + 'title' => '带宽包', + 'description' => 'The ID of the CEN bandwidth plan.'."\n", + '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' => 'GetTransitRouterFlowTopN', + ], + 'CreateNetworkReachableAnalysis' => [ + 'summary' => 'Creates a task for analyzing network reachability.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region for which you want to create a task for analyzing network reachability.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'NetworkPathId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the network path. You can call the [CreateNetworkPath](~~2366522~~) operation to obtain the ID of the network path.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'np-b2f618ceb2c84057****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags to add to the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag to add to the resource. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun`.'."\n" + ."\n" + .'You can add up to 20 tags in each call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Team', + ], + 'Value' => [ + 'description' => 'The value of the tag to add to the resource. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`. The tag value can be an empty string.'."\n" + ."\n" + .'You can add up to 20 tag values in each call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ops', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NetworkReachableAnalysisId' => [ + 'description' => 'The ID of the task for analyzing network reachability.'."\n", + 'type' => 'string', + 'example' => 'nra-2fede05617494417****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectStatus.NetworkPath', + 'errorMessage' => 'The last analysis status of %s is %s. Please try again later.', + ], + [ + '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' => 'CreateNetworkReachableAnalysis', + 'description' => '* The **CreateNetworkReachableAnalysis** operation is used to create a task for analyzing the reachability of the network path that is created by calling the **CreateNetworkPath** operation and record the analysis results.'."\n" + .'* The **CreateNetworkReachableAnalysis** operation can be called to repeatedly analyze the reachability of a network path.'."\n" + .'* You can create up to 1,000 reachability analysis records within one Alibaba Cloud account.'."\n", + ], + 'CreateNetworkPath' => [ + 'summary' => 'Creates a network path for reachability analysis.', + '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' => 'The region ID of the network path that you want to create.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'NetworkPathName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the network path.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs2PublicIp', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-2zef4ngqfarepyun****', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the source resource. Valid values:'."\n" + ."\n" + .'* **ecs**: the Elastic Compute Service (ECS) instance'."\n" + .'* **internetIp**: the public IP address'."\n" + .'* **vsw**: the vSwitch'."\n" + .'* **vpn**: the VPN gateway'."\n" + .'* **vbr**: the virtual border router (VBR)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'SourceIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172.17.XX.XX', + ], + ], + [ + 'name' => 'SourcePort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source port.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '443', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination resource.'."\n", + 'type' => 'string', + 'required' => false, + 'minimum' => '0', + 'example' => 'i-bp13d0e064gubm****', + 'maxItems' => 24, + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination resource. Valid values:'."\n" + ."\n" + .'* **ecs**: the ECS instance'."\n" + .'* **internetIp**: the public IP address'."\n" + .'* **vsw**: the vSwitch'."\n" + .'* **vpn**: the VPN gateway'."\n" + .'* **vbr**: the VBR'."\n" + .'* **clb**: the Classic Load Balancer (CLB) instance'."\n", + 'type' => 'string', + 'required' => false, + 'minimum' => '0', + 'example' => 'ecs', + 'maxItems' => 24, + ], + ], + [ + 'name' => 'TargetIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.210', + ], + ], + [ + 'name' => 'TargetPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination port.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* **tcp**: Transmission Control Protocol (TCP)'."\n" + .'* **udp**: User Datagram Protocol (UDP)'."\n" + .'* **icmp**: Internet Control Message Protocol (ICMP)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + 'maxLength' => 16, + ], + ], + [ + 'name' => 'NetworkPathDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the network path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Analyze the path from ECS to ECS', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags to add to the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N to add to the resource. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun`.'."\n" + ."\n" + .'You can add up to 20 tags in each call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'role', + ], + 'Value' => [ + 'description' => 'The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ops', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm27qsxjj****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NetworkPathId' => [ + 'description' => 'The ID of the network path.'."\n", + 'type' => 'string', + 'example' => 'np-4cbf598673d14d27****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '92DD9FFB-06FB-56F7-83EF-5CEF98F5562A', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam.InternetIP', + 'errorMessage' => 'The specified IP address (%s) is not an internet IP address.', + ], + [ + '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' => 'CreateNetworkPath', + 'description' => '* You can call the **CreateNetworkPath** operation to create network paths in multiple networking scenarios and between multiple resources. After a path is created, the path parameters are saved for repeated analysis.'."\n" + .'* You can create up to 100 network paths within one Alibaba Cloud account.'."\n", + ], + 'CreateAndAnalyzeNetworkPath' => [ + 'summary' => 'Initiates a task for analyzing network reachability.', + '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' => 'The ID of the source resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-uf62y8khhbkbdrp6****', + ], + ], + [ + 'name' => 'SourceIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'TargetIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172.50.XX.XX', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the source resource. Valid values:'."\n" + ."\n" + .'* **ecs**: the Elastic Compute Service (ECS) instance'."\n" + .'* **internetIp**: the public IP address'."\n" + .'* **vsw**: the vSwitch'."\n" + .'* **vpn**: the VPN gateway'."\n" + .'* **vbr**: the virtual border router (VBR)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'SourcePort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source port.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-m5eactvw7wtpktv5****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination resource. Valid values:'."\n" + ."\n" + .'* **ecs**: the ECS instance'."\n" + .'* **internetIp**: the public IP address'."\n" + .'* **vsw**: the vSwitch'."\n" + .'* **vpn**: the VPN gateway'."\n" + .'* **vbr**: the VBR'."\n" + .'* **clb**: the Classic Load Balancer (CLB) instance'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'TargetPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination port.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* **tcp**: Transmission Control Protocol (TCP)'."\n" + .'* **udp**: User Datagram Protocol (UDP)'."\n" + .'* **icmp**: Internet Control Message Protocol (ICMP)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region for which you want to initiate a task for analyzing network reachability.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5E98683-355B-5867-8D3D-A24755F6895B', + ], + 'NetworkReachableAnalysisId' => [ + 'description' => 'The ID of the task for analyzing network reachability that you initiated.'."\n", + 'type' => 'string', + 'example' => 'nra-dfe9e53d2b524568****', + ], + 'SourceId' => [ + 'description' => 'The ID of the source resource.'."\n", + 'type' => 'string', + 'example' => 'i-uf62y8khhbkbdrp6****'."\n", + ], + 'TargetId' => [ + 'description' => 'The ID of the destination resource.'."\n", + 'type' => 'string', + 'example' => 'i-m5eactvw7wtpktv5****'."\n", + ], + 'SourceType' => [ + 'description' => 'The type of the source resource.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'TargetType' => [ + 'description' => 'The type of the destination resource.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'SourcePort' => [ + 'description' => 'The source port.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'TargetPort' => [ + 'description' => 'The destination port.'."\n", + 'type' => 'string', + 'example' => '80', + ], + 'Protocol' => [ + 'description' => 'The protocol type.'."\n", + 'type' => 'string', + 'example' => 'tcp', + ], + 'SourceIpAddress' => [ + 'description' => 'The source IP address.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX'."\n", + ], + 'TargetIpAddress' => [ + 'description' => 'The destination IP address.'."\n", + 'type' => 'string', + 'example' => '172.50.XX.XX'."\n", + ], + ], + ], + ], + ], + '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' => 'CreateAndAnalyzeNetworkPath', + 'description' => 'You can call this operation to initiate a task for analyzing network reachability by specifying only the information about the source and destination. You do not need to create a network path for reachability analysis. The analysis result is not recorded in the system. If you want to record the path parameters and analysis result in the Network Intelligence Service (NIS) console, we recommend that you call the **createNetworkReachableAnalysis** operation.'."\n", + ], + 'DeleteNetworkPath' => [ + 'summary' => 'Deletes a network path.', + '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' => 'The region ID of the network path that you want to delete.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'NetworkPathIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of network paths.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'You can call the [CreateNetworkPath](~~2366522~~) operation to obtain the ID of the network path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'np-10c31b7aca0e4486****', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C4331873-C534-590F-A905-F66C53B88A47', + ], + 'Data' => [ + 'type' => 'boolean', + 'description' => 'Result of operation.'."\n" + ."\n" + .'- **true**: Delete Success.'."\n" + .'- **false**: Delete Fail.', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DeleteNetworkPath', + ], + 'DeleteNetworkReachableAnalysis' => [ + 'summary' => 'Deletes a task for analyzing network reachability.', + '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' => 'The ID of the region for which you want to delete a task for analyzing network reachability.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'NetworkReachableAnalysisIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the tasks for analyzing network reachability.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the task for analyzing network reachability. You can call the [CreateNetworkReachableAnalysis](~~2366521~~) operation to obtain the ID of the task for analyzing network reachability.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[\\"nra-be3cff6bed3049f5****\\"]', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4838F3F2-30E1-5D82-B25A-B9FE33BC3E25', + ], + 'Data' => [ + 'type' => 'boolean', + 'description' => 'Result of operation.'."\n" + .'- **true**: Delete Success.'."\n" + .'- **false**: Delete Fail.', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DeleteNetworkReachableAnalysis', + ], + 'GetNetworkReachableAnalysis' => [ + 'summary' => 'Obtains the results of network reachability analysis.', + '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' => 'The ID of the region for which you want to obtain the result of network reachability analysis.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'NetworkReachableAnalysisId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the task for analyzing network reachability. You can call the **CreateNetworkRearchableAnalysis** operation to obtain the ID of the task for analyzing network reachability.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'nra-90eef36a9e6e4662****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NetworkPathId' => [ + 'description' => 'The network path ID.'."\n", + 'type' => 'string', + 'example' => 'np-2a1332214fa346b6****', + ], + 'NetworkReachableAnalysisId' => [ + 'description' => 'The ID of the task for analyzing network reachability.'."\n", + 'type' => 'string', + 'example' => 'nra-8607514e71c1484****', + ], + 'NetworkReachableAnalysisStatus' => [ + 'description' => 'The state of the task for analyzing network reachability. Valid values:'."\n" + ."\n" + .'* **init**: The task is in progress.'."\n" + .'* **finish**: The task is complete.'."\n" + .'* **error**: An analysis error occurred.'."\n" + .'* **timeout**: The task timed out.'."\n", + 'type' => 'string', + 'example' => 'finish', + ], + 'NetworkReachableAnalysisResult' => [ + 'description' => 'The result of network reachability analysis, which includes the network topology, error codes of network unreachability, and rules of network unreachability.'."\n", + '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' => 'Indicates whether the network path is reachable. Valid values:'."\n" + ."\n" + .'* **true**: The network path is reachable.'."\n" + .'* **false**: The network path is unreachable.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => 'The time when the network path was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-03-16T07:11:27Z', + ], + 'AliUid' => [ + 'description' => 'The unique ID (UID) of the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123147627844****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DEE0FEAF-59AE-5CDD-AA07-626BC365D571', + ], + 'NetworkPathParameter' => [ + 'description' => 'The parameters of the network path.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "sourceId": "i-bp100g5pbp6kj4p9****",'."\n" + .' "sourceType": "ecs",'."\n" + .' "targetId": "i-t4n4ltwgbbomzb0g****",'."\n" + .' "targetType": "ecs"'."\n" + .'}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SizeExceeds.Zones', + 'errorMessage' => 'The length of the specified available zones exceeds the limit.', + ], + [ + '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' => 'GetNetworkReachableAnalysis', + 'description' => '**GetNetworkReachableAnalysis** is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can query the state of the task for analyzing network reachability.'."\n" + ."\n" + .'* The **init** state indicates that the task is in progress.'."\n" + .'* The **finish** state indicates that the task is complete. In this state, you can obtain the analysis result.'."\n", + ], + 'GetNisNetworkMetrics' => [ + 'summary' => '获取云网络指标趋势', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AccessInternetIPV4', + 'enum' => [ + 'AccessInternetIpV4', + 'AccessInternetIpV4Limited', + 'ElasticIP', + 'PublicIpEcs', + 'PublicIpClb', + 'NAT', + 'TR', + 'TRAttachment', + 'VBR', + 'GA', + 'ECR', + 'VPC', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'bps', + 'enum' => [ + 'rtt', + 'bps', + 'pps', + 'RetransmitRate', + 'ActiveSessionCount', + 'NewSessionPerSecond', + 'RatelimitDropPps', + 'passRate', + ], + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '具体业务的Metric查询参数。各场景参数说明详见xxx部分。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'instanceId', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'eip-sample*', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '起始时间戳，单位毫秒。未指定时默认查最近1小时。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '253402271999000', + 'minimum' => '0', + 'example' => '1638239092000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间戳，单位毫秒。未指定时默认查最近1小时。只指定了BeginTime时查BeginTime之后的一小时。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '253402271999000', + 'minimum' => '0', + 'example' => '1684373700099', + ], + ], + [ + 'name' => 'ScanBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，'."\n" + .'TimestampAscending：按时间正向排序。'."\n" + .'TimestampDescending：按时间逆向排序。', + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"118639953821****\\"]', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'StepMinutes', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>', + 'description' => 'RpcResponse<ArrayList<PublicFlowlogMetricModel>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'InspectionReportId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nir-9923e262c106461d86ad', + ], + ], + ], + ], + ], + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ni-8svm******hzr7fh79', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'InspectionName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'InspectionProject', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'customized' => 'customized', + 'basic' => 'basic', + ], + 'example' => 'basic', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hKrS+MVXkuOgztXnvdml1/R9jhHkiH8eW3CfaOYU0CEL7yiT0zae6J8v1zYNg+d1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'InspectionTaskList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InspectionTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ni-8svm******hzr7fh79', + ], + 'InspectionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Active', + ], + 'InspectionProject' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'basic', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-06-18 00:14:46', + ], + 'LastUpdateReportId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nir-b4c4c9******8a25e', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj', + ], + 'MaxResults' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'InspectionTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ni-8svmpe0yso2bhzr7fh79', + ], + 'InspectionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Default', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Active', + ], + 'InspectionProject' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'basic', + ], + 'InspectionTriggerTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-07-01 15:15:57', + ], + 'InspectionInterval' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'LastUpdateReportId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'InspectionReportId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nir-2ca527b8de114ba4afb9', + ], + 'InspectionTaskId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '4838F3F2-30E1-5D82-B25A-B9FE33BC3E25', + ], + 'InspectionReportId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nir-38abb318b27b49cc9a01', + ], + 'InspectionTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ni-8svmpe0yso2bhzr7fh79', + ], + 'Status' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'HighRisk', + 'enum' => [ + 'HighRisk', + 'MediumRisk', + 'LowRisk', + 'NoRisk', + ], + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '', + ], + 'Count' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'RecommendationList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RecommendationCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nat_snat_cross_az_warn', + ], + 'Abnormality' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Suggestion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Metadata' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ReasonCode' => [ + 'type' => 'string', + ], + 'SuggestionCode' => [ + 'type' => 'string', + ], + ], + ], + ], + 'CheckItemName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'DescriptionCode' => [ + 'title' => '巡检项描述Code', + 'type' => 'string', + 'example' => 'item_ep_high_availability_check_description', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'InspectionReportId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'A7F0D6EC-E19E-58AC-AC9F-08036763960F', + ], + 'ResourceList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-p0wn04hi4****q2us6q7q', + ], + 'ResourceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AnalysisData' => [ + 'description' => '', + 'type' => 'string', + 'example' => "\n" + .'{ResourceId: "ngw-p0wn04hi4****q2us6q7q"}', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'qt0DqY2lXxwBt9/ROQoS/7J9p90D1vF2vFbwzb/1oSWr3AxcM6/KpObZ7Z1PZdcV', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '192', + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'InspectionReportId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '0D213AF9-7B8A-51A8-B411-2D797A1A447B', + ], + 'InspectionReportList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InspectionReportId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nir-7c3dd178738a429abe6d', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '34', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj', + ], + 'MaxResults' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'nis.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'nis-intl.aliyuncs.com', + ], + ], +]; |