參數(shù)

類型

是否必填

描述

示例值

x-yunxiao-token

string

是

個(gè)人訪問令牌。

pt-0fh3****0fbG_35af****0484

參數(shù)

類型

位置

是否必填

描述

示例值

appName

string

path

是

應(yīng)用名。

my-web-service

sn

string

path

是

應(yīng)用編排唯一序列號(hào)，未指定 tag 和 sha 時(shí)將查找最新版本。

my-web-service@KUBERNETES

tagName

string

query

否

編排 tag。

demotag

sha

string

query

否

編排 commit sha。

d23ccbd926c31e3ca0b153f22c4548b93b1426e

organizationId

string

path

是

組織 ID。

99d1****71d4

參數(shù)

類型

描述

示例值

-

object

應(yīng)用內(nèi)置編排。

app

object

應(yīng)用。

creatorId

string

應(yīng)用創(chuàng)建者。

user-xxxx

description

string

應(yīng)用描述。

app-description-xxx

favoured

boolean

是否收藏。

false

gmtCreate

string

應(yīng)用創(chuàng)建時(shí)間。

2024-09-01 00:00:00

labelList

array

應(yīng)用標(biāo)簽列表。

-

object

AppStack 標(biāo)簽。

displayName

string

標(biāo)簽的展示名，用于描述性的場景，不參與標(biāo)簽匹配。

測試標(biāo)簽鍵

displayValue

string

標(biāo)簽的展示值，用于描述性的場景，不參與標(biāo)簽匹配。

測試標(biāo)簽值

extraMap

object

標(biāo)簽擴(kuò)展屬性 map，可在定義標(biāo)簽時(shí)用于存儲(chǔ)自定義的擴(kuò)展屬性字段。

map[]

name

string

標(biāo)簽名，僅允許包含小寫字母、中劃線和數(shù)字，且開頭、結(jié)尾均為小寫字母或數(shù)字。

demo-label

namespace

string

標(biāo)簽命名空間，決定了標(biāo)簽的作用域。

default

value

string

標(biāo)簽值，僅允許包含小寫字母、中劃線和數(shù)字，且開頭、結(jié)尾均為小寫字母或數(shù)字。

demo-label-value

name

string

應(yīng)用名稱。

app-name-xxx

type

string

類型，可能的值：[APP SYSTEM]。

APP

componentList

array

組件列表。

-

object

編排組件模型。

content

string

組件內(nèi)容，以 go 標(biāo)準(zhǔn)庫 text/template 的形式呈現(xiàn)。

—\napiVersion: v1\nkind: Service\nmetadata:\n name: prod-sidecar-test-{{ .AppStack.envName }}\n # 命名空間配置：\n # 建議每個(gè)環(huán)境使用不同的 Kubernetes 集群命名空間，以便達(dá)到環(huán)境隔離效果\n # 部署時(shí)云效會(huì)將占位符{{ .Values.namespace }}替換成右側(cè)設(shè)置的實(shí)際值\n namespace: {{ .Values.namespace }}\nspec:\n selector:\n run: prod-sidecar-test-{{ .AppStack.envName }}\n ports:\n - protocol: TCP\n port: 80\n targetPort: 8080

description

string

組件描述。

示例描述

kind

string

組件類型（在 kubernetes 場景下，需要沿用 kubernetes 對(duì)象的 kind）。

Service

name

string

組件名。

demo-service

priority

integer

組件優(yōu)先級(jí)，從 1 開始；環(huán)境部署時(shí)，會(huì)按優(yōu)先級(jí)數(shù)值從低到高的順序下發(fā)部署。

1

type

string

適用的部署架構(gòu)類型（如 Kubernetes、主機(jī)等），可能的值：[KUBERNETES HOST]。

KUBERNETES

creatorId

string

創(chuàng)建人。

app-builtin-creator-id

description

string

描述。

app-builtin-orchestration-description

format

string

格式。

MANIFEST

gmtCreate

string

創(chuàng)建時(shí)間。

2024-09-01 00:00:00

gmtModified

string

修改時(shí)間。

2024-09-01 00:00:00

groupNameMap

object

labelList

array

標(biāo)簽列表。

-

object

AppStack 標(biāo)簽。

displayName

string

標(biāo)簽的展示名，用于描述性的場景，不參與標(biāo)簽匹配。

測試標(biāo)簽鍵

displayValue

string

標(biāo)簽的展示值，用于描述性的場景，不參與標(biāo)簽匹配。

測試標(biāo)簽值

extraMap

object

標(biāo)簽擴(kuò)展屬性 map，可在定義標(biāo)簽時(shí)用于存儲(chǔ)自定義的擴(kuò)展屬性字段。

map[]

name

string

標(biāo)簽名，僅允許包含小寫字母、中劃線和數(shù)字，且開頭、結(jié)尾均為小寫字母或數(shù)字。

demo-label

namespace

string

標(biāo)簽命名空間，決定了標(biāo)簽的作用域。

default

value

string

標(biāo)簽值，僅允許包含小寫字母、中劃線和數(shù)字，且開頭、結(jié)尾均為小寫字母或數(shù)字。

demo-label-value

labelPolicy

string

標(biāo)簽策略。

NONE

modifierId

string

修改人。

app-builtin-modifier-id

name

string

名稱。

app-builtin-orchestration-name

placeholderList

array

占位符列表。

-

object

占位符模型。

description

string

占位符描述。

內(nèi)存限制

name

string

占位符名。

memoryLimit

overridable

boolean

占位符是否部署時(shí)可修改。

true

predefined

boolean

是否預(yù)置占位符。

false

rsType

string

適用的部署架構(gòu)類型（如 Kubernetes、主機(jī)等），可能的值：[KUBERNETES HOST]。

KUBERNETES

rule

string

占位符取值的可選校驗(yàn)規(guī)則。

""

type

string

占位符類型，可能的值：[string number boolean float object]。

string

value

string

占位符取值。

1024Mi

valueSource

string

占位符取值的數(shù)據(jù)源類型（如常量、變量等），可能的值：[CONSTANT VARIABLE NULL]。

CONSTANT

revision

object

編排版本信息。

author

string

編排版本提交人。

user-xxx

commitTime

string

編排版本提交時(shí)間。

2024-09-01 00:00:00

message

string

編排版本信息 commit 信息。

revision-message-xxx

sha

string

編排版本信息 commit sha 值。

revision-sha-xxx

sn

string

唯一序列號(hào)。

app-builtin-orchestration-1

storageType

string

存儲(chǔ)類型。

BUILTIN

suitableResourceTypes

array[string]

使用資源類型。

syncSourceTemplate

object

編排同步源模板。

appTemplateName

string

應(yīng)用模板名稱。

app-template-name

orchestrationSha

string

應(yīng)用模板版本 commit sha 值。

app-template-version-sha

type

string

類型。

AppBuiltInOrchestration