# Alibaba Cloud NIS API

> Alibaba Cloud NIS API on Apizie: 25 endpoints (Initiates a task for analyzing network reachability, Creates a network path for reachability analysis, Creates a task for analyzing network reachability, Deletes a network analysis path, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-nis/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-nis`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/nis
- Page: https://apizie.tech/api/cloud/aliyun-nis
- OpenAPI: https://apizie.tech/api/cloud/aliyun-nis/openapi.json

Alibaba Cloud OpenAPI for NIS (nis, version 2021-12-16). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Initiates a task for analyzing network reachability
`POST https://apizie.tech/v1/cloud:aliyun-nis/create-and-analyze-network-path` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| SourceId | string | yes | The ID of the source resource |
| SourceIpAddress | string | no | The source IP address |
| TargetIpAddress | string | no | The destination IP address |
| SourceType | string | yes | The type of the source resource. Valid values: ecs: the Elastic Compute Service (ECS) instance internetIp: the public IP address vsw: the… |
| SourcePort | integer | no | The source port |
| TargetId | string | no | The ID of the destination resource |
| TargetType | string | no | The type of the destination resource. Valid values: ecs: the ECS instance internetIp: the public IP address vsw: the vSwitch vpn: the VPN… |
| TargetPort | integer | no | The destination port |
| Protocol | string | no | The protocol type. Valid values: tcp: Transmission Control Protocol (TCP) udp: User Datagram Protocol (UDP) icmp: Internet Control Message… |
| RegionId | string | no | The ID of the region for which you want to initiate a task for analyzing network reachability |

### Creates a network path for reachability analysis
`POST https://apizie.tech/v1/cloud:aliyun-nis/create-network-path` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionId | string | no | The region ID of the network path that you want to create |
| NetworkPathName | string | yes | The name of the network path |
| SourceId | string | yes | The ID of the source resource |
| SourceType | string | yes | The type of the source resource. Valid values: ecs: the Elastic Compute Service (ECS) instance internetIp: the public IP address vsw: the… |
| SourceIpAddress | string | no | The source IP address |
| SourcePort | integer | no | The source port |
| TargetId | string | no | The ID of the destination resource |
| TargetType | string | no | The type of the destination resource. Valid values: ecs: the ECS instance internetIp: the public IP address vsw: the vSwitch vpn: the VPN… |
| TargetIpAddress | string | no | The destination IP address |
| TargetPort | integer | no | The destination port |
| Protocol | string | no | The protocol type. Valid values: tcp: Transmission Control Protocol (TCP) udp: User Datagram Protocol (UDP) icmp: Internet Control Message… |
| NetworkPathDescription | string | no | The description of the network path |
| Tag | string | no | The tags to add to the resource (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |

### Creates a task for analyzing network reachability
`POST https://apizie.tech/v1/cloud:aliyun-nis/create-network-reachable-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionId | string | no | The ID of the region for which you want to create a task for analyzing network reachability |
| NetworkPathId | string | yes | The ID of the network path. You can call the https://help.aliyun.com/document_detail/2366522.html operation to obtain the ID of the… |
| Tag | string | no | The tags to add to the resource (JSON-encoded) |

### Deletes a network analysis path
`POST https://apizie.tech/v1/cloud:aliyun-nis/delete-network-path` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionId | string | no | The region ID of the network analysis path to delete |
| NetworkPathIds | string | yes | The collection of network analysis paths (JSON-encoded) |

### Deletes a network reachability analysis task
`POST https://apizie.tech/v1/cloud:aliyun-nis/delete-network-reachable-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionId | string | no | The region ID of the network reachability analysis task |
| NetworkReachableAnalysisIds | string | yes | The IDs of the network reachability analysis tasks (JSON-encoded) |

### Deletes an inspection report
`POST https://apizie.tech/v1/cloud:aliyun-nis/delete-nis-inspection-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionReportId | string | yes | The ID of the inspection report |

### Deletes an inspection task
`POST https://apizie.tech/v1/cloud:aliyun-nis/delete-nis-inspection-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionTaskId | string | yes | The ID of the inspection task |

### Queries the list of anomalous instances in an inspection report
`POST https://apizie.tech/v1/cloud:aliyun-nis/describe-nis-inspection-recommendation-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionReportId | string | yes | The inspection report ID |
| RecommendationCode | string | yes | The recommendation code for the anomaly |
| NextToken | string | no | The pagination token. Set this parameter to the value of NextToken that is returned from the previous API call |
| MaxResults | integer | no | The maximum number of entries per page for a paged query. Maximum value: 100. Default value: 20 |
| Language | string | no | The language to use |

### Queries the details of inspection report check items
`POST https://apizie.tech/v1/cloud:aliyun-nis/describe-nis-inspection-report-check-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionReportId | string | yes | The inspection report ID |
| ResourceType | string | no | The resource type (JSON-encoded) |
| CategoryCode | string | no | The category of the check item |
| RiskLevel | string | no | The collection of risk levels (JSON-encoded) |
| NextToken | string | no | The query token. Set this parameter to the NextToken value returned in the previous API call |
| MaxResults | integer | no | The maximum number of entries per page for a paged query. Maximum value: 100. Default value: 20 |
| Language | string | no | The language. Valid values: zh-CN, en-US |

### Queries the status of an inspection report
`POST https://apizie.tech/v1/cloud:aliyun-nis/describe-nis-inspection-report-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionReportId | string | yes | The inspection report ID |

### Queries the summary of an inspection report
`POST https://apizie.tech/v1/cloud:aliyun-nis/describe-nis-inspection-report-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionReportId | string | yes | The inspection report ID |

### Queries the details of an inspection task
`POST https://apizie.tech/v1/cloud:aliyun-nis/describe-nis-inspection-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionTaskId | string | yes | The ID of the inspection task |

### Queries NIS traffic ranking analysis results
`POST https://apizie.tech/v1/cloud:aliyun-nis/describe-nis-traffic-ranking` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| NisTrafficRankingId | string | yes | The ID of the traffic ranking analysis result. Set this parameter to the value returned by the StartNisTrafficRanking operation |
| NextToken | string | no | The pagination token. Set this parameter to the value of NextToken that is returned from the previous API call |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 20 |

### Calls the GetNetworkReachableAnalysis operation to obtain the results of a network reachability analysis task
`POST https://apizie.tech/v1/cloud:aliyun-nis/get-network-reachable-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionId | string | no | The region ID of the network reachability analysis task |
| NetworkReachableAnalysisId | string | yes | The ID of the network reachability analysis task. You can obtain the network reachability analysis ID by calling the… |

### Retrieves detailed monitoring metric trends data for a specified NIS network analysis scenario, including…
`POST https://apizie.tech/v1/cloud:aliyun-nis/get-nis-network-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionNo | string | yes | The region ID |
| ResourceType | string | yes | Analyzes traffic by the Alibaba Cloud network resource type used for traffic forwarding. Valid values: AccessInternetIpV4: all Alibaba… |
| MetricName | string | yes | The metric name. Valid values: bps: bits per second. pps: packets per second. rtt: round-trip time when establishing a TCP connection.… |
| Dimensions | string | yes | The collection of metric query parameters for specific business scenarios. For metric description of each scenario, see… |
| BeginTime | integer | no | The start time, in ms, in UNIX timestamp format. If not specified, the most recent 1 hour is queried by default. The earliest start time… |
| EndTime | integer | no | The end time, in ms, in UNIX timestamp format. If not specified, the most recent 1 hour is queried by default. If only BeginTime is… |
| ScanBy | string | no | The sort order. Default value: TimestampAscending. Valid values: TimestampAscending: sorts by time in ascending order.… |
| UseCrossAccount | string | no | Specifies whether to use multi-account access mode. This is a reserved parameter and is not currently supported |
| AccountIds | string | no | Explicitly passes member account IDs (JSON-encoded) |
| StepMinutes | integer | no | The StepMinutes |

### Supports ranking analysis of traffic flowing through different cloud network resources by using sorting…
`POST https://apizie.tech/v1/cloud:aliyun-nis/get-nis-network-ranking` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionNo | string | no | The region where the resource resides |
| ResourceType | string | yes | The Alibaba Cloud network resource type used for traffic forwarding. Valid values: |
| Direction | string | yes | The network traffic direction based on Alibaba Cloud resources. Valid values: |
| GroupBy | string | yes | The dimension for metric ranking. Valid values vary by scenario: |
| OrderBy | string | yes | The metric for ranking Internet traffic. Case-sensitive. Valid values: |
| Filter | string | no | Specifies filter conditions for focused network traffic analysis (JSON-encoded) |
| BeginTime | integer | no | The start timestamp, in ms. If not specified, the last hour is queried by default |
| EndTime | integer | no | The end timestamp, in ms. If not specified, the last hour is queried by default. If only BeginTime is specified, the one hour after… |
| Sort | string | no | The sort order. Default value: desc. Valid values: |
| TopN | integer | no | The number of top-ranked entries to display. Default value: 10. Maximum value: 100 |
| UseCrossAccount | string | no | Specifies whether to use multi-account access mode. This is a reserved parameter and is not currently supported |
| AccountIds | string | no | The member account IDs explicitly passed (JSON-encoded) |

### Retrieves network traffic analysis metric trends
`POST https://apizie.tech/v1/cloud:aliyun-nis/get-nis-traffic-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionNo | string | yes | The region ID |
| MetricName | string | yes | The metric name. Common parameters supported by network traffic analysis scenarios: bps: bits per second. pps: packets per second.… |
| BeginTime | integer | yes | The start timestamp, in milliseconds. If not specified, the most recent 1 hour is queried by default |
| EndTime | integer | yes | The end timestamp, in milliseconds. If not specified, the most recent 1 hour is queried by default. If only BeginTime is specified, the 1… |
| ScanBy | string | no | The sort order. Valid values: TimestampAscending: sorts by time in ascending order. TimestampDescending: sorts by time in descending order |
| TrafficAnalyzerId | string | yes | The network traffic analysis analyzer ID |
| TrafficScenario | string | yes | The supported analysis scenarios: All VPC flow log analysis Internet VPC flow log analysis All TR flow log analysis Internet Shared… |
| Direction | string | yes | The network traffic direction based on Alibaba Cloud resources. In: traffic flowing into the target resource. Out: traffic flowing out of… |
| Filter | string | no | Specifies additional filter conditions for the traffic to perform focused network traffic analysis (JSON-encoded) |
| TupleDimension | string | no | The traffic storage aggregation dimension. Based on the TrafficScenario: VpcFlowLogAll/VpcFlowLog: required. Specifies the storage… |
| NextToken | string | no | The pagination token for the next query. You do not need to specify this parameter for the first query or if no more results exist. If… |
| MaxResults | integer | no | In VPC scenarios, this parameter specifies the page size. In TR and Internet Shared Bandwidth scenarios, this parameter specifies the SQL… |
| StepMinutes | integer | no | The aggregation step for time series data, in minutes. The final query granularity is the larger value between StepMinutes and the… |
| StorageInterval | integer | no | The storage bucket precision property. The storage bucket precision specifies the storage aggregation epoch to query. Two precision levels… |

### Lists the resource types available for inspection
`POST https://apizie.tech/v1/cloud:aliyun-nis/list-nis-inspection-resource-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |

### Queries a list of inspection task reports
`POST https://apizie.tech/v1/cloud:aliyun-nis/list-nis-inspection-task-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionTaskId | string | yes | The ID of the inspection task |
| NextToken | string | no | The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first query |
| MaxResults | integer | no | The number of entries to return on each page. Valid values: 1 to 100. Default value: 20 |

### Lists the network inspection tasks
`POST https://apizie.tech/v1/cloud:aliyun-nis/list-nis-inspection-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionTaskId | string | no | The ID of the network inspection task |
| InspectionName | string | no | The name of the network inspection task |
| InspectionProject | string | no | The type of inspection solution that the network inspection task uses. Valid values: basic and customized |
| Status | string | no | The running status of the task. Valid values: Creating Active Running Inactive |
| NextToken | string | no | The token that is used to retrieve the next page of results. Set this parameter to the NextToken value returned from a previous call |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 20 |

### Sends an A2A streaming message
`POST https://apizie.tech/v1/cloud:aliyun-nis/send-napal-stream-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| Message | string | no | The message body object that contains user input and conversation context information (JSON-encoded) |
| Metadata | string | no | The additional request information (JSON-encoded) |
| Configuration | string | no | The request configuration object (JSON-encoded) |

### Starts an inspection task to generate an inspection report
`POST https://apizie.tech/v1/cloud:aliyun-nis/start-nis-inspection-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionTaskId | string | yes | The inspection task ID |

### Triggers the NIS traffic analyzer to execute a traffic ranking task within a specified scope
`POST https://apizie.tech/v1/cloud:aliyun-nis/start-nis-traffic-ranking` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| RegionNo | string | yes | The region where the resource resides |
| TrafficAnalyzerId | string | yes | The ID of the network traffic analysis analyzer |
| TupleDimension | string | no | The storage aggregation dimension for network traffic analysis. Based on the TraffficScenario: VpcFlowLogAll/VpcFlowLog: Required.… |
| TrafficScenario | string | yes | Supported analysis scenarios: All VPC flow log analysis Public VPC flow log analysis All TR flow log analysis Internet Shared Bandwidth… |
| Direction | string | yes | The network traffic direction based on Alibaba Cloud resources. In: Inbound traffic to the target resource. Out: Outbound traffic from the… |
| GroupBy | string | no | Specifies multiple traffic dimensions for aggregation and sorting (JSON-encoded) |
| OrderBy | string | yes | Based on the `TrafficScenario` field, the following metrics are supported for ranking traffic: `TrafficScenario = VpcFlowLogAll` /… |
| Filter | string | no | Specifies additional filter conditions for focused network traffic analysis (JSON-encoded) |
| BeginTime | integer | yes | The start timestamp of the query, in milliseconds |
| EndTime | integer | yes | The end timestamp of the query, in milliseconds |
| Sort | string | no | The sorting method for network traffic analysis. Valid values: ASC: Ascending order. DESC: Descending order |
| TopN | integer | no | The number of entries for the network traffic analysis sorting query. You can specify a custom number. If this parameter is not specified,… |
| Language | string | no | The language. Valid values: zh-CN, en-US |
| NextToken | string | no | The pagination token. You do not need to specify this parameter for the first query or if no more results exist. If a next query exists,… |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 20 |
| StorageInterval | integer | no | The storage bucket precision property. The storage bucket precision specifies the storage aggregation epoch for the query. Two precision… |

### Updates an inspection task
`POST https://apizie.tech/v1/cloud:aliyun-nis/update-nis-inspection-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |
| InspectionTaskId | string | yes | The inspection task ID |
| Status | string | no | The running status of the task |

### version
`POST https://apizie.tech/v1/cloud:aliyun-nis/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nis-intl.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-nis/create-and-analyze-network-path" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud NIS API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-nis/create-and-analyze-network-path with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud NIS API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud NIS itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud NIS API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-nis.

### What is the status of the Alibaba Cloud NIS API?
Needs your own provider key (bring your own key)