/** * 平台版套餐相关接口类型定义 */ import { CircleTime, MetricUsage } from '../interfaces/tcb.interface'; import { HTTPServiceDomain, HTTPServiceDomainParam, HTTPServiceRouteFilter, OwnershipVerificationInfo, VerifyHttpServiceRouteCheckItem } from '../env/type'; /** * 平台版环境配置(资源状态变更) * 用于云存储(Storage)、FlexDB(文档型数据库)等资源的状态更新 */ export interface PlatformEnvResource { /** 资源状态(为空或不传则不更新)。ENABLE:正常 / DISABLE:彻底禁用 / READONLY:只读 */ Status?: 'ENABLE' | 'DISABLE' | 'READONLY'; } /** * ModifyPlatformEnv 请求参数 */ export interface ModifyPlatformEnvParams { /** 环境ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** 环境状态。ENABLE:启用环境 / DISABLE:禁用环境 */ Status?: 'ENABLE' | 'DISABLE'; /** 云存储信息变更(不传或为空则不更新) */ Storage?: PlatformEnvResource; /** FlexDB(文档型数据库)状态更新(为空或不传则不更新) */ FlexDB?: PlatformEnvResource; } /** * ModifyPlatformEnv 返回结果 */ export interface ModifyPlatformEnvRes { /** 最终状态,如 manualLimited */ Status?: string; /** 唯一请求 ID */ RequestId: string; } /** * 平台版套餐信息 */ export interface PlatformPackageInfo { /** 套餐id */ PackageId?: string; /** 套餐名称 */ Name?: string; /** 计费下单参数(JSON 字符串) */ BillTags?: string; /** 套餐规格信息(JSON 字符串) */ Spec?: string; /** 套餐描述信息 */ Description?: string; /** 套餐数字id */ Id?: number; } /** * DescribePlatformPackageList 请求参数 */ export interface DescribePlatformPackageListParams { /** 平台版套餐id */ PackageId?: string; } /** * DescribePlatformPackageList 返回结果 */ export interface DescribePlatformPackageListRes { /** 平台版套餐列表 */ PackageList: PlatformPackageInfo[]; /** 唯一请求 ID */ RequestId: string; } /** * 平台版资源项信息(平台版套餐下的具体资源,如日志、云存储、静态托管) */ export interface PlatFormResourceInfo { /** 资源类型。log:日志 / storage:云存储 / hosting:静态托管 */ ResType?: string; /** 资源唯一标识 */ ResName?: string; /** 资源详细信息(JSON 字符串) */ Detail?: string; /** 资源状态。0:正常 / 5:初始化中 */ Status?: number; /** 资源id */ PlatformId?: number; /** 对应平台资源id */ Id?: number; } /** * 平台版资源信息 */ export interface PlatformInfo { /** 平台版套餐id */ PlatformId?: string; /** 套餐别名 */ Alias?: string; /** 套餐id */ PackageId?: string; /** 计费状态。normal:正常 / isolated:已隔离 / destroyed:已销毁 */ BillStatus?: string; /** 套餐资源状态。0:可用 / 5:发货中 */ Status?: number; /** 资源配置(JSON 字符串) */ Spec?: string; /** 购买时间,格式 'YYYY-MM-DD HH:mm:ss' */ BillTime?: string; /** 套餐过期时间,格式 'YYYY-MM-DD HH:mm:ss' */ ExpireTime?: string; /** 是否自动续费。0:未设置 / 1:自动续费 / 2:设置为到期不续费 */ IsAutoRenew?: number; /** 资源信息列表 */ Resources?: PlatFormResourceInfo[]; /** 所属地域。ap-shanghai:上海 / ap-singapore:新加坡 */ Region?: string; } /** * DescribePlatforms 请求参数 */ export interface DescribePlatformsParams { /** 平台版套餐id列表(不指定则分页返回当前账号下所有平台版资源) */ PlatformIds?: string[]; /** 分页限制,取值范围 [10, 100],默认 10 */ Limit?: number; /** 分页偏移量,默认 0 */ Offset?: number; } /** * DescribePlatforms 返回结果 */ export interface DescribePlatformsRes { /** 平台版资源列表 */ PlatformList: PlatformInfo[]; /** 总数 */ Total?: number; /** 唯一请求 ID */ RequestId: string; } /** * DescribePlatformAccountCircle 请求参数 */ export interface DescribePlatformAccountCircleParams { /** 平台版资源id */ PlatformId: string; /** false 仅返回当前套餐周期,true 返回当前周期以及上个、上上个周期 */ WithHistoryCircle?: boolean; } /** * DescribePlatformAccountCircle 返回结果 */ export interface DescribePlatformAccountCircleRes { /** 套餐计费周期开始时间 */ StartTime: string; /** 套餐计费周期结束时间 */ EndTime: string; /** 依次为当前套餐的上个、上上个历史周期(开始时间不早于下单时间,可能不足两个周期) */ HistoryTime?: CircleTime[]; /** 套餐当前是否过期 */ Expired?: boolean; /** 唯一请求 ID */ RequestId: string; } /** * 平台版每日资源点消耗数据 */ export interface PlatformCreditsUsageDaily { /** 日期 */ Date?: string; /** 资源点套餐内用量 */ DeductValue?: number; /** 资源点资源包用量 */ PackageDeductValue?: number; /** 资源点按量用量 */ ReportValue?: number; /** 资源点原价消耗 */ OriginCredits?: number; } /** * DescribePlatformCreditsUsage 请求参数 */ export interface DescribePlatformCreditsUsageParams { /** 开始日期,格式 'YYYY-MM-DD' */ StartDate: string; /** 结束日期,格式 'YYYY-MM-DD' */ EndDate: string; /** 平台版资源id */ PlatformId: string; } /** * DescribePlatformCreditsUsage 返回结果 */ export interface DescribePlatformCreditsUsageRes { /** 资源点套餐内抵扣总量 */ DeductValueCount?: number; /** 资源点资源包抵扣总量 */ PackageDeductValueCount?: number; /** 资源点按量上报总量 */ ReportValueCount?: number; /** 资源点原价消耗总量 */ OriginCreditsCount?: number; /** 每日资源点用量列表 */ DailyList?: PlatformCreditsUsageDaily[]; /** 唯一请求 ID */ RequestId: string; } /** * 模块内平台版资源点用量及原始用量数据 */ export interface PlatformPkgCreditsUsage { /** 平台版资源id */ PlatformId?: string; /** 模块 */ Module?: string; /** module 总资源点用量 */ CreditsValue?: number; /** 指标用量明细 */ MetricUsageDetail?: MetricUsage[]; /** 资源点套餐内用量 */ DeductValue?: number; /** 资源点资源包用量 */ PackageDeductValue?: number; /** 资源点按量用量 */ ReportValue?: number; /** 资源点原价消耗 */ OriginCredits?: number; } /** * DescribePlatformCreditsUsageDetail 请求参数 */ export interface DescribePlatformCreditsUsageDetailParams { /** 模块列表。枚举值: * FLEXDB 文档数据库 / TDSQL MYSQL数据库 / SCF 云函数 / AI 大模型 / EKS 云托管 / * COS 云存储 / HOSTING 静态托管 / Auth 用户权限 / APIInvocation API调用 / * HTTPInvocation HTTP调用 / VM 主机 / Workflow 工作流 / Other 其他 / * PostgreSQL PostgreSQL / Token Token */ Modules: string[]; /** 开始日期,格式 'YYYY-MM-DD' */ StartDate: string; /** 结束日期,格式 'YYYY-MM-DD' */ EndDate: string; /** 是否需要每日用量明细 */ NeedUsageDetails: boolean; /** 平台版资源id */ PlatformId: string; } /** * DescribePlatformCreditsUsageDetail 返回结果 */ export interface DescribePlatformCreditsUsageDetailRes { /** 用量数据 */ Usages: PlatformPkgCreditsUsage[]; /** 唯一请求 ID */ RequestId: string; } /** * 每日用量详情 */ export interface DailyUsageList { /** 资源点用量 */ Credits?: number; /** 资源点用量日期,格式 'YYYY-MM-DD' */ Date?: string; /** 原始资源用量 */ UsageValue?: number; } /** * 平台版指标用量信息 */ export interface PlatformMetricUsageItem { /** 指标名称 */ MetricName?: string; /** 原始资源类型。如 COS:对象存储 */ OriginalResourceType?: string; /** 原始指标名 */ OriginalMetricName?: string; /** 资源用量 */ UsageValue?: number; /** 资源用量单位,如 MB、Count */ UsageUnit?: string; /** 资源点 */ Credits?: number; /** 用量按日明细列表 */ DailyUsageList?: DailyUsageList[]; } /** * 平台版资源用量信息 */ export interface PlatformResUsageItem { /** 资源类型。Storage:云存储 / Function:云函数 / Database:数据库 / HOSTING:静态托管 / * Log:日志 / Gateway:网关 / Cloudrun:云托管 / Token:Token / EO:EdgeOne */ ResourceType?: string; /** 该资源类型的资源点总量 */ TotalCredits?: number; /** 指标用量信息 */ Metrics?: PlatformMetricUsageItem[]; } /** * DescribePlatformEnvUsage 请求参数 */ export interface DescribePlatformEnvUsageParams { /** 环境ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** 查询用量起始时间,格式 'YYYY-MM-DD' */ StartDate?: string; /** 查询用量结束时间,格式 'YYYY-MM-DD' */ EndDate?: string; /** 资源类型。Storage:云存储 / Function:云函数 / Database:数据库 / HOSTING:静态托管 / * Log:日志 / Gateway:网关 / Cloudrun:云托管 / Token:Token / EO:EdgeOne */ ResourceTypes?: string[]; /** 是否展示用量明细 */ NeedUsageDetails?: boolean; } /** * DescribePlatformEnvUsage 返回结果 */ export interface DescribePlatformEnvUsageRes { /** 资源用量信息 */ Resources?: PlatformResUsageItem[]; /** 资源点总量 */ TotalCredits?: number; /** 资源点取整倍数 */ CreditsScale?: number; /** 唯一请求 ID */ RequestId: string; } /** * 环境资源点排行项 */ export interface EnvCreditsRank { /** 环境id */ EnvId?: string; /** 总资源点用量 */ TotalCredits?: number; /** 资源点从上往下排行序号 */ Rank?: number; } /** * DescribePlatformEnvCreditsRanking 请求参数 */ export interface DescribePlatformEnvCreditsRankingParams { /** 平台版资源id */ PlatformId?: string; /** 查询时间范围。Today:近1天 / Recent7Days:近7天 / CurrentCycle:当前计费周期 / * PreviousCycle:上一个计费周期 / Previous2Cycle:上两个计费周期。默认 Today */ TimeRange?: string; /** 每页条数,默认 50 */ PageSize?: number; /** 分页 offset */ AfterRank?: number; } /** * DescribePlatformEnvCreditsRanking 返回结果 */ export interface DescribePlatformEnvCreditsRankingRes { /** 查询时间范围。Recent7Days:近7天 / Recent30Days:近30天 / CurrentCycle:当前计费周期 / * PreviousCycle:上一个计费周期 / Previous2Cycle:上两个计费周期 */ TimeRange?: string; /** 起始时间,格式 'YYYY-MM-DD HH:mm:ss' */ StartTime?: string; /** 结束时间,格式 'YYYY-MM-DD HH:mm:ss' */ EndTime?: string; /** 统计的截止时间,格式 'YYYY-MM-DD HH:mm:ss' */ DataAsOfTime?: string; /** 是否还有下一页数据 */ HasMore?: boolean; /** 下一条数据的 offset 值 */ NextAfterRank?: number; /** 总数量 */ TotalCount?: number; /** 资源点精度 */ CreditsScale?: number; /** 排行快照版本 */ SnapshotId?: string; /** 环境排行列表 */ Items?: EnvCreditsRank[]; /** 唯一请求 ID */ RequestId: string; } /** * DestroyPlatformEnv 请求参数 */ export interface DestroyPlatformEnvParams { /** 环境id */ EnvId: string; } /** * DestroyPlatformEnv 返回结果 */ export interface DestroyPlatformEnvRes { /** 唯一请求 ID */ RequestId: string; } /** * CreatePlatformEnv 请求参数 */ export interface CreatePlatformEnvParams { /** 环境别名 */ Alias: string; /** 套餐池标识 */ PlatformId: string; /** 幂等键 */ ReqKey: string; } /** * CreatePlatformEnv 返回结果 */ export interface CreatePlatformEnvRes { /** 环境id */ EnvId?: string; /** 唯一请求 ID */ RequestId: string; } /** * ModifyPlatformHTTPServiceRoute 请求参数 */ export interface ModifyPlatformHTTPServiceRouteParams { /** 平台id */ PlatformId: string; /** 域名路由信息(增量修改,对应字段不传则不修改) */ Domain: HTTPServiceDomainParam; } /** * ModifyPlatformHTTPServiceRoute 返回结果 */ export interface ModifyPlatformHTTPServiceRouteRes { /** 唯一请求 ID */ RequestId: string; } /** * CreatePlatformHTTPServiceRoute 请求参数 */ export interface CreatePlatformHTTPServiceRouteParams { /** 平台id */ PlatformId: string; /** 域名路由信息。不传 Domain.Routes 时仅创建域名信息 */ Domain: HTTPServiceDomainParam; } /** * CreatePlatformHTTPServiceRoute 返回结果 */ export interface CreatePlatformHTTPServiceRouteRes { /** 归属权校验不通过时返回的验证指引,按指引配置 DNS 或文件验证后, * 可调用 verifyPlatformHttpServiceRoute 验证归属权是否通过 */ OwnershipVerification?: OwnershipVerificationInfo; /** 唯一请求 ID */ RequestId: string; } /** * VerifyPlatformHTTPServiceRoute 请求参数 */ export interface VerifyPlatformHTTPServiceRouteParams { /** 平台id */ PlatformId: string; /** 域名路由信息 */ Domain: HTTPServiceDomainParam; } /** * VerifyPlatformHTTPServiceRoute 返回结果 */ export interface VerifyPlatformHTTPServiceRouteRes { /** 前置校验总开关。所有启用的检查项均为 PASS 或 SKIPPED 时为 true, * 任一检查项为 FAIL 时为 false */ Passed?: boolean; /** 域名归属权校验结果 */ Ownership?: VerifyHttpServiceRouteCheckItem; /** 证书校验结果;CertId 为空时 Status=SKIPPED */ Cert?: VerifyHttpServiceRouteCheckItem; /** 域名/路径数量配额校验结果 */ Quota?: VerifyHttpServiceRouteCheckItem; /** 同域名下路由路径冲突校验结果 */ RouteConflict?: VerifyHttpServiceRouteCheckItem; /** 域名被其他环境占用校验结果 */ DomainConflict?: VerifyHttpServiceRouteCheckItem; /** 内部域名且非内部账号校验结果 */ InternalAccount?: VerifyHttpServiceRouteCheckItem; /** 域名黑名单校验结果 */ Blacklist?: VerifyHttpServiceRouteCheckItem; /** AccessType=CDN 时 CDN 资源存在性/状态校验结果(含 ICP 未备案提示) */ CDNResource?: VerifyHttpServiceRouteCheckItem; /** AccessType=EO 时的 EdgeOne 预检结果(域名冲突/备案/归属权) */ EO?: VerifyHttpServiceRouteCheckItem; /** 唯一请求 ID */ RequestId: string; } /** * DeletePlatformHTTPServiceRoute 请求参数 */ export interface DeletePlatformHTTPServiceRouteParams { /** 平台id */ PlatformId: string; /** 域名 */ Domain: string; /** 路径列表。为空则表示删除此域名及所有路由;不为空则仅删除对应的 path 路由 */ Paths?: string[]; } /** * DeletePlatformHTTPServiceRoute 返回结果 */ export interface DeletePlatformHTTPServiceRouteRes { /** 唯一请求 ID */ RequestId: string; } /** * DescribePlatformHTTPServiceRoute 请求参数 */ export interface DescribePlatformHTTPServiceRouteParams { /** 平台id */ PlatformId: string; /** 过滤条件。可过滤: Domain、Path、DomainType、UpstreamResourceType。 * 过滤条件数量限制为 10,Values 单条不超过 100 */ Filters?: HTTPServiceRouteFilter[]; /** 分页偏移量,默认 0 */ Offset?: number; /** 分页限制,默认 20,最大值 1000 */ Limit?: number; } /** * DescribePlatformHTTPServiceRoute 返回结果 */ export interface DescribePlatformHTTPServiceRouteRes { /** 域名路由信息列表 */ Domains?: HTTPServiceDomain[]; /** 自定义接入的源站域名(HTTPService接入层域名) */ OriginDomain: string; /** 域名总数,分页查询使用总数判断是否已经拉取到所有数据 */ TotalCount: number; /** 唯一请求 ID */ RequestId: string; }