tencentcloud-sdk-nodejs
Version:
2,442 lines • 438 kB
TypeScript
/**
* DescribePublicConfigSummary请求参数结构体
*/
export interface DescribePublicConfigSummaryRequest {
/**
* 查询关键字,模糊查询:配置项名称,不传入时查询全量。
*/
SearchWord?: string;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为50。
*/
Limit?: number;
/**
* 排序字段。
- creation_time:按时间排序
- config_name:按名称排序
*/
OrderBy?: string;
/**
* 排序顺序。
- 0:升序
- 1:降序
*/
OrderType?: number;
/**
* TAG标签资源值。
*/
ConfigTagList?: Array<string>;
/**
* 忽略传参,业务预留字段。
*/
DisableProgramAuthCheck?: boolean;
/**
* 配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
*/
ConfigIdList?: Array<string>;
}
/**
* 文件配置项列表
*/
export interface TsfPageFileConfig {
/**
* 总数目
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount?: number;
/**
* 文件配置数组
注意:此字段可能返回 null,表示取不到有效值。
*/
Content?: Array<FileConfig>;
}
/**
* ModifyPathRewrite请求参数结构体
*/
export interface ModifyPathRewriteRequest {
/**
* 路径重写规则ID
*/
PathRewriteId: string;
/**
* 正则表达式
*/
Regex?: string;
/**
* 替换的内容
*/
Replacement?: string;
/**
* 是否屏蔽映射后路径,Y: 是 N: 否
*/
Blocked?: string;
/**
* 规则顺序,越小优先级越高
*/
Order?: number;
}
/**
* DescribeUnitRulesV2返回参数结构体
*/
export interface DescribeUnitRulesV2Response {
/**
* 分页列表信息
*/
Result?: TsfPageUnitRuleV2;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ApiDetailResponse描述
*/
export interface ApiDetailResponse {
/**
* API 请求参数
*/
Request?: Array<ApiRequestDescr>;
/**
* API 响应参数
注意:此字段可能返回 null,表示取不到有效值。
*/
Response?: Array<ApiResponseDescr>;
/**
* API 复杂结构定义
*/
Definitions?: Array<ApiDefinitionDescr>;
/**
* API 的 content type
注意:此字段可能返回 null,表示取不到有效值。
*/
RequestContentType?: string;
/**
* API 能否调试
*/
CanRun?: boolean;
/**
* API 状态 0:离线 1:在线,默认0
*/
Status?: number;
/**
* API 描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
}
/**
* DeleteCluster返回参数结构体
*/
export interface DeleteClusterResponse {
/**
* 删除集群操作是否成功。
true:操作成功。
false:操作失败。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* cos临时账号信息
*/
export interface CosCredentials {
/**
* 会话Token
*/
SessionToken?: string;
/**
* 临时应用ID
*/
TmpAppId?: string;
/**
* 临时调用者身份ID
*/
TmpSecretId?: string;
/**
* 临时密钥
*/
TmpSecretKey?: string;
/**
* 过期时间
*/
ExpiredTime?: number;
/**
* 所在域
*/
Domain?: string;
}
/**
* DeletePathRewrites返回参数结构体
*/
export interface DeletePathRewritesResponse {
/**
* true/false
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 路径重写翻页对象
*/
export interface PathRewritePage {
/**
* 总记录数
*/
TotalCount?: number;
/**
* 路径重写规则列表
*/
Content?: Array<PathRewrite>;
}
/**
* DescribeUnitApiUseDetail请求参数结构体
*/
export interface DescribeUnitApiUseDetailRequest {
/**
* 网关部署组ID
*/
GatewayDeployGroupId: string;
/**
* 网关分组Api ID
*/
ApiId: string;
/**
* 查询的日期,格式:yyyy-MM-dd HH:mm:ss
*/
StartTime: string;
/**
* 查询的日期,格式:yyyy-MM-dd HH:mm:ss
*/
EndTime: string;
/**
* 网关实例ID
*/
GatewayInstanceId: string;
/**
* 网关分组ID
*/
GroupId: string;
/**
* 翻页查询偏移量
*/
Offset: number;
/**
* 翻页查询每页记录数
*/
Limit: number;
/**
* 监控统计数据粒度
*/
Period?: number;
}
/**
* 集群详情
*/
export interface ClusterV2 {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterName?: string;
/**
* 集群描述
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterDesc?: string;
/**
* 集群类型,C表示容器集群,V表示虚拟机集群
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterType?: string;
/**
* 集群所属私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 集群状态
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterStatus?: string;
/**
* 集群CIDR
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterCIDR?: string;
/**
* 集群总CPU,单位: 核
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterTotalCpu?: number;
/**
* 集群总内存,单位: G
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterTotalMem?: number;
/**
* 集群已使用CPU,单位: 核
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterUsedCpu?: number;
/**
* 集群已使用内存,单位: G
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterUsedMem?: number;
/**
* 集群机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceCount?: number;
/**
* 集群运行中的机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
*/
RunInstanceCount?: number;
/**
* 集群正常状态的机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
*/
NormalInstanceCount?: number;
/**
* 删除标记:true:可以删除;false:不可删除
注意:此字段可能返回 null,表示取不到有效值。
*/
DeleteFlag?: boolean;
/**
* 创建时间,格式为YYYY-MM-DD HH:MM:SS
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 更新时间,格式为YYYY-MM-DD HH:MM:SS
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
/**
* 集群所属TSF地域ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TsfRegionId?: string;
/**
* 集群所属TSF地域名称
注意:此字段可能返回 null,表示取不到有效值。
*/
TsfRegionName?: string;
/**
* 集群所属TSF可用区ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TsfZoneId?: string;
/**
* 集群所属TSF可用区名称
注意:此字段可能返回 null,表示取不到有效值。
*/
TsfZoneName?: string;
/**
* 集群不可删除的原因
注意:此字段可能返回 null,表示取不到有效值。
*/
DeleteFlagReason?: string;
/**
* 集群所属私有网络子网ID
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId?: string;
/**
* 集群剩余 cpu limit
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterLimitCpu?: string;
/**
* 集群剩余 memory limit
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterLimitMem?: string;
/**
* 运行服务实例数
注意:此字段可能返回 null,表示取不到有效值。
*/
RunServiceInstanceCount?: number;
/**
* 给前端的按钮控制信息
注意:此字段可能返回 null,表示取不到有效值。
*/
OperationInfo?: OperationInfo;
/**
* 容器集群版本
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterVersion?: string;
/**
* 部署组总数
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupCount?: number;
/**
* 运行中部署组数
注意:此字段可能返回 null,表示取不到有效值。
*/
RunGroupCount?: number;
/**
* 停止中部署组数
注意:此字段可能返回 null,表示取不到有效值。
*/
StopGroupCount?: number;
/**
* 异常部署组数
注意:此字段可能返回 null,表示取不到有效值。
*/
AbnormalGroupCount?: number;
/**
* 集群备注名
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterRemarkName?: string;
/**
* api地址
注意:此字段可能返回 null,表示取不到有效值。
*/
KuberneteApiServer?: string;
/**
* K 表示通过kubeconfig 导入, S 表示通过service account导入
注意:此字段可能返回 null,表示取不到有效值。
*/
KuberneteNativeType?: string;
/**
* Kubernetes 密钥
注意:此字段可能返回 null,表示取不到有效值。
*/
KuberneteNativeSecret?: string;
/**
* 是否开启cls日志功能
*/
EnableLogCollection?: boolean;
/**
* 集群状态的原因
*/
Reason?: string;
}
/**
* ModifyApplication返回参数结构体
*/
export interface ModifyApplicationResponse {
/**
* true表示修改成功,false表示修改失败
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* LicenseTag 翻页对象
*/
export interface TsfPageLicenseTag {
/**
* 记录总数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount?: number;
/**
* 记录实体列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Content?: Array<LicenseTag>;
}
/**
* DescribeApiVersions返回参数结构体
*/
export interface DescribeApiVersionsResponse {
/**
* API版本列表。
*/
Result?: Array<ApiVersionArray>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReassociateBusinessLogConfig请求参数结构体
*/
export interface ReassociateBusinessLogConfigRequest {
/**
* 原关联日志配置ID
*/
ConfigId: string;
/**
* 新关联日志配置ID
*/
NewConfigId: string;
/**
* TSF应用ID
*/
ApplicationId: string;
/**
* TSF部署组ID
*/
GroupId: string;
}
/**
* StopContainerGroup返回参数结构体
*/
export interface StopContainerGroupResponse {
/**
* 停止操作是否成功。
true:停止成功
false:停止失败
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConfigTemplateWithDetailResp返回参数结构体
*/
export interface CreateConfigTemplateWithDetailRespResponse {
/**
* 创建成功,返回配置模板ID。
*/
Result?: ConfigTemplate;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeletePathRewrites请求参数结构体
*/
export interface DeletePathRewritesRequest {
/**
* 路径重写规则IDs
*/
PathRewriteIds: Array<string>;
}
/**
* DeleteLane返回参数结构体
*/
export interface DeleteLaneResponse {
/**
* 删除结果。
- true:删除成功
- false:删除失败
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGroupRelease请求参数结构体
*/
export interface DescribeGroupReleaseRequest {
/**
* 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
*/
GroupId: string;
}
/**
* 模糊查询数据集信息指定字段和值
*/
export interface SearchFiltersProgram {
/**
* <p>数据集ID</p>
*/
ProgramId?: string;
/**
* <p>数据集名称</p>
*/
ProgramName?: string;
}
/**
* DescribeConfigTemplate返回参数结构体
*/
export interface DescribeConfigTemplateResponse {
/**
* 导入结果。
*/
Result?: ConfigTemplate;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 分页的 ContainerEvent
*/
export interface TsfPageContainerEvent {
/**
* 返回个数
*/
TotalCount: number;
/**
* events 数组
*/
Content: Array<ContainerEvent>;
}
/**
* DescribeLicenses请求参数结构体
*/
export interface DescribeLicensesRequest {
/**
* 偏移量
*/
Offset?: number;
/**
* 每页条数
*/
Limit?: number;
}
/**
* DescribeDeliveryConfig返回参数结构体
*/
export interface DescribeDeliveryConfigResponse {
/**
* 投递kafka配置
*/
Result?: KafkaDeliveryConfig;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 强制调度配置
*/
export interface ForceSchedule {
/**
* -
*/
AffinityList?: Array<Affinity>;
/**
* -
*/
AntiAffinityList?: Array<Affinity>;
}
/**
* 简单应用
*/
export interface SimpleApplication {
/**
* 应用ID
*/
ApplicationId?: string;
/**
* 应用名称
*/
ApplicationName?: string;
/**
* 应用类型
*/
ApplicationType?: string;
/**
* 应用微服务类型
*/
MicroserviceType?: string;
/**
* ApplicationDesc
*/
ApplicationDesc?: string;
/**
* ProgLang
*/
ProgLang?: string;
/**
* ApplicationResourceType
*/
ApplicationResourceType?: string;
/**
* CreateTime
*/
CreateTime?: string;
/**
* UpdateTime
*/
UpdateTime?: string;
/**
* ApigatewayServiceId
*/
ApigatewayServiceId?: string;
/**
* ApplicationRuntimeType
*/
ApplicationRuntimeType?: string;
/**
* Apm业务系统id
*/
AmpInstanceId?: string;
/**
* Apm业务系统Name
*/
ApmInstanceName?: string;
}
/**
* DescribeSimpleNamespaces返回参数结构体
*/
export interface DescribeSimpleNamespacesResponse {
/**
* 命名空间分页列表
*/
Result?: TsfPageNamespace;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSimpleApplications返回参数结构体
*/
export interface DescribeSimpleApplicationsResponse {
/**
* 简单应用分页对象
*/
Result?: TsfPageSimpleApplication;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRepository返回参数结构体
*/
export interface DeleteRepositoryResponse {
/**
* 删除仓库是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteApplication返回参数结构体
*/
export interface DeleteApplicationResponse {
/**
* 删除应用操作是否成功。
true:操作成功。
false:操作失败。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 分位数据模型
*/
export interface QuantileEntity {
/**
* 最大值
注意:此字段可能返回 null,表示取不到有效值。
*/
MaxValue?: string;
/**
* 最小值
注意:此字段可能返回 null,表示取不到有效值。
*/
MinValue?: string;
/**
* 五分位值
注意:此字段可能返回 null,表示取不到有效值。
*/
FifthPositionValue?: string;
/**
* 九分位值
注意:此字段可能返回 null,表示取不到有效值。
*/
NinthPositionValue?: string;
}
/**
* ModifyProgram请求参数结构体
*/
export interface ModifyProgramRequest {
/**
* 数据集ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)查询接口会返回数据集信息,包括programId
*/
ProgramId: string;
/**
* 数据集名称,不传入时不更新
*/
ProgramName?: string;
/**
* 数据集描述,不传入时不更新
*/
ProgramDesc?: string;
/**
* 数据项列表,传入null不更新,传入空数组全量删除
*/
ProgramItemList?: Array<ProgramItem>;
/**
* ProgramItemList是否是空数组
*/
EmptyProgramItemList?: boolean;
}
/**
* DescribeSimpleGroups返回参数结构体
*/
export interface DescribeSimpleGroupsResponse {
/**
* 简单部署组列表
*/
Result?: TsfPageSimpleGroup;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConfigs返回参数结构体
*/
export interface DescribeConfigsResponse {
/**
* 分页后的配置项列表。
*/
Result?: TsfPageConfig;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyContainerReplicas请求参数结构体
*/
export interface ModifyContainerReplicasRequest {
/**
* 部署组ID,部署组唯一标识,可以通过[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的容器部署组列表;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的容器部署组
*/
GroupId: string;
/**
* 实例数量
*/
InstanceNum: number;
}
/**
* ReleaseFileConfig请求参数结构体
*/
export interface ReleaseFileConfigRequest {
/**
* 配置ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1&subTab=file)配置详情-配置版本页查看;也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。
*/
ConfigId: string;
/**
* 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
*/
GroupId: string;
/**
* 发布描述,最多支持200个字符。
*/
ReleaseDesc?: string;
}
/**
* 标签
*/
export interface Tag {
/**
* 标签键
*/
TagKey?: string;
/**
* 标签值
*/
TagValue?: string;
}
/**
* DescribeInvocationMetricDataDimension返回参数结构体
*/
export interface DescribeInvocationMetricDataDimensionResponse {
/**
* 维度
*/
Result?: TsfPageDimension;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchStdoutLog返回参数结构体
*/
export interface SearchStdoutLogResponse {
/**
* 标准输出日志列表
*/
Result?: TsfPageStdoutLogV2;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGatewayApi返回参数结构体
*/
export interface CreateGatewayApiResponse {
/**
* 是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFileConfigs返回参数结构体
*/
export interface DescribeFileConfigsResponse {
/**
* 文件配置项列表。
*/
Result?: TsfPageFileConfig;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusters请求参数结构体
*/
export interface DescribeClustersRequest {
/**
* 搜索词,可以搜索ID/名称/备注/标签
*/
SearchWord?: string;
/**
* 排序字段,目前仅支持使用“创建时间”
*/
OrderBy?: string;
/**
* 排序方式,0表示升序,1表示倒序
*/
OrderType?: number;
/**
* 偏移量,默认0
*/
Offset?: number;
/**
* 分页个数,0-50 之间,默认20
*/
Limit?: number;
/**
* 集群类型,C表示容器集群,V表示虚拟机集群
*/
ClusterType?: string;
/**
* idList
*/
ClusterIdList?: Array<string>;
}
/**
* DescribeApiVersions请求参数结构体
*/
export interface DescribeApiVersionsRequest {
/**
* 微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
*/
MicroserviceId: string;
/**
* API请求路径。
*/
Path?: string;
/**
* API请求方法。
- GET
- POST
- PUT
- DELETE
- HEAD
- PATCH
- OPTIONS
*/
Method?: string;
}
/**
* DeleteConfigTemplate返回参数结构体
*/
export interface DeleteConfigTemplateResponse {
/**
* true:删除成功;false:删除失败
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGroupBindedGateways返回参数结构体
*/
export interface DescribeGroupBindedGatewaysResponse {
/**
* 翻页结构体
*/
Result?: TsfPageGatewayDeployGroup;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeJvmMonitor请求参数结构体
*/
export interface DescribeJvmMonitorRequest {
/**
* 查询的实例ID
可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk
*/
InstanceId: string;
/**
* 实例所属应用ID
可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已经存在的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)查看。应用ID例如:application-v378ewna
*/
ApplicationId: string;
/**
* 时间粒度,单位:秒
*/
TimeGranularity: number;
/**
* 查询数据起始时间格式(yyyy-MM-dd HH:mm:ss)
*/
From: string;
/**
* 查询数据结束时间格式(yyyy-MM-dd HH:mm:ss)
*/
To: string;
/**
* 查询的监控图列表,以返回值属性名作为入参,可选值:
heapMemory:堆内存监控图;nonHeapMemory:非堆内存监控图;edenSpace:伊甸区监控图;survivorSpace:幸存者区监控图;oldSpace:老年代监控图;metaSpace:元空间监控图;youngGC:youngGC增量监控图;fullGC:fullGC增量监控图;cpuUsage:cpu使用率监控图;classCount:加载类数监控图;threadPicture:线程图
*/
RequiredPictures: Array<string>;
/**
* 扩展字段
*/
Tag?: string;
}
/**
* EnableLaneRule请求参数结构体
*/
export interface EnableLaneRuleRequest {
/**
* 灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lanerule)查看;也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。
*/
RuleId: string;
}
/**
* UnbindApiGroup请求参数结构体
*/
export interface UnbindApiGroupRequest {
/**
* 分组网关id列表
*/
GroupGatewayList: Array<GatewayGroupIds>;
}
/**
* CreateNamespace返回参数结构体
*/
export interface CreateNamespaceResponse {
/**
* 成功时为命名空间ID,失败为null
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyUploadInfo返回参数结构体
*/
export interface ModifyUploadInfoResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EnableLaneRule返回参数结构体
*/
export interface EnableLaneRuleResponse {
/**
* 操作状态。
- true:成功
- false:失败
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TsfPage<Config>
*/
export interface TsfPageConfig {
/**
* TsfPageConfig
*/
TotalCount?: number;
/**
* 配置项列表
*/
Content?: Array<Config>;
}
/**
* CreateProgram请求参数结构体
*/
export interface CreateProgramRequest {
/**
* 数据集名称
*/
ProgramName: string;
/**
* 数据集描述
*/
ProgramDesc?: string;
/**
* 数据项列表,传入null或空数组时不新增
*/
ProgramItemList?: Array<ProgramItem>;
}
/**
* CreateApiRateLimitRule请求参数结构体
*/
export interface CreateApiRateLimitRuleRequest {
/**
* Api Id
*/
ApiId: string;
/**
* qps值
*/
MaxQps: number;
/**
* 开启/禁用,enabled/disabled, 不传默认开启
*/
UsableStatus?: string;
}
/**
* DisableLaneRule返回参数结构体
*/
export interface DisableLaneRuleResponse {
/**
* 操作状态。
- true:成功
- false:失败
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssociateBusinessLogConfig请求参数结构体
*/
export interface AssociateBusinessLogConfigRequest {
/**
* 部署组ID
可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
*/
GroupId: string;
/**
* 日志配置项ID列表
可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
*/
ConfigIdList?: Array<string>;
}
/**
* DescribeJvmMonitor返回参数结构体
*/
export interface DescribeJvmMonitorResponse {
/**
* Java实例jvm监控数据
*/
Result?: JvmMonitorData;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeliveryConfig请求参数结构体
*/
export interface DescribeDeliveryConfigRequest {
/**
* 日志配置项ID
可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
*/
ConfigId: string;
}
/**
* ChangeApiUsableStatus请求参数结构体
*/
export interface ChangeApiUsableStatusRequest {
/**
* API ID
*/
ApiId: string;
/**
* 切换状态,enabled/disabled
*/
UsableStatus: string;
}
/**
* DescribeMicroservices返回参数结构体
*/
export interface DescribeMicroservicesResponse {
/**
* 微服务分页列表信息。
*/
Result?: TsfPageMicroservice;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeApiRateLimitRules请求参数结构体
*/
export interface DescribeApiRateLimitRulesRequest {
/**
* Api ID
*/
ApiId: string;
}
/**
* DescribeApiGroups返回参数结构体
*/
export interface DescribeApiGroupsResponse {
/**
* 翻页结构体
*/
Result?: TsfPageApiGroupInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeletePublicConfig请求参数结构体
*/
export interface DeletePublicConfigRequest {
/**
* 配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
*/
ConfigId: string;
}
/**
* DeleteNamespace返回参数结构体
*/
export interface DeleteNamespaceResponse {
/**
* 删除命名空间是否成功。
true:删除成功。
false:删除失败。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMicroservice请求参数结构体
*/
export interface CreateMicroserviceRequest {
/**
* <p>命名空间ID。该参数可以通过调用 <a href="https://cloud.tencent.com/document/api/649/36096">DescribeSimpleNamespaces</a> 的返回值中的 NamespaceId 字段来获取或通过登录<a href="https://console.cloud.tencent.com/tsf/resource?tab=namespace">控制台</a>查看;也可以调用<a href="https://cloud.tencent.com/document/product/649/36098">CreateNamespace</a>创建新的命名空间。</p>
*/
NamespaceId: string;
/**
* <p>微服务名称。该参数可以通过调用 <a href="https://cloud.tencent.com/document/product/649/36084">DescribeMicroservices</a> 的返回值中的 MicroserviceName 字段来获取或通过登录<a href="https://console.cloud.tencent.com/tse/tsf-consul?tab=service">控制台</a>查看;也可以调用<a href="https://cloud.tencent.com/document/product/649/85860">CreateMicroserviceWithDetailResp</a>创建新的微服务。</p>
*/
MicroserviceName: string;
/**
* <p>微服务备注信息,最多支持200个字符。</p>
*/
MicroserviceDesc?: string;
/**
* <p>服务类型,默认SDK</p><p>枚举值:</p><ul><li>SDK: sdk服务</li><li>MESH_EXTERNAL: mesh外部服务</li></ul>
*/
ServiceType?: string;
/**
* <p>域名+端口,或者是纯域名方式,其他的不允许配置,不支持 IP</p>
*/
ServiceUrl?: string;
/**
* <p>协议类型</p>
*/
Protocol?: string;
/**
* <p>服务发现方式</p><p>枚举值:</p><ul><li>DNS: DNS方式</li></ul>
*/
ServiceDiscovery?: string;
}
/**
* ReleaseConfig返回参数结构体
*/
export interface ReleaseConfigResponse {
/**
* 发布结果。
- true:发布成功
- false:发布失败
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUnitRule返回参数结构体
*/
export interface DescribeUnitRuleResponse {
/**
* 单元化规则对象
*/
Result?: UnitRule;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteImageTags请求参数结构体
*/
export interface DeleteImageTagsRequest {
/**
* 需要删除的镜像版本列表,可通过调用[DescribeImageTags](https://cloud.tencent.com/document/api/649/36052)查询已创建的镜像版本列表或登录控制台进行查看。
*/
ImageTags: Array<DeleteImageTag>;
/**
* 企业: tcr ;个人: personal或者不填
*/
RepoType?: string;
}
/**
* DescribeRepositories请求参数结构体
*/
export interface DescribeRepositoriesRequest {
/**
* 查询关键字(按照仓库名称搜索)
*/
SearchWord?: string;
/**
* 查询起始偏移,大于等于0,默认值为0
*/
Offset?: number;
/**
* 返回数量限制,大于0,默认为不分页
*/
Limit?: number;
/**
* 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo)
*/
RepositoryType?: string;
}
/**
* 监控数据散点图
*/
export interface InvocationMetricScatterPlot {
/**
* 时间轴截止时间,GMT,精确到毫秒
*/
EndTime?: number;
/**
* 时间粒度
*/
StartTime?: number;
/**
* 时间轴开始时间,GMT,精确到毫秒
*/
Period?: number;
/**
* 多值数据点集合
*/
DataPoints?: Array<MultiValueDataPoints>;
}
/**
* RollbackConfig请求参数结构体
*/
export interface RollbackConfigRequest {
/**
* 配置项发布历史ID。该参数可以通过调用 [DescribeConfigReleaseLogs](https://cloud.tencent.com/document/product/649/38343) 的返回值中的 ConfigReleaseLogId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
*/
ConfigReleaseLogId: string;
/**
* 回滚描述,最多支持200个字符。
*/
ReleaseDesc?: string;
}
/**
* DisassociateBusinessLogConfig返回参数结构体
*/
export interface DisassociateBusinessLogConfigResponse {
/**
* 操作结果,true:成功,false:失败。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGatewayApi请求参数结构体
*/
export interface CreateGatewayApiRequest {
/**
* API 分组ID
*/
GroupId: string;
/**
* Api信息
*/
ApiList: Array<ApiInfo>;
/**
* 无
*/
ProgramIdList?: Array<string>;
}
/**
* DescribeCreateGatewayApiStatus返回参数结构体
*/
export interface DescribeCreateGatewayApiStatusResponse {
/**
* 导入任务状态执行结果。
- true:已完成
- false:未完成
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteConfig返回参数结构体
*/
export interface DeleteConfigResponse {
/**
* 删除结果。
- true:删除成功
- false:删除失败
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGroupGateways请求参数结构体
*/
export interface DescribeGroupGatewaysRequest {
/**
* 网关部署组ID
*/
GatewayDeployGroupId: string;
/**
* 翻页查询偏移量
*/
Offset: number;
/**
* 翻页查询每页记录数
*/
Limit: number;
/**
* 搜索关键字
*/
SearchWord?: string;
}
/**
* UpdateApiRateLimitRule返回参数结构体
*/
export interface UpdateApiRateLimitRuleResponse {
/**
* 是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGatewayAllGroupApis返回参数结构体
*/
export interface DescribeGatewayAllGroupApisResponse {
/**
* 网关分组和API列表信息
*/
Result?: GatewayVo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeployContainerApplication返回参数结构体
*/
export interface DeployContainerApplicationResponse {
/**
* <p>部署容器应用是否成功。<br>true:成功。<br>false:失败。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: DeployContainerApplicationResp;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 泳道规则
*/
export interface LaneRule {
/**
* 泳道规则ID
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleId?: string;
/**
* 泳道规则名称
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleName?: string;
/**
* 优先级
注意:此字段可能返回 null,表示取不到有效值。
*/
Priority?: number;
/**
* 备注
注意:此字段可能返回 null,表示取不到有效值。
*/
Remark?: string;
/**
* 泳道规则标签列表
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleTagList?: Array<LaneRuleTag>;
/**
* 泳道规则标签关系
注意:此字段可能返回 null,表示取不到有效值。
*/
RuleTagRelationship?: string;
/**
* 泳道ID
注意:此字段可能返回 null,表示取不到有效值。
*/
LaneId?: string;
/**
* 开启状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Enable?: boolean;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: number;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: number;
}
/**
* 微服务实例信息
*/
export interface MsInstance {
/**
* 机器实例ID信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 机器实例名称信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceName?: string;
/**
* 服务运行的端口号
注意:此字段可能返回 null,表示取不到有效值。
*/
Port?: string;
/**
* 机器实例内网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
LanIp?: string;
/**
* 机器实例外网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
WanIp?: string;
/**
* 机器可用状态
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceAvailableStatus?: string;
/**
* 服务运行状态
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceInstanceStatus?: string;
/**
* 应用ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationId?: string;
/**
* 应用名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationName?: string;
/**
* 集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
/**
* 集群名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterName?: string;
/**
* 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
*/
NamespaceId?: string;
/**
* 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
*/
NamespaceName?: string;
/**
* 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupId?: string;
/**
* 部署组名称
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupName?: string;
/**
* 机器TSF可用状态
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceStatus?: string;
/**
* 健康检查URL
注意:此字段可能返回 null,表示取不到有效值。
*/
HealthCheckUrl?: string;
/**
* 集群类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterType?: string;
/**
* 应用程序包版本
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationPackageVersion?: string;
/**
* 应用类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationType?: string;
/**
* 服务状态,passing 在线,critical 离线
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceStatus?: string;
/**
* 注册时间
注意:此字段可能返回 null,表示取不到有效值。
*/
RegistrationTime?: number;
/**
* 上次心跳时间
注意:此字段可能返回 null,表示取不到有效值。
*/
LastHeartbeatTime?: number;
/**
* 实例注册id
注意:此字段可能返回 null,表示取不到有效值。
*/
RegistrationId?: string;
/**
* 屏蔽状态,hidden 为屏蔽,unhidden 为未屏蔽
注意:此字段可能返回 null,表示取不到有效值。
*/
HiddenStatus?: string;
/**
* json格式的 meta 信息
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaJson?: string;
}
/**
* HttpGet 执行内容
*/
export interface HttpGetOption {
/**
* 主机地址
注意:此字段可能返回 null,表示取不到有效值。
*/
Host?: string;
/**
* 路径
注意:此字段可能返回 null,表示取不到有效值。
*/
Path?: string;
/**
* 端口
注意:此字段可能返回 null,表示取不到有效值。
*/
Port?: string;
/**
* 协议:HTTP|HTTPS
注意:此字段可能返回 null,表示取不到有效值。
*/
Scheme?: string;
}
/**
* 微服务网关插件绑定对象
*/
export interface GatewayPluginBoundParam {
/**
* 插件id
*/
PluginId: string;
/**
* 插件绑定到的对象类型:group/api/all
*/
ScopeType: string;
/**
* 插件绑定到的对象主键值,例如分组的ID/API的ID
*/
ScopeValue: string;
/**
* 创建关联的服务id,关联envoy网关时使用
*/
MicroserviceId?: string;
/**
* 网关id
*/
GatewayInstanceId?: string;
}
/**
* ModifyNamespace返回参数结构体
*/
export interface ModifyNamespaceResponse {
/**
* Result
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLaneRule请求参数结构体
*/
export interface ModifyLaneRuleRequest {
/**
* <p>灰度发布规则ID。该参数可以通过调用 <a href="https://cloud.tencent.com/document/product/649/44505">DescribeLaneRules</a> 的返回值中的 RuleId 字段来获取或通过登录<a href="https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lanerule">控制台</a>查看;也可以调用<a href="https://cloud.tencent.com/document/product/649/44507">CreateLaneRule</a>创建新的灰度发布规则。</p>
*/
RuleId: string;
/**
* <p>灰度发布规则名称,最多支持60个字符,支持中英文字符。</p>
*/
RuleName: string;
/**
* <p>灰度发布规则备注,最多支持200个字符。</p>
*/
Remark: string;
/**
* <p>灰度发布规则标签列表。</p>
*/
RuleTagList: Array<LaneRuleTag>;
/**
* <p>泳道配置ID。该参数可以通过调用 <a href="https://cloud.tencent.com/document/product/649/44504">DescribeLanes</a> 的返回值中的 LaneId 字段来获取或通过登录<a href="https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lane">控制台</a>查看;也可以调用<a href="https://cloud.tencent.com/document/product/649/44508">CreateLane</a>创建新的泳道配置。</p>
*/
LaneId: string;
/**
* <p>开启状态。</p><ul><li>true:开启</li><li>false:关闭</li></ul>
*/
Enable: boolean;
/**
* <p>灰度发布规则标签关系。- RELEATION_AND:与- RELEATION_OR:或</p>
*/
RuleTagRelationship?: string;
}
/**
* AddInstances返回参数结构体
*/
export interface AddInstancesResponse {
/**
* 添加云主机是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 虚拟机部署组信息
*/
export interface VmGroup {
/**
* <p>部署组ID</p>
*/
GroupId?: string;
/**
* <p>部署组名称</p>
*/
GroupName?: string;
/**
* <p>部署组状态</p>
*/
GroupStatus?: string;
/**
* <p>程序包ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageId?: string;
/**
* <p>程序包名称</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageName?: string;
/**
* <p>程序包版本号</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageVersion?: string;
/**
* <p>集群ID</p>
*/
ClusterId?: string;
/**
* <p>集群名称</p>
*/
ClusterName?: string;
/**
* <p>命名空间ID</p>
*/
NamespaceId?: string;
/**
* <p>命名空间名称</p>
*/
NamespaceName?: string;
/**
* <p>应用ID</p>
*/
ApplicationId?: string;
/**
* <p>应用名称</p>
*/
ApplicationName?: string;
/**
* <p>部署组机器数目</p>
*/
InstanceCount?: number;
/**
* <p>部署组运行中机器数目</p>
*/
RunInstanceCount?: number;
/**
* <p>部署组启动参数信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
StartupParameters?: string;
/**
* <p>部署组创建时间</p>
*/
CreateTime?: string;
/**
* <p>部署组更新时间</p>
*/
UpdateTime?: string;
/**
* <p>部署组停止机器数目</p>
*/
OffInstanceCount?: number;
/**
* <p>部署组描述信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupDesc?: string;
/**
* <p>微服务类型</p>
*/
MicroserviceType?: string;
/**
* <p>应用类型</p>
*/
ApplicationType?: string;
/**
* <p>部署组资源类型</p>
*/
GroupResourceType?: string;
/**
* <p>部署组更新时间戳</p>
*/
UpdatedTime?: number;
/**
* <p>部署应用描述信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
DeployDesc?: string;
/**
* <p>滚动发布的更新方式</p>
*/
UpdateType?: number;
/**
* <p>发布是否启用beta批次</p>
*/
DeployBetaEnable?: boolean;
/**
* <p>滚动发布的批次比例列表</p>
*/
DeployBatch?: Array<number>;
/**
* <p>滚动发布的批次执行方式</p>
*/
DeployExeMode?: string;
/**
* <p>滚动发布的每个批次的等待时间</p>
*/
DeployWaitTime?: number;
/**
* <p>是否开启了健康检查</p>
*/
EnableHealthCheck?: boolean;
/**
* <p>健康检查配置</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
HealthCheckSettings?: HealthCheckSettings;
/**
* <p>程序包类型</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
PackageType?: string;
/**
* <p>启动脚本 base64编码</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
StartScript?: string;
/**
* <p>停止脚本 base64编码</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
StopScript?: string;
/**
* <p>部署组备注</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Alias?: string;
/**
* <p>javaagent信息</p>
*/
AgentProfileList?: Array<AgentProfile>;
/**
* <p>预热属性配置</p>
*/
WarmupSetting?: WarmupSetting;
/**
* <p>Envoy网关配置</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
GatewayConfig?: GatewayConfig;
/**
* <p>批次是否开启健康检查</p>
*/
EnableBatchHealthCheck?: boolean;
/**
* <p>是否开启cgroup控制内存cpu</p>
*/
FilebeatCgroupEnable?: boolean;
/**
* <p>filebeat使用cpu上限</p>
*/
FilebeatMaxCpu?: number;
/**
* <p>filebeat使用内存上限</p>
*/
FilebeatMaxMem?: number;
/**
* <p>仓库ID</p>
*/
RepositoryId?: string;
/**
* <p>仓库名称</p>
*/
RepositoryName?: string;
/**
* <p>仓库类型</p>
*/
RepositoryType?: string;
/**
* <p>是否自动重启</p>
*/
LivenessAutoRestart?: boolean;
}
/**
* DescribeResourceConfig返回参数结构体
*/
export interface DescribeResourceConfigResponse {
/**
* 配置详情
*/
Result?: DescribeResourceConfigResultV2;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StartContainerGroup请求参数结构体
*/
export interface StartContainerGroupRequest {
/**
* 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
*/
GroupId: string;
}
/**
* DescribeRepository返回参数结构体
*/
export interface DescribeRepositoryResponse {
/**
* 查询的仓库信息
*/
Result?: RepositoryInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReleaseConfigWithDetailResp返回参数结构体
*/
export interface ReleaseConfigWithDetailRespResponse {
/**
* 配置项发布ID。
*/
Result?: ConfigRelease;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 机器实例
*/
export interface Instance {
/**
* 机器实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 机器名称
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceName?: string;
/**
* 机器内网地址IP
注意:此字段可能返回 null,表示取不到有效值。
*/
LanIp?: string;
/**
* 机器外网地址IP
注意:此字段可能返回 null,表示取不到有效值。
*/
WanIp?: string;
/**
* 机器描述信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceDesc?: string;
/**
* 集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
/**
* 集群名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterName?: string;
/**
* VM的状态 虚机:虚机的状态 容器:Pod所在虚机的状态
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceStatus?: string;
/**
* VM的可使用状态 虚机:虚机是否能够作为资源使用 容器:虚机是否能够作为资源部署POD
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceAvailableStatus?: string;
/**
* 服务下的服务实例的状态 虚机:应用是否可用 + Agent状态 容器:Pod状态
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceInstanceStatus?: string;
/**
* 标识此instance是否已添加在tsf中
注意:此字段可能返回 null,表示取不到有效值。
*/
CountInTsf?: number;
/**
* 机器所属部署组ID
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupId?: string;
/**
* 机器所属应用ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationId?: string;
/**
* 机器所属应用名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationName?: string;
/**
* 机器实例在CVM的创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceCreatedTime?: string;
/**
* 机器实例在CVM的过期时间
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceExpiredTime?: string;
/**
* 机器实例在CVM的计费模式
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceChargeType?: string;
/**
* 机器实例总CPU信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceTotalCpu?: number;
/**
* 机器实例总内存信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceTotalMem?: number;
/**
* 机器实例使用的CPU信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceUsedCpu?: number;
/**
* 机器实例使用的内存信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceUsedMem?: number;
/**
* 机器实例Limit CPU信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceLimitCpu?: number;
/**
* 机器实例Limit 内存信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceLimitMem?: number;
/**
* 包版本
注意:此字段可能返回 null,表示取不到有效值。
*/
InstancePkgVersion?: string;
/**
* 集群类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterType?: string;
/**
* 机器实例业务状态
注意:此字段可能返回 null,表示取不到有效值。
*/
RestrictState?: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
/**
* 实例执行状态
注意:此字段可能返回 null,表示取不到有效值。
*/
OperationState?: number;
/**
* NamespaceId Ns ID
注意:此字段可能返回 null,表示取不到有效值。
*/
NamespaceId?: string;
/**
* InstanceZoneId 可用区ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceZoneId?: string;
/**
* InstanceImportMode 导入模式
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceImportMode?: string;
/**
* ApplicationType应用类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationType?: string;
/**
* ApplicationResourceType 资源类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationResourceType?: string;
/**
* sidecar状态
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceSidecarStatus?: string;
/**
* 部署组名
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupName?: string;
/**
* NS名
注意:此字段可能返回 null,表示取不到有效值。
*/
NamespaceName?: string;
/**
* 健康检查原因
注意:此字段可能返回 null,表示取不到有效值。
*/
Reason?: string;
/**
* agent版本
注意:此字段可能返回 null,表示取不到有效值。
*/
AgentVersion?: string;
/**
* 容器母机实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeInstanceId?: string;
}
/**
* UpdateHealthCheckSettings请求参数结构体
*/
export interface UpdateHealthCheckSettingsRequest {
/**
* <p>部署组ID,可通过调用<a href="https://cloud.tencent.com/document/api/649/36068">DescribeContainerGroups</a>查询已创建的部署组列表或登录控制台进行查看;也可以调用<a href="https://cloud.tencent.com/document/api/649/36075">CreateContainGroup</a>创建新的部署组。</p>
*/
GroupId: string;
/**
* <p>是否开启健康检查</p>
*/
EnableHealthCheck?: boolean;
/**
* <p>健康检查配置</p>
*/
HealthCheckSettings?: HealthCheckSettings;
/**
* <p>是否自动重启</p>
*/
LivenessAutoRestart?: boolean;
}
/**
* ScalableRule值
*/
export interface ScalableRule {
/**
* RuleId值
*/
RuleId?: string;
/**
* Name值
*/
Name?: string;
/**
* ExpandVmCountLimit值
*/
ExpandVmCountLimit?: number;
/**
* ShrinkVmCountLimit值
*/
ShrinkVmCountLimit?: number;
/**
* GroupCount值
*/
GroupCount?: number;
/**
* 备注
*/
Desc?: string;
/**
* 备注
*/
Description?: string;
/**
* 是否关闭指标伸缩, 默认0, 0:打开指标伸缩 1:关闭指标伸缩
*/
DisableMetricAS?: number;
/**
* 开启定时伸缩规则, 默认0, 0:关闭定时伸缩 1:开启定时伸缩
*/
EnableCronAS?: number;
}
/**
* EnableUnitRule请求参数结构体
*/
export interface EnableUnitRuleRequest {
/**
* 规则ID
*/
Id: string;
}
/**
* CreateCluster返回参数结构体
*/
export interface CreateClusterResponse {
/**
* 集群ID
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeResourceConfig请求参数结构体
*/
export type DescribeResourceConfigRequest = null;
/**
* CreateMicroservice返回参数结构体
*/
export interface CreateMicroserviceResponse {
/**
* <p>新增结果。<br>true:操作成功。<br>false:操作失败。</p>
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFileConfigWithDetailResp请求参数结构体
*/
export interface CreateFileConfigWithDetailRespRequest {
/**
* 配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
*/
ConfigName: string;
/**
* 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
*/
ConfigVersion: string;
/**
* 配置项文件名,不超过60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
*/
ConfigFileName: string;
/**
* 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)。
*/
ConfigFileValue: string;
/**
* 配置项关联应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
*/
ApplicationId: string;
/**
* 发布路径。
*/
ConfigFilePath: string;
/**
* 配置项版本描述,最多支持200个字符。
*/
ConfigVersionDesc?: string;
/**
* 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
*/
ConfigFileCode?: string;
/**
* 后置命令。
*/
ConfigPostCmd?: string;
/**
* Base64编码的配置项
*/
EncodeWithBase64?: boolean;
/**
* 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
*/
ProgramIdList?: Array<string>;
}
/**
* 部署javaagent的类型、版本信息
*/
export interface AgentProfile {
/**
* Agent类型
*/
AgentType?: string;
/**
* Agent版本号
*/
AgentVersion?: string;
}
/**
* ModifyContainerReplicas返回参数结构体
*/
export interface ModifyContainerReplicasResponse {
/**
* 结果true:成功;false:失败;
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StopGroup请求参数结构体
*/
export interface StopGroupRequest {
/**
* 按照【部署组ID】进行部署组删除,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=applicatio