@leaflow/sdk 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/assistant/index.d.ts +8 -7
- package/dist/generated/assistant/index.js +6 -5
- package/dist/generated/assistant/models/bindingCodeResponseBody.d.ts +34 -0
- package/dist/generated/assistant/models/bindingCodeResponseBody.js +31 -0
- package/dist/generated/assistant/models/bindingResource.d.ts +4 -1
- package/dist/generated/assistant/models/bindingResourceConnState.d.ts +37 -0
- package/dist/generated/assistant/models/bindingResourceConnState.js +37 -0
- package/dist/generated/assistant/models/bindingResourceStatus.d.ts +36 -0
- package/dist/generated/assistant/models/bindingResourceStatus.js +36 -0
- package/dist/generated/assistant/models/channelResource.d.ts +10 -2
- package/dist/generated/assistant/models/channelResourceConnState.d.ts +40 -0
- package/dist/generated/assistant/models/channelResourceConnState.js +37 -0
- package/dist/generated/assistant/models/channelResourceRuntimeState.d.ts +38 -0
- package/dist/generated/assistant/models/channelResourceRuntimeState.js +35 -0
- package/dist/generated/assistant/models/channelResourceSenderPolicy.d.ts +35 -0
- package/dist/generated/assistant/models/channelResourceSenderPolicy.js +35 -0
- package/dist/generated/assistant/models/channelResourceStatus.d.ts +36 -0
- package/dist/generated/assistant/models/channelResourceStatus.js +36 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBody.d.ts +57 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBody.js +1 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyAllowFrom.d.ts +31 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyAllowFrom.js +31 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyConnState.d.ts +40 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyConnState.js +37 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyRuntimeState.d.ts +38 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyRuntimeState.js +35 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodySenderPolicy.d.ts +35 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodySenderPolicy.js +35 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyStatus.d.ts +36 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyStatus.js +36 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyWebhookSecret.d.ts +34 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyWebhookSecret.js +31 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyWebhookUrl.d.ts +34 -0
- package/dist/generated/assistant/models/channelWithSecretResponseBodyWebhookUrl.js +31 -0
- package/dist/generated/assistant/models/createChannelRequestBody.d.ts +3 -2
- package/dist/generated/assistant/models/createChannelRequestBodySenderPolicy.d.ts +35 -0
- package/dist/generated/assistant/models/createChannelRequestBodySenderPolicy.js +35 -0
- package/dist/generated/assistant/models/index.d.ts +17 -1
- package/dist/generated/assistant/models/index.js +17 -1
- package/dist/generated/assistant/models/itemResourceStatus.d.ts +1 -1
- package/dist/generated/assistant/models/itemResourceStatus.js +1 -1
- package/dist/generated/assistant/models/itemResourceType.d.ts +1 -0
- package/dist/generated/assistant/models/itemResourceType.js +1 -0
- package/dist/generated/assistant/models/loginResource.d.ts +5 -2
- package/dist/generated/assistant/models/loginResource.js +0 -30
- package/dist/generated/assistant/models/loginResourceStatus.d.ts +39 -0
- package/dist/generated/assistant/models/loginResourceStatus.js +39 -0
- package/dist/generated/assistant/models/updateChannelRequestBodySenderPolicy.d.ts +2 -2
- package/dist/generated/assistant/models/updateChannelRequestBodySenderPolicy.js +2 -2
- package/dist/generated/tunnel/index.d.ts +142 -0
- package/dist/generated/tunnel/index.js +149 -0
- package/dist/generated/tunnel/models/actOnTunnelRequestBody.d.ts +28 -0
- package/dist/generated/tunnel/models/actOnTunnelRequestBody.js +1 -0
- package/dist/generated/tunnel/models/actOnTunnelRequestBodyAction.d.ts +29 -0
- package/dist/generated/tunnel/models/actOnTunnelRequestBodyAction.js +29 -0
- package/dist/generated/tunnel/models/changeTunnelPlanRequestBody.d.ts +27 -0
- package/dist/generated/tunnel/models/changeTunnelPlanRequestBody.js +25 -0
- package/dist/generated/tunnel/models/error.d.ts +31 -0
- package/dist/generated/tunnel/models/error.js +1 -0
- package/dist/generated/tunnel/models/errorMeta.d.ts +27 -0
- package/dist/generated/tunnel/models/errorMeta.js +25 -0
- package/dist/generated/tunnel/models/index.d.ts +54 -0
- package/dist/generated/tunnel/models/index.js +54 -0
- package/dist/generated/tunnel/models/lengthAwarePageOperationLogResource.d.ts +35 -0
- package/dist/generated/tunnel/models/lengthAwarePageOperationLogResource.js +1 -0
- package/dist/generated/tunnel/models/listTunnelOperationLogsParams.d.ts +43 -0
- package/dist/generated/tunnel/models/listTunnelOperationLogsParams.js +25 -0
- package/dist/generated/tunnel/models/listTunnelUsageSeriesParams.d.ts +32 -0
- package/dist/generated/tunnel/models/listTunnelUsageSeriesParams.js +25 -0
- package/dist/generated/tunnel/models/openTunnelRequestBody.d.ts +38 -0
- package/dist/generated/tunnel/models/openTunnelRequestBody.js +25 -0
- package/dist/generated/tunnel/models/operationLogResource.d.ts +38 -0
- package/dist/generated/tunnel/models/operationLogResource.js +1 -0
- package/dist/generated/tunnel/models/operationLogResourceActor.d.ts +28 -0
- package/dist/generated/tunnel/models/operationLogResourceActor.js +25 -0
- package/dist/generated/tunnel/models/operationLogResourcePayload.d.ts +27 -0
- package/dist/generated/tunnel/models/operationLogResourcePayload.js +25 -0
- package/dist/generated/tunnel/models/subscriptionResource.d.ts +33 -0
- package/dist/generated/tunnel/models/subscriptionResource.js +1 -0
- package/dist/generated/tunnel/models/subscriptionResourceStatus.d.ts +32 -0
- package/dist/generated/tunnel/models/subscriptionResourceStatus.js +29 -0
- package/dist/generated/tunnel/models/tunnelPlanListResponseBody.d.ts +28 -0
- package/dist/generated/tunnel/models/tunnelPlanListResponseBody.js +1 -0
- package/dist/generated/tunnel/models/tunnelPlanResource.d.ts +33 -0
- package/dist/generated/tunnel/models/tunnelPlanResource.js +25 -0
- package/dist/generated/tunnel/models/tunnelResource.d.ts +54 -0
- package/dist/generated/tunnel/models/tunnelResource.js +1 -0
- package/dist/generated/tunnel/models/tunnelResourceEmail.d.ts +28 -0
- package/dist/generated/tunnel/models/tunnelResourceEmail.js +25 -0
- package/dist/generated/tunnel/models/tunnelResourceFailure.d.ts +28 -0
- package/dist/generated/tunnel/models/tunnelResourceFailure.js +25 -0
- package/dist/generated/tunnel/models/tunnelResourceStatus.d.ts +32 -0
- package/dist/generated/tunnel/models/tunnelResourceStatus.js +29 -0
- package/dist/generated/tunnel/models/tunnelResourceSubscriptionStatus.d.ts +32 -0
- package/dist/generated/tunnel/models/tunnelResourceSubscriptionStatus.js +29 -0
- package/dist/generated/tunnel/models/tunnelResourceSuspendedAt.d.ts +28 -0
- package/dist/generated/tunnel/models/tunnelResourceSuspendedAt.js +25 -0
- package/dist/generated/tunnel/models/tunnelUsageSnapshot.d.ts +38 -0
- package/dist/generated/tunnel/models/tunnelUsageSnapshot.js +1 -0
- package/dist/generated/tunnel/models/tunnelUsageSnapshotSyncedAt.d.ts +28 -0
- package/dist/generated/tunnel/models/tunnelUsageSnapshotSyncedAt.js +25 -0
- package/dist/generated/tunnel/models/updateTunnelProfileRequestBody.d.ts +34 -0
- package/dist/generated/tunnel/models/updateTunnelProfileRequestBody.js +1 -0
- package/dist/generated/tunnel/models/updateTunnelProfileRequestBodyEmail.d.ts +29 -0
- package/dist/generated/tunnel/models/updateTunnelProfileRequestBodyEmail.js +25 -0
- package/dist/generated/tunnel/models/usageDayResource.d.ts +30 -0
- package/dist/generated/tunnel/models/usageDayResource.js +25 -0
- package/dist/generated/tunnel/models/usageResource.d.ts +43 -0
- package/dist/generated/tunnel/models/usageResource.js +1 -0
- package/dist/generated/tunnel/models/usageResourceQuotaExceededAt.d.ts +28 -0
- package/dist/generated/tunnel/models/usageResourceQuotaExceededAt.js +25 -0
- package/dist/generated/tunnel/models/usageSeriesResource.d.ts +30 -0
- package/dist/generated/tunnel/models/usageSeriesResource.js +1 -0
- package/dist/http.d.ts +26 -0
- package/dist/http.js +49 -16
- package/dist/index.d.ts +14 -0
- package/dist/index.js +18 -3
- package/openapi/assistant.version +1 -1
- package/openapi/assistant.yaml +147 -25
- package/openapi/compute.version +1 -1
- package/openapi/monitoring.version +1 -1
- package/openapi/tunnel.version +1 -0
- package/openapi/tunnel.yaml +773 -0
- package/package.json +1 -1
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
import type { OperationLogResourceActor } from './operationLogResourceActor.js';
|
|
26
|
+
import type { OperationLogResourcePayload } from './operationLogResourcePayload.js';
|
|
27
|
+
export interface OperationLogResource {
|
|
28
|
+
action: string;
|
|
29
|
+
/** 操作者的用户 id;null 表示由平台执行 */
|
|
30
|
+
actor: OperationLogResourceActor;
|
|
31
|
+
created_at: string;
|
|
32
|
+
failure: string;
|
|
33
|
+
id: string;
|
|
34
|
+
payload: OperationLogResourcePayload;
|
|
35
|
+
subject_id: string;
|
|
36
|
+
subject_type: string;
|
|
37
|
+
succeeded: boolean;
|
|
38
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
/**
|
|
26
|
+
* 操作者的用户 id;null 表示由平台执行
|
|
27
|
+
*/
|
|
28
|
+
export type OperationLogResourceActor = string | null;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export type OperationLogResourcePayload = {
|
|
26
|
+
[key: string]: unknown;
|
|
27
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
import type { SubscriptionResourceStatus } from './subscriptionResourceStatus.js';
|
|
26
|
+
export interface SubscriptionResource {
|
|
27
|
+
/** ready 表示节点已全部下发;preparing 表示仍在下发——此时链接照样可用 */
|
|
28
|
+
status: SubscriptionResourceStatus;
|
|
29
|
+
updated_at: string;
|
|
30
|
+
/** 订阅地址。这是一条长期有效的凭据,等同于密码,请勿转发或截图分享 */
|
|
31
|
+
url: string;
|
|
32
|
+
version: number;
|
|
33
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
/**
|
|
26
|
+
* ready 表示节点已全部下发;preparing 表示仍在下发——此时链接照样可用
|
|
27
|
+
*/
|
|
28
|
+
export type SubscriptionResourceStatus = typeof SubscriptionResourceStatus[keyof typeof SubscriptionResourceStatus];
|
|
29
|
+
export declare const SubscriptionResourceStatus: {
|
|
30
|
+
readonly preparing: "preparing";
|
|
31
|
+
readonly ready: "ready";
|
|
32
|
+
};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
26
|
+
export const SubscriptionResourceStatus = {
|
|
27
|
+
preparing: 'preparing',
|
|
28
|
+
ready: 'ready',
|
|
29
|
+
};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
import type { TunnelPlanResource } from './tunnelPlanResource.js';
|
|
26
|
+
export interface TunnelPlanListResponseBody {
|
|
27
|
+
items: TunnelPlanResource[];
|
|
28
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export interface TunnelPlanResource {
|
|
26
|
+
description: string;
|
|
27
|
+
id: string;
|
|
28
|
+
name: string;
|
|
29
|
+
/** 套餐标称的流量额度,仅供比较。实际额度以隧道用量接口返回的 quota_bytes 为准 */
|
|
30
|
+
quota_bytes: number;
|
|
31
|
+
/** 货架上的排列顺序,越小越靠前 */
|
|
32
|
+
sort: number;
|
|
33
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
import type { TunnelResourceEmail } from './tunnelResourceEmail.js';
|
|
26
|
+
import type { TunnelResourceFailure } from './tunnelResourceFailure.js';
|
|
27
|
+
import type { TunnelResourceStatus } from './tunnelResourceStatus.js';
|
|
28
|
+
import type { TunnelResourceSubscriptionStatus } from './tunnelResourceSubscriptionStatus.js';
|
|
29
|
+
import type { TunnelResourceSuspendedAt } from './tunnelResourceSuspendedAt.js';
|
|
30
|
+
import type { TunnelUsageSnapshot } from './tunnelUsageSnapshot.js';
|
|
31
|
+
export interface TunnelResource {
|
|
32
|
+
created_at: string;
|
|
33
|
+
display_name: string;
|
|
34
|
+
/** 转发给上游面板的联系邮箱;平台不使用它 */
|
|
35
|
+
email: TunnelResourceEmail;
|
|
36
|
+
/** 用户自己的开关。停用会把实例从调度器撤下,但端口保留,启用后原样回来 */
|
|
37
|
+
enabled: boolean;
|
|
38
|
+
/** 最近一次上游拒绝的说明,仅在存在时非空 */
|
|
39
|
+
failure: TunnelResourceFailure;
|
|
40
|
+
id: string;
|
|
41
|
+
plan_id: string;
|
|
42
|
+
plan_name: string;
|
|
43
|
+
/** deleting 表示已退订但上游尚未删除完成 */
|
|
44
|
+
status: TunnelResourceStatus;
|
|
45
|
+
/** preparing 表示节点仍在下发;订阅链接此时照样可用 */
|
|
46
|
+
subscription_status: TunnelResourceSubscriptionStatus;
|
|
47
|
+
/** 每次重置订阅后递增 */
|
|
48
|
+
subscription_version: number;
|
|
49
|
+
/** 被平台停用(欠费、违规或项目停服)。为 true 时无法自行启用 */
|
|
50
|
+
suspended: boolean;
|
|
51
|
+
/** 被平台停用的时刻 */
|
|
52
|
+
suspended_at: TunnelResourceSuspendedAt;
|
|
53
|
+
usage: TunnelUsageSnapshot;
|
|
54
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
/**
|
|
26
|
+
* 转发给上游面板的联系邮箱;平台不使用它
|
|
27
|
+
*/
|
|
28
|
+
export type TunnelResourceEmail = string | null;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
/**
|
|
26
|
+
* 最近一次上游拒绝的说明,仅在存在时非空
|
|
27
|
+
*/
|
|
28
|
+
export type TunnelResourceFailure = string | null;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
/**
|
|
26
|
+
* deleting 表示已退订但上游尚未删除完成
|
|
27
|
+
*/
|
|
28
|
+
export type TunnelResourceStatus = typeof TunnelResourceStatus[keyof typeof TunnelResourceStatus];
|
|
29
|
+
export declare const TunnelResourceStatus: {
|
|
30
|
+
readonly active: "active";
|
|
31
|
+
readonly deleting: "deleting";
|
|
32
|
+
};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
26
|
+
export const TunnelResourceStatus = {
|
|
27
|
+
active: 'active',
|
|
28
|
+
deleting: 'deleting',
|
|
29
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Leaflow 隧道用户 API
|
|
5
|
+
* Leaflow 隧道的用户接口,用于开通与管理项目的加速隧道、订阅地址和流量用量。
|
|
6
|
+
|
|
7
|
+
## 身份与鉴权
|
|
8
|
+
|
|
9
|
+
每个请求需携带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录获取账号令牌,再用它向 IAM 换取项目令牌(`POST /api/v1/projects/{projectId}/token`)。一张项目令牌同时说明当前用户和当前项目。
|
|
10
|
+
|
|
11
|
+
**路径和请求头上都没有 `project_id`**:当前项目由令牌决定。
|
|
12
|
+
|
|
13
|
+
鉴权在网关完成,失败的请求不会到达这些接口。按错误码区分处理方式:`TOKEN_MISSING` 表示没带令牌;`TOKEN_EXPIRED` 表示令牌过期,用账号令牌重新换取即可,无需重新登录;`TOKEN_INVALID` 表示令牌验不过;`NOT_A_MEMBER` 表示当前账号不是该项目成员;`USER_SUSPENDED` / `USER_BANNED` 表示账号本身不能操作。
|
|
14
|
+
|
|
15
|
+
## 通用约定
|
|
16
|
+
|
|
17
|
+
- **一个项目一条隧道。** 所以路径是单数的 `/tunnel`,不带 id。已经有一条时再开通会被拒绝(`TUNNEL_ALREADY_OPEN`)。
|
|
18
|
+
- **订阅地址是凭据。** 它等同于密码,只由 `GET /tunnel/subscription` 单独返回,不出现在隧道详情或任何列表里。怀疑泄露时用重置接口,它会让已分发的每一份订阅立即失效。
|
|
19
|
+
- **停用不是退订。** 停用保留端口和订阅地址,重新启用后原样回来;退订不可逆,重新开通得到的是全新的地址。
|
|
20
|
+
- **判断超额只看 `billed_bytes`。** 线路可以设置倍率(如 1.5× 或 0×),`raw_bytes` 是实际传输量,两者不一定相等。
|
|
21
|
+
- **用量最多滞后一个采集周期。** 适合用量管控,不适合作为计费结算依据。隧道详情里那份还额外经过一层缓存,`usage.synced_at` 说明它有多旧。
|
|
22
|
+
- **换套餐不是瞬时的。** 多出来的线路马上可用,少掉的那些有宽限期,到期才真正释放。
|
|
23
|
+
* OpenAPI spec version: 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
/**
|
|
26
|
+
* preparing 表示节点仍在下发;订阅链接此时照样可用
|
|
27
|
+
*/
|
|
28
|
+
export type TunnelResourceSubscriptionStatus = typeof TunnelResourceSubscriptionStatus[keyof typeof TunnelResourceSubscriptionStatus];
|
|
29
|
+
export declare const TunnelResourceSubscriptionStatus: {
|
|
30
|
+
readonly preparing: "preparing";
|
|
31
|
+
readonly ready: "ready";
|
|
32
|
+
};
|