数据结构

最近更新时间: 2025-03-12 16:34:38

AccountInfo

帐号信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
AppId Int64 appid
示例值: 1255000002

ShortTemplates

精简模版信息

被如下接口引用:DescribeShortTemplates

名称 必选 允许NULL 类型 描述
TemplateId Int64 模板Id
示例值: 80000009
Name String 模板的名字
示例值: name

DeleteStackVersionFailedInfo

删除失败的资源栈版本

被如下接口引用:DeleteStackVersion

名称 必选 允许NULL 类型 描述
VersionId Int64 删除失败的资源栈版本id
示例值: 4328
Reason String 删除失败的原因
示例值: reason

RegionInfo

地区信息

被如下接口引用:GetRegions

名称 必选 允许NULL 类型 描述
Region String 地区, 例如ap-guangzhou
示例值: chongqing
RegionName String 地区名称, 例如广州地区
示例值: 重庆
EnglishRegionName String 英文地区名称
示例值: chongqing

Category

菜单资源类别

被如下接口引用:DescribeBars

名称 必选 允许NULL 类型 描述
Title String 类别标题
示例值: title
Description String 类别描述
示例值: desc
IconPath String 图标地址
示例值: /data/cvm/cvm.svg
Items Array of Item 产品下资源列表
示例值:查看
DescriptionCN String 中文描述
示例值: 云服务器

Outputs

输出值

被如下接口引用:GetArchResources、ImportArchTemplate、PutArchResources

名称 必选 允许NULL 类型 描述
Uuid String 输出值 uuid
示例值: a33b30e0-0129-40d0-965a-cbc0eefe4066
Name String  输出值名称
示例值: name
Value String 输出值
示例值: value
Description String 输出描述
示例值: desc
Sensitive Bool 是否安全值
示例值: true

Variables

环境变量

被如下接口引用:GetArchResources、ImportArchTemplate、PutArchResources

名称 必选 允许NULL 类型 描述
Uuid String 变量 uuid
示例值: a33b30e0-0129-40d0-965a-cbc0eefe4066
Name String 变量名称
示例值: name
Default String 变量默认值
示例值: default
Description String 变量描述
示例值: desc
Sensitive Bool 是否安全展示
示例值: true
Type String 变量类型
示例值: plan
Validation String 变量校验规则
示例值: valida
Value String 变量值
示例值: value
Nullable Bool 变量是否准许取值为 nullable
示例值: true

ExportField

资源详细信息

被如下接口引用:DescribeCards

名称 必选 允许NULL 类型 描述
Name String 名称
示例值: Name
Computed Bool 是否为导出属性
示例值: true
Description String 描述
示例值: Description
Default String 默认值
示例值: "eage"
ForceNew Bool 强制更新
示例值: true
Optional Bool 可选
示例值: false
Required Bool 是否必填
示例值: false
Sensitive Bool 敏感
示例值: true
Type String 参数类型
示例值: String
PossibleValues Array of ExportField 嵌套子类型
示例值:查看
DescriptionCN String 中文描述
示例值: 云服务器
SubType String Type为数组时,数组元素的类型
示例值: String

产品菜单

被如下接口引用:DescribeBars

名称 必选 允许NULL 类型 描述
Key String Key
示例值: key
Name String 分类名称
示例值: name
Categories Array of Category 产品列表
示例值:查看

TencentCloud

菜单类型

被如下接口引用:

名称 必选 允许NULL 类型 描述
Area Area 地域类型
示例值:查看
MenuList Array of Menu 类别列表
示例值:查看

Edges

节点图形边

被如下接口引用:GetArchResources、ImportArchTemplate、PutArchResources

名称 必选 允许NULL 类型 描述
Source String 连线来源
示例值: source
Target String 连线目标
示例值: target
Id String 连线 id
示例值: 1
Label String 连线标签
示例值: label
Extend String 连线扩展
示例值: extend

TemplateShortInfo

模板的简单信息

被如下接口引用:CopyTemplate、CreateComplexTemplate、CreateTemplate、DeleteTemplate、ModifyTemplate

名称 必选 允许NULL 类型 描述
TemplateId Int64 模板Id
示例值: 1

StackSetMemberInfo

资源栈集成员信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
StackId Int64 资源栈ID
示例值: 1
StackName String 资源栈名称
示例值: name
Description String 资源栈描述
示例值: desc
Provider String 云厂商
示例值: ""
Region String 地域
示例值: chongqing
Status String 资源栈状态
示例值: 1

SafeItem

安全扫描的条目信息

被如下接口引用:ListSafeMgrScanResult

名称 必选 允许NULL 类型 描述
Name String 条目名字,eg:InstanceNumber 产品里边唯一
示例值: name
Hint String 提醒,eg:未开启登录保护的风险
示例值:
RiskClass Int64 安全等级 0无风险 1低风险 2中风险 3高风险
示例值:
Sub Float 本条要减去多少分
示例值:
Desc String 描述信息,如"需要获取安全组的访问规则,并对规则进行分析高危端口:主要包括TCP端口(1-1024)、UDP端口( 1-1024)、MySQL端口(3306)、SQL Server端口(1433、1434)、SSH端口(22)和Windows管理端口(3389)"
示例值:
Repair String 怎么修复,如:关闭高危端口,具体关闭操作,请参考安全实例
示例值:
RepairUrl String 修复的Url
示例值:
Sum String 如果是综合信息  如"15", "100G"等
示例值:
UnsafeIds Array of Instance 不安全的实例I
示例值:查看

StackSetInfo

资源栈集信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
StackSetId Int64 资源栈集ID
示例值: 1
StackSetName String 资源栈集名称
示例值: name
Description String 资源栈集描述
示例值: desc
StackCount Int64 包含的资源栈数目
示例值: 1
Providers String 云厂商
示例值: []

Variable

terraform 变量成员信息

被如下接口引用:SaveStackVersionVariable

名称 必选 允许NULL 类型 描述
Id Int64 数据库存储id
示例值: 1
Name String 变量名
示例值: name
Default String 默认值
示例值: default
Description String 描述信息
示例值: desc
IsSensitive Bool 是否敏感
示例值: true
Type String 变量类型,terraform固定枚举值
示例值: string
Validation String 校验方式
示例值: vali
Value String 变量预设值,优先级高于default
示例值: value
InputValue String 用户输入值,优先级高于Value
示例值: key
Nullable Bool 是否允许为null
示例值: true

StackResource

资源栈版本资源信息

被如下接口引用:GetStackResourceList

名称 必选 允许NULL 类型 描述
ProviderName String provider名称
示例值: ""
VersionId Int64 版本id
示例值: 1
ResourceList Array of ResourceInfo 资源列表
示例值:查看
DataList Array of ResourceInfo 数据源列表
示例值:查看
VersionName String 版本名称
示例值: name

Node

节点

被如下接口引用:GetArchResources、ImportArchTemplate、PutArchResources

名称 必选 允许NULL 类型 描述
NodeId String 节点 uuid
示例值: 100
Metadata Metadata 节点元数据
示例值:查看
Config String 节点配置
示例值: config
Graphics String Graphics图形
示例值: Graphics

ResourceTypeInfo

资源类型信息

被如下接口引用:GetResources

名称 必选 允许NULL 类型 描述
Id Int64 资源ID
示例值: 1
Name String 资源名称
示例值: name
Product String 资源所属产品
示例值: CVM
Type String 资源类型
示例值: resource
Description String 资源描述
示例值: desc

TemplateInfo

模板的列表详情

被如下接口引用:DescribeTemplate、DescribeTemplates

名称 必选 允许NULL 类型 描述
TemplateId Int64 模板Id
示例值: 1255000002
TemplateType Int64 模板的类型,0为私有,1为公有
示例值: cvm_instance
AppId Int64 创建者的appid
示例值: 1255000002
Name String 模板的名字
示例值: name
Desc String 模板的描述
示例值: desc
InsertTime Int64 模版创建的时间戳
示例值: 2024-11-22T15:53:46+08:00
UpdateTime Int64 模板更新的时间戳
示例值: 2024-11-22T15:53:46+08:00
TfTree String 模版的配置信息
示例值: ewogICJ2ZXJzaW9uIjogNCwKICAidGVycmFmb3JtX3ZlcnNpb24iOiAiMS41LjciLAogICJzZXJpYWwiOiAxLAogICJsaW5lYWdlIjogIjMwYTk1N2M0LWQ2NzEtZTk5Ni1jMDBkLTAxYTRlZWMxMGUyZCIsCiAgIm91dHB1dHMiOiB7fSwKICAicmVzb3VyY2VzIjogWwogICAgewogICAgICAibW9kZSI6ICJtYW5hZ2VkIiwKICAgICAgInR5cGUiOiAiY2xvdWRfdnBjIiwKICAgICAgIm5hbWUiOiAidnBjX3B1YmxpY19kZW1vIiwKICAgICAgInByb3ZpZGVyIjogInByb3ZpZGVyW1wicmVnaXN0cnkudGVycmFmb3JtLmlvL2hhc2hpY29ycC9jbG91ZFwiXSIsCiAgICAgICJpbnN0YW5jZXMiOiBbCiAgICAgICAgewogICAgICAgICAgInNjaGVtYV92ZXJzaW9uIjogMCwKICAgICAgICAgICJhdHRyaWJ1dGVzIjogewogICAgICAgICAgICAiYXNzaXN0YW50X2NpZHJzIjogW10sCiAgICAgICAgICAgICJjaWRyX2Jsb2NrIjogIjEwLjAuMC4wLzE2IiwKICAgICAgICAgICAgImNyZWF0ZV90aW1lIjogIjIwMjQtMTEtMjEgMTk6NTg6MzgiLAogICAgICAgICAgICAiZGVmYXVsdF9yb3V0ZV90YWJsZV9pZCI6ICJydGItNGVubXY1YzIiLAogICAgICAgICAgICAiZG5zX3NlcnZlcnMiOiBbCiAgICAgICAgICAgICAgIjE4My42MC44Mi45OCIsCiAgICAgICAgICAgICAgIjE4My42MC44My4xOSIKICAgICAgICAgICAgXSwKICAgICAgICAgICAgImRvY2tlcl9hc3Npc3RhbnRfY2lkcnMiOiBbXSwKICAgICAgICAgICAgImlkIjogInZwYy1hYXRndDlwaCIsCiAgICAgICAgICAgICJpc19kZWZhdWx0IjogZmFsc2UsCiAgICAgICAgICAgICJpc19tdWx0aWNhc3QiOiBmYWxzZSwKICAgICAgICAgICAgIm5hbWUiOiAidnBjX2Zvb2ZsYW5uIiwKICAgICAgICAgICAgInRhZ3MiOiBudWxsLAogICAgICAgICAgICAidnBjX2lkIjogInZwYy1hYXRndDlwaCIKICAgICAgICAgIH0sCiAgICAgICAgICAic2Vuc2l0aXZlX2F0dHJpYnV0ZXMiOiBbXSwKICAgICAgICAgICJwcml2YXRlIjogImJuVnNiQT09IgogICAgICAgIH0KICAgICAgXQogICAgfQogIF0sCiAgImNoZWNrX3Jlc3VsdHMiOiBudWxsCn0K
ArchType Uint64 0:代码模板,1:可视化模板
示例值: 1

ResourceDocInfo

资源文档简要信息

被如下接口引用:GetResourceDirectory

名称 必选 允许NULL 类型 描述
Id Int64 文档ID
示例值: 100
Name String 资源名称
示例值: name

StackVersionInfo

资源栈版本基本信息

被如下接口引用:GetStackVersions

名称 必选 允许NULL 类型 描述
StackId Int64 资源栈id
示例值: 1
VersionId Int64 资源栈版本id
示例值: 1
AppId Int64 创建版本时的appid
示例值: 1255000002
Uin Int64 创建版本时的uin
示例值: 110000002387
SubAccountUin Int64 创建版本时的SubAccountUin
示例值: 110000002387
VersionName String 资源栈版本名称
示例值: name
Status String 资源栈版本状态
示例值: 1
Description String 资源栈版本状态信息
示例值: desc
LastEventId Int64 资源栈版本最近的一次事件
示例值: 1
CreateTime Int64 插入时间戳
示例值: 2024-11-22T15:53:46+08:00
UpdateTime Int64 更新时间戳
示例值: 2024-11-22T15:53:46+08:00

Instance

安全检测的实例 , 包含实例ID和地区

被如下接口引用:ListSafeMgrScanResult

名称 必选 允许NULL 类型 描述
Id String 实例ID
示例值: Id
Region String 地区
示例值: chongqing
RegionCode String 地区的编码(mysql使用)
示例值: chongqing

StackIdInfo

资源栈ID信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
StackId Int64 资源栈ID
示例值: 1
VersionId Int64 版本ID
示例值: 1

ProviderConfigDetail

ProviderConfigDetail

被如下接口引用:AddProviderConfig、ListProviderConfig

名称 必选 允许NULL 类型 描述
Id Int64 Id
示例值: 100
Provider String Provider类型
示例值:
Desc String Provider的描述
示例值:
Name String Provider的名字
示例值:
ProviderConfig String Provider的具体配置
示例值:
Active Int64 是否被激活
示例值:
Using Int64 是否已经被使用
示例值:
InsertTime Int64 插入时间戳
示例值:
UpdateTime Int64 更新时间戳
示例值:
AppId Int64 appid
示例值:

ProductDocInfo

产品文档信息

被如下接口引用:GetResourceDirectory

名称 必选 允许NULL 类型 描述
Name String 产品名称
示例值: name
DataSources Array of ResourceDocInfo Data Source列表
示例值:查看
Resources Array of ResourceDocInfo Resource列表
示例值:查看

Item

菜单资源属性

被如下接口引用:DescribeBars

名称 必选 允许NULL 类型 描述
TerraformType String 资源名
示例值: cvm_instance
Title String 资源标题
示例值: CVM
IconPath String 图标cos地址
示例值: /data/cvm/cvm.svg
Description String 资源描述
示例值: description

Locals

本地变量

被如下接口引用:GetArchResources、ImportArchTemplate、PutArchResources

名称 必选 允许NULL 类型 描述
Uuid String 变量 uuid
示例值: a33b30e0-0129-40d0-965a-cbc0eefe4066
Name String 变量名称
示例值: name
Description String 变量描述
示例值: desc
Value String 变量值
示例值: valuse

Metadata

节点元数据

被如下接口引用:GetArchResources、ImportArchTemplate、PutArchResources

名称 必选 允许NULL 类型 描述
CreationOrder Uint64 节点创建顺序
示例值: order
Region String 部署地域
示例值: chongqing
ResourceName String 节点资源名称
示例值: name
ResourceType String 资源属主类型
示例值: type
TerraformType String tf资源类型
示例值: cvm_instance
CustomCode String 自定义代码
示例值: code
IsCustom Bool 是否自定义节点
示例值: true
Group String 节点资源文件属组
示例值: group

ResourcesJSON

资源信息列表

被如下接口引用:

名称 必选 允许NULL 类型 描述
Items Array of SchemaJSON 资源信息列表
示例值:查看

ProviderResourceInfo

provider包含的data source和resource

被如下接口引用:GetResourceList

名称 必选 允许NULL 类型 描述
ProviderName String provider名字,目前只有tencentcloud
示例值:
ResourceList Array of ResourceInfo resource列表
示例值:查看
DataList Array of ResourceInfo data source列表
示例值:查看

ResourceInputArgumentInfo

资源输入参数信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
Name String 参数名称
示例值: name
Type String 参数类型
示例值: type
Required Bool 参数是否为必填项
示例值: true
ForceNew Bool 参数是否不可简单更新
示例值: true
Description String 参数简介
示例值: desc
ValueRange String 参数取值范围
示例值: 100

StackEventInfo

资源栈事件详情

被如下接口引用:ListStackEvent

名称 必选 允许NULL 类型 描述
StackId Int64 资源栈ID
示例值: 4328
VersionId Int64 版本ID
示例值: 4328
VersionName String 版本名称
示例值: version
EventId Int64 事件ID
示例值: 4328
EventType String 事件类型
示例值: type
Description String 事件描述
示例值: desc
Status String 事件状态
示例值: 1
Message String 事件信息
示例值: message
CreateTime Int64 创建时间
示例值: 2024-11-22T15:53:46+08:00

Area

菜单地域

被如下接口引用:DescribeBars

名称 必选 允许NULL 类型 描述
Name String 名称
示例值: name
Key String Key
示例值: key
Items Array of Item 地域item
示例值:查看

ResourceStackInfo

资源栈详情

被如下接口引用:DescribeResourceStack、ListResourceStack

名称 必选 允许NULL 类型 描述
StackId Int64 资源栈ID
示例值: 4328
StackName String 资源栈名称
示例值: name
Description String 资源栈描述
示例值: desc
CurrentVersionId Int64 当前版本ID
示例值: 4328
CurrentVersionName String 当前版本名称
示例值: name
Status String 资源栈状态
示例值: 1
CreateTime Int64 创建时间
示例值: 2024-11-22T15:53:46+08:00
UpdateTime Int64 更新时间
示例值: 2024-11-22T15:53:46+08:00
Region String 地区
示例值: chongqing
Provider String 云厂商
示例值: ""
Source String 资源栈来源
示例值: source
Id String 栈ID
示例值: 1
TokenFlag Bool 是否使用了TIC授权
示例值: true
Credential String 密钥配置
示例值: ""

ModifyTest

测试

被如下接口引用:Modify

名称 必选 允许NULL 类型 描述
TemplateId Array of Bool 测试
示例值: 80000009

ResourceInfo

Resource详情

被如下接口引用:GetResourceList、GetStackResourceList

名称 必选 允许NULL 类型 描述
Id String 实例ID
示例值: 1
AttrName String 实例名称
示例值: name
Type String 资源类型
示例值: 1
Name String 资源名称
示例值: name
Index Int64 资源编号
示例值: 200

SchemaJSON

单资源信息

被如下接口引用:DescribeCards

名称 必选 允许NULL 类型 描述
TerraformType String 资源名
示例值: cvm_instance
Attributes Array of ExportField 入参属性
示例值:查看
BlockTypes Array of ExportField 嵌套入参
示例值:查看
ExportAttributes Array of ExportField 导出属性
示例值:查看
ExportBlockTypes Array of ExportField 导出嵌套属性
示例值:查看
Description String 资源描述
示例值: desc
TerraformTypeCN String 资源名中文
示例值: cn
Hcl String Hcl 代码示例
示例值: hcl_code