uapi-browser-sdk 0.1.0

package/internal/docs/NetworkApi.md

@@ -0,0 +1,716 @@
+# NetworkApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getNetworkDns**](NetworkApi.md#getnetworkdns) | **GET** /network/dns | 执行DNS解析查询 |
+| [**getNetworkIcp**](NetworkApi.md#getnetworkicp) | **GET** /network/icp | 查询域名ICP备案信息 |
+| [**getNetworkIpinfo**](NetworkApi.md#getnetworkipinfo) | **GET** /network/ipinfo | 查询指定IP或域名的归属信息 |
+| [**getNetworkMyip**](NetworkApi.md#getnetworkmyip) | **GET** /network/myip | 获取你的公网IP及归属信息 |
+| [**getNetworkPing**](NetworkApi.md#getnetworkping) | **GET** /network/ping | 从服务器Ping指定主机 |
+| [**getNetworkPingmyip**](NetworkApi.md#getnetworkpingmyip) | **GET** /network/pingmyip | 从服务器Ping你的客户端IP |
+| [**getNetworkPortscan**](NetworkApi.md#getnetworkportscan) | **GET** /network/portscan | 扫描远程主机的指定端口 |
+| [**getNetworkUrlstatus**](NetworkApi.md#getnetworkurlstatus) | **GET** /network/urlstatus | 检查URL的可访问性状态 |
+| [**getNetworkWhois**](NetworkApi.md#getnetworkwhois) | **GET** /network/whois | 查询域名的WHOIS注册信息 |
+| [**getNetworkWxdomain**](NetworkApi.md#getnetworkwxdomain) | **GET** /network/wxdomain | 检查域名在微信中的访问状态 |
+
+
+
+## getNetworkDns
+
+> GetNetworkDns200Response getNetworkDns(domain, type)
+
+执行DNS解析查询
+
+想知道一个域名指向了哪个IP？或者它的邮件服务器是谁？这个接口就像一个在线的 `dig` 或 `nslookup` 工具。  ## 功能概述 你可以查询指定域名的各种DNS记录，包括 `A` (IPv4), `AAAA` (IPv6), `CNAME` (别名), `MX` (邮件交换), `NS` (域名服务器) 和 `TXT` (文本记录)。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkDnsRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // string | 你需要查询的域名，例如 \'cn.bing.com\'。
+    domain: cn.bing.com,
+    // 'A' | 'AAAA' | 'CNAME' | 'MX' | 'NS' | 'TXT' | 你想要查询的DNS记录类型。 (optional)
+    type: A,
+  } satisfies GetNetworkDnsRequest;
+
+  try {
+    const data = await api.getNetworkDns(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **domain** | `string` | 你需要查询的域名，例如 \'cn.bing.com\'。 | [Defaults to `undefined`] |
+| **type** | `A`, `AAAA`, `CNAME`, `MX`, `NS`, `TXT` | 你想要查询的DNS记录类型。 | [Optional] [Defaults to `'A'`] [Enum: A, AAAA, CNAME, MX, NS, TXT] |
+
+### Return type
+
+[**GetNetworkDns200Response**](GetNetworkDns200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 查询成功！返回解析到的DNS记录列表。 |  -  |
+| **400** | 请求参数无效。请检查 `domain` 参数是否提供且格式正确。 |  -  |
+| **404** | 未找到DNS记录。该域名可能不存在，或者不存在你所查询类型的记录（例如，一个没有配置MX记录的域名）。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkIcp
+
+> GetNetworkIcp200Response getNetworkIcp(domain)
+
+查询域名ICP备案信息
+
+想知道一个网站的背后运营主体是谁吗？如果它是在中国大陆运营的，ICP备案信息可以告诉你答案。  ## 功能概述 提供一个域名，查询其在中国工信部的ICP（Internet Content Provider）备案信息。这对于商业合作前的背景调查、验证网站合法性等场景很有帮助。  > [!NOTE] > **查询范围** > 此查询仅对在中国大陆工信部进行过备案的域名有效。对于国外域名或未备案的域名，将查询不到结果。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkIcpRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // string | 需要查询的域名或URL
+    domain: baidu.com,
+  } satisfies GetNetworkIcpRequest;
+
+  try {
+    const data = await api.getNetworkIcp(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **domain** | `string` | 需要查询的域名或URL | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetNetworkIcp200Response**](GetNetworkIcp200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 查询成功！返回该域名的ICP备案详情。 |  -  |
+| **400** | 请求参数无效。请检查 `domain` 参数是否提供且格式正确。 |  -  |
+| **404** | 未查询到备案信息。该域名可能没有在工信部备案，或者是我们查询的上游接口暂时没有收录。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkIpinfo
+
+> GetNetworkIpinfo200Response getNetworkIpinfo(ip, source)
+
+查询指定IP或域名的归属信息
+
+想知道一个IP地址或域名来自地球的哪个角落？这个接口可以帮你定位它。你可以选择使用默认的GeoIP数据库，也可以指定 `source=commercial` 参数来查询更详细的商业级IP归属信息。  ## 功能概述 提供一个公网IPv4、IPv6地址或域名，我们会利用GeoIP数据库查询并返回它的地理位置（国家、省份、城市）、经纬度、以及所属的运营商（ISP）和自治系统（ASN）信息。这在网络安全分析、访问来源统计等领域非常有用。  当使用 `source=commercial` 参数时，接口将调用高性能商业API，提供更精确的市、区、运营商、时区、海拔等信息。请注意，商业查询的响应时间可能会稍长。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkIpinfoRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // string | 你需要查询的公网IP地址或域名（支持IPv4和IPv6）。
+    ip: cn.bing.com,
+    // 'commercial' | 查询的数据源。如果留空，将使用默认的数据库。如果设置为 `commercial`，将调用商业级API，返回更详细的地理位置信息，但响应时间可能会稍长。 (optional)
+    source: source_example,
+  } satisfies GetNetworkIpinfoRequest;
+
+  try {
+    const data = await api.getNetworkIpinfo(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ip** | `string` | 你需要查询的公网IP地址或域名（支持IPv4和IPv6）。 | [Defaults to `undefined`] |
+| **source** | `commercial` | 查询的数据源。如果留空，将使用默认的数据库。如果设置为 `commercial`，将调用商业级API，返回更详细的地理位置信息，但响应时间可能会稍长。 | [Optional] [Defaults to `undefined`] [Enum: commercial] |
+
+### Return type
+
+[**GetNetworkIpinfo200Response**](GetNetworkIpinfo200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 查询成功！返回该IP地址的详细地理和网络信息。  **示例 1：标准查询 (不带 `source` 参数)**  请求: `/api/v1/network/ipinfo?ip=120.24.0.0`  响应: ```json {   \"code\": 200,   \"ip\": \"120.24.0.0\",   \"beginip\": \"120.24.0.0\",   \"endip\": \"120.24.255.255\",   \"region\": \"中国 广东\",   \"isp\": \"China Telecom\",   \"asn\": \"AS4134\",   \"llc\": \"电信\",   \"latitude\": 23.1291,   \"longitude\": 113.2644 } ```  **示例 2：商业数据源查询 (`source=commercial`)**  请求: `/api/v1/network/ipinfo?ip=120.24.0.0&source=commercial`  响应: ```json {   \"code\": 200,   \"ip\": \"120.24.0.0\",   \"region\": \"中国 广东 广州\",   \"isp\": \"电信\",   \"llc\": \"电信\",   \"latitude\": 23.1291,   \"longitude\": 113.2644,   \"district\": \"天河\",   \"area_code\": \"440106\",   \"city_code\": \"020\",   \"zip_code\": \"510000\",   \"time_zone\": \"Asia/Shanghai\",   \"elevation\": \"50\",   \"weather_station\": \"CHXX0049\" } ``` |  -  |
+| **400** | IP地址参数无效。请检查 `ip` 参数是否提供，以及它是否是一个合法的公网IP地址。 |  -  |
+| **404** | 信息未找到。这通常意味着你查询的是一个内网IP地址（如 192.168.x.x）或一个未分配的公网IP地址，我们的数据库中没有它的信息。 |  -  |
+| **500** | 服务器内部错误。我们的GeoIP数据库查询服务可能遇到了问题。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkMyip
+
+> GetNetworkIpinfo200Response getNetworkMyip(source)
+
+获取你的公网IP及归属信息
+
+想知道你自己的出口公网IP是多少吗？这个接口就是你的“网络身份证”。你可以选择使用默认的GeoIP数据库，也可以指定 `source=commercial` 参数来查询更详细的商业级IP归属信息。  ## 功能概述 调用此接口，它会返回你（即发起请求的客户端）的公网IP地址，并附带与 `/network/ipinfo` 接口相同的地理位置和网络归属信息。非常适合用于在网页上向用户展示他们自己的IP和地理位置。  当使用 `source=commercial` 参数时，接口将调用高性能商业API，提供更精确的市、区、运营商、时区、海拔等信息。请注意，商业查询的响应时间可能会稍长。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkMyipRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // 'commercial' | 查询的数据源。如果留空，将使用默认的数据库。如果设置为 `commercial`，将调用商业级API，返回更详细的地理位置信息，但响应时间可能会稍长。 (optional)
+    source: source_example,
+  } satisfies GetNetworkMyipRequest;
+
+  try {
+    const data = await api.getNetworkMyip(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **source** | `commercial` | 查询的数据源。如果留空，将使用默认的数据库。如果设置为 `commercial`，将调用商业级API，返回更详细的地理位置信息，但响应时间可能会稍长。 | [Optional] [Defaults to `undefined`] [Enum: commercial] |
+
+### Return type
+
+[**GetNetworkIpinfo200Response**](GetNetworkIpinfo200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 查询成功！返回你的客户端IP的详细信息。  **示例 1：标准查询 (不带 `source` 参数)**  请求: `/api/v1/network/myip`  响应: ```json {   \"code\": 200,   \"ip\": \"1.2.3.4\",   \"beginip\": \"1.2.3.0\",   \"endip\": \"1.2.3.255\",   \"region\": \"中国 湖南 长沙\",   \"isp\": \"China Unicom\",   \"asn\": \"AS4837\",   \"llc\": \"联通\",   \"latitude\": 28.1941,   \"longitude\": 112.9823 } ```  **示例 2：商业数据源查询 (`source=commercial`)**  请求: `/api/v1/network/myip?source=commercial`  响应: ```json {   \"code\": 200,   \"ip\": \"1.2.3.4\",   \"region\": \"中国 湖南 长沙\",   \"isp\": \"联通\",   \"llc\": \"联通\",   \"latitude\": 28.1941,   \"longitude\": 112.9823,   \"district\": \"岳麓\",   \"area_code\": \"430104\",   \"city_code\": \"0731\",   \"zip_code\": \"410000\",   \"time_zone\": \"Asia/Shanghai\",   \"elevation\": \"60\",   \"weather_station\": \"CHXX0062\" } ``` |  -  |
+| **400** | 无法获取有效的客户端IP。这在一些特殊的网络环境下可能发生，例如通过了复杂的代理。 |  -  |
+| **500** | 服务器内部错误。在查询IP归属地信息时发生错误。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkPing
+
+> GetNetworkPing200Response getNetworkPing(host)
+
+从服务器Ping指定主机
+
+想知道从我们的服务器到你的服务器网络延迟高不高？这个工具可以帮你测试网络连通性。  ## 功能概述 这个接口会从我们的服务器节点对你指定的主机（域名或IP地址）执行 ICMP Ping 操作。它会返回最小、最大、平均延迟以及丢包率等关键指标，是诊断网络问题的得力助手。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkPingRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // string | 你需要 Ping 的目标主机，可以是域名或IP地址。
+    host: cn.bing.com,
+  } satisfies GetNetworkPingRequest;
+
+  try {
+    const data = await api.getNetworkPing(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **host** | `string` | 你需要 Ping 的目标主机，可以是域名或IP地址。 | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetNetworkPing200Response**](GetNetworkPing200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ping 操作成功！返回延迟统计数据。 |  -  |
+| **400** | 请求失败，参数无效或目标不可达。前端可直接展示 `message` 字段。  **可能原因**: - **无法解析主机**: `host` 参数是一个无效的域名或IP地址。   ```json   {       \"code\": \"INVALID_PARAMETER\",       \"message\": \"无法解析主机 \'无效的主机名\'，请检查输入是否正确。\"   }   ``` - **Ping 超时**: 目标主机无法访问或被防火墙拦截。   ```json   {       \"code\": \"INVALID_PARAMETER\",       \"message\": \"对主机 \'目标主机\' 的 Ping 请求超时，目标可能不可达或防火墙已拦截。\"   }   ``` |  -  |
+| **429** | 服务繁忙。当服务器 Ping 请求过多时，会触发限流。前端可直接展示 `message` 字段。  ```json {     \"code\": \"SERVICE_BUSY\",     \"message\": \"Ping 服务正忙，请稍后再试。\" } ``` |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkPingmyip
+
+> GetNetworkPingmyip200Response getNetworkPingmyip()
+
+从服务器Ping你的客户端IP
+
+这是一个非常方便的快捷接口，想知道你的网络到我们服务器的回程延迟吗？点一下就行！  ## 功能概述 这个接口是 `/network/myip` 和 `/network/ping` 的结合体。它会自动获取你客户端的公网IP，然后从我们的服务器Ping这个IP，并返回延迟数据。这对于快速判断你本地网络到服务器的连接质量非常有用。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkPingmyipRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  try {
+    const data = await api.getNetworkPingmyip();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetNetworkPingmyip200Response**](GetNetworkPingmyip200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ping 操作成功！返回到你客户端IP的延迟统计数据。 |  -  |
+| **400** | 无法获取客户端IP。 |  -  |
+| **404** | Ping操作失败。这很可能是因为你的路由器或防火墙禁止了外部ICMP Ping请求。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkPortscan
+
+> GetNetworkPortscan200Response getNetworkPortscan(host, port, protocol)
+
+扫描远程主机的指定端口
+
+想检查一下你的服务器上某个端口（比如SSH的22端口或者Web的80端口）是否对外开放？这个工具可以帮你快速确认。  ## 功能概述 你可以指定一个主机和端口号，我们的服务器会尝试连接该端口，并告诉你它是开放的（open）、关闭的（closed）还是超时了（timeout）。这对于网络服务配置检查和基本的安全扫描很有用。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkPortscanRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // string | 需要扫描的目标主机，可以是域名或IP地址。
+    host: cn.bing.com,
+    // number | 需要扫描的端口号，范围是 1 到 65535。
+    port: 80,
+    // 'tcp' | 'udp' | 扫描使用的协议，可以是 \'tcp\' 或 \'udp\'。 (optional)
+    protocol: tcp,
+  } satisfies GetNetworkPortscanRequest;
+
+  try {
+    const data = await api.getNetworkPortscan(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **host** | `string` | 需要扫描的目标主机，可以是域名或IP地址。 | [Defaults to `undefined`] |
+| **port** | `number` | 需要扫描的端口号，范围是 1 到 65535。 | [Defaults to `undefined`] |
+| **protocol** | `tcp`, `udp` | 扫描使用的协议，可以是 \'tcp\' 或 \'udp\'。 | [Optional] [Defaults to `'tcp'`] [Enum: tcp, udp] |
+
+### Return type
+
+[**GetNetworkPortscan200Response**](GetNetworkPortscan200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 扫描完成！返回端口的状态。 |  -  |
+| **400** | 请求参数无效。请检查 `host`, `port` 等参数是否提供且格式正确。 |  -  |
+| **500** | 扫描失败。服务器在执行扫描时发生内部错误。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkUrlstatus
+
+> GetNetworkUrlstatus200Response getNetworkUrlstatus(url)
+
+检查URL的可访问性状态
+
+你的网站或API还好吗？用这个接口给它做个快速“体检”吧。  ## 功能概述 提供一个URL，我们会向它发起一个请求，并返回其HTTP响应状态码。这是一种简单而有效的服务可用性监控方法。  > [!TIP] > **性能优化**：为了提高效率并减少对目标服务器的负载，我们实际发送的是 `HEAD` 请求，而不是 `GET` 请求。`HEAD` 请求只会获取响应头，而不会下载整个页面内容，因此速度更快。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkUrlstatusRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // string | 你需要检查其可访问性状态的完整URL。
+    url: https://cn.bing.com,
+  } satisfies GetNetworkUrlstatusRequest;
+
+  try {
+    const data = await api.getNetworkUrlstatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **url** | `string` | 你需要检查其可访问性状态的完整URL。 | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetNetworkUrlstatus200Response**](GetNetworkUrlstatus200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 检查成功！返回目标的HTTP状态码。 |  -  |
+| **400** | 请求参数无效。请检查 `url` 参数是否提供且格式正确。 |  -  |
+| **502** | 请求URL失败（例如，DNS解析失败、连接超时） |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkWhois
+
+> GetNetworkWhois200Response getNetworkWhois(domain, format)
+
+查询域名的WHOIS注册信息
+
+想知道一个域名是什么时候注册的、注册商是谁、什么时候到期？WHOIS信息可以告诉你这一切。  ## 功能概述 这是一个在线的WHOIS查询工具。你可以通过如下两种方式获取WHOIS信息：  - **默认行为**（不带参数）：`GET /api/v1/network/whois?domain=google.com`   - 返回一个JSON对象，`whois` 字段为原始、未处理的WHOIS文本字符串。 - **JSON格式化**：`GET /api/v1/network/whois?domain=google.com&format=json`   - 返回一个JSON对象，`whois` 字段为解析后的JSON对象，包含WHOIS信息中的键值对。  这样你既可以获得最全的原始信息，也可以方便地处理结构化数据。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkWhoisRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // string | 你需要查询WHOIS信息的域名。
+    domain: google.com,
+    // 'text' | 'json' | 返回格式。留空或为 \'text\' 时返回原始WHOIS文本，设为 \'json\' 时返回结构化JSON。 (optional)
+    format: json,
+  } satisfies GetNetworkWhoisRequest;
+
+  try {
+    const data = await api.getNetworkWhois(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **domain** | `string` | 你需要查询WHOIS信息的域名。 | [Defaults to `undefined`] |
+| **format** | `text`, `json` | 返回格式。留空或为 \'text\' 时返回原始WHOIS文本，设为 \'json\' 时返回结构化JSON。 | [Optional] [Defaults to `'text'`] [Enum: text, json] |
+
+### Return type
+
+[**GetNetworkWhois200Response**](GetNetworkWhois200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 查询成功！根据 format 参数返回原始WHOIS文本或结构化JSON。 |  -  |
+| **400** | 请求参数无效。请检查 `domain` 参数是否提供且格式正确。 |  -  |
+| **404** | 查询失败或域名不存在。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNetworkWxdomain
+
+> GetNetworkWxdomain200Response getNetworkWxdomain(domain)
+
+检查域名在微信中的访问状态
+
+准备在微信里推广你的网站？最好先检查一下域名是否被“拉黑”了。  ## 功能概述 这个接口可以帮你查询一个域名在微信内置浏览器中的访问状态，即是否被微信封禁。这对于做微信生态推广和营销的开发者来说至关重要。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NetworkApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetNetworkWxdomainRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new NetworkApi();
+
+  const body = {
+    // string | 需要查询的域名。
+    domain: qq.com,
+  } satisfies GetNetworkWxdomainRequest;
+
+  try {
+    const data = await api.getNetworkWxdomain(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **domain** | `string` | 需要查询的域名。 | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetNetworkWxdomain200Response**](GetNetworkWxdomain200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 查询成功！返回该域名在微信中的状态。 |  -  |
+| **400** | 请求参数无效。 |  -  |
+| **502** | 查询上游接口失败。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+