AttachTemplate - 应用关联应用模板-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
应用交付	应用	读写

请求语法

中心版

POST https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{name}/template:attach

Region版

POST https://{domain}/oapi/v1/appstack/apps/{name}/template:attach

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
name	string	path	是
organizationId	string	path	是：中心版否：Region版	组织 ID。	ec766e63aee3437d9a51f334d6exe671
-	object	body	否
appTemplateName	string	body	是	应用模板唯一名。	my-app-template

请求示例

中心版

curl -X 'POST' \
  'https://{domain}/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/apps/{name}/template:attach' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "appTemplateName": "my-app-template"
    }'

Region版

curl -X 'POST' \
  'https://{domain}/oapi/v1/appstack/apps/{name}/template:attach' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "appTemplateName": "my-app-template"
    }'

返回参数

参数	类型	描述	示例值
-	object
data	boolean
errorAdvice	string
errorCode	string	可能的值：[ApiDeprecated SystemInternalError ApiRateLimited BadRequest ThirdPartyApiAuthFailed BadFormatForPagination BadFormatForFloatingPointInput BadFormatForDomainObjectName GrayConfigNotFound GrayAccountKeyDuplicated GrayAccountInputMissing ApplicationNotFound ApplicationNameDuplicated ApplicationWithoutName ApplicationNameInvalid ApplicationMemberManagerPermissionDenied ApplicationBasicSetPermissionDenied SystemNotFound SystemNameDuplicated SystemWithoutName SystemNameInvalid ApplicationCreateFailed ApplicationUpdateFailed ApplicationDeleteFailed ApplicationCreateWithTemplateFailed ApplicationDeleteWithSystemFailed ApplicationRelationDuplicated ApplicationRelationNotFound ApplicationRelationInvalid ApplicationRelationDeleteInvalid ApplicatoinRelationCoderepoDuplicated ApplicationGroupNotFound ApplicationGroupNameDuplicated ApplicationGroupCreateFailed ApplicationGroupDeleteFailed ApplicationGroupCascadingDeleteFailed TagNameInvalid TagNameDuplicated TagNotFound TagBindingNotFound EnvironmentNotFound EnvironmentNameDuplicated EnvironmentPresetNotFound EnvironmentCreateFailed EnvironmentUpdateFailed EnvironmentDeleteFailed EnvironmentLocked EnvironmentLockFailed BlockedByMigrationUpgrade EnvironmentMissEnvTypeLabel EnvironmentContainsMultipleEnvTypeLabels EnvironmentContainsDuplicatedVariableGroups EnvDeployGroupCannotChangeDueToRunningChangeOrder EnvResourceTypeCannotChange EnvStrategyNotExists EnvStrategyTargetReplicasNotExists EnvStrategyBatchInvalid EnvMultipleK8sBinding EnvNoK8sBinding EnvOamStrategyChangeNotAllowed EnvStrategyBatchStepTypeNotSupported EnvironmentActionLogNotFound LabelNotFound LabelDuplicated LabelPresetNotFound LabelCascadingDeleteFailed OrchestrationNotFound InvalidOrchestrationFormat OrchestrationRelationNotFound OrchestrationComponentNotFound OrchestrationComponentDuplicated MultipleDeploymentsNotAllowed OrchestrationComponentNotExists ManualConfirmNeededOnNewDeployment DeploymentParallelLaunchNotSupported NullOrchestrationComponent ComponentHasNoKind ComponentHasMultipleKinds UnsupportedComponentKind ComponentHasMultipleApiVersions ComponentHasNoApiVersion PlaceholderHasNoValue OrchestrationTemplateNotFound OrchestrationTemplateSaveFailed OrchestrationPresetNotFound OrchestrationRenderFailed ManualConfirmNeededOnOrchestrationUpdate OrchestrationJsonValueParseFailed OrchestrationTemplateDuplicated OrchestrationTemplateCreateFailed OrchestrationTemplateUpdateFailed OrchestrationTemplateDeleteFailed ApplicationOrchestrationNotFound ApplicationOrchestrationDuplicated ApplicationOrchestrationCreateFailed ApplicationOrchestrationCannotBeReinitialized ApplicationOrchestrationUpdateFailed ApplicationOrchestrationDeleteFailed ApplicationOrchestrationCommitOutOfDate ApplicationOrchestrationFormatDuplicated ApplicationOrchestrationLabelMismatched VariableValueInvalid VariableNotFound VariableDuplicated VariableProfileNotFound VariablePresetNotFound VariableProfileCreateFailed VariableDeleteFailed VariableCreateFailed VariableProfileUpdateFailed VariableProfileCopyFailed VariableProfileDeleteFailed VariableUpdateFailed VariableFilterFailed VariableKeyInvalid VariableProfileAlreadyExists VersionControlBranchNotFound VersionControlBranchDuplicated VersionControlBranchLocked VersionControlBranchCreateFailed VersionControlBranchUpdateFailed VersionControlBranchDeleteFailed VersionControlBranchInUse VersionControlTagNotFound VersionControlTagDuplicated VersionControlTagLocked VersionControlTagCreateFailed VersionControlTagUpdateFailed VersionControlTagDeleteFailed VersionControlCascadingDeleteFailed VersionControlRevisionNotFound VersionControlRevisionDuplicated VersionControlRevisionLocked VersionControlRevisionCreateFailed VersionControlRevisionUpdateFailed VersionControlRevisionDeleteFailed VersionControlRevisionNotLatest VersionControlRevisionNotChanged VersionControlRepositoryNotFound VersionControlRepositoryDuplicated VersionControlRepositoryLocked VersionControlRepositoryCreateFailed VersionControlRepositoryUpdateFailed VersionControlRepositoryDeleteFailed ApplicationCodeRepositoryNotFound ApplicationCodeRepositoryNumberLimitExceeded ApplicationCodeRepositoryUrlDuplicated ApplicationCodeRepositoryIdentifierInvalid ApplicationCodeRepositoryIdentifierDuplicated ApplicationCodeRepositoryCommitNotFound ApplicationCodeRepositoryTypeUnsupported ApplicationArtifactRepoNotFound ApplicationArtifactRepoIdentifierDuplicated ApplicationArtifactRepoNumberLimit ApplicationArtifactRepositoryIdentifierInvalid ResourcePoolNotFound ResourcePoolDuplicated ResourcePoolLocked ResourcePoolCreateFailed ResourcePoolUpdateFailed ResourcePoolDeleteFailed ResourceInstanceNotFound ResourceInstanceDuplicated ResourceInstanceKubeConfigInvalid ResourceInstanceMultiOsUnsupported ResourceInstanceLocked ResourceInstanceRelatedToAppTemplateOrEnv ResourceInstanceCreateFailed ResourceInstanceUpdateFailed ResourceInstanceDeleteFailed ResourceInstanceNotSupported KubeConfigNotAllowedForResourceInstance ClusterCaNotAllowedInKubeConfig UserExecNotAllowedInKubeConfig UserClientCertificateNotAllowedInKubeConfig UserClientKeyNotAllowedInKubeConfig UserTokenFileNotAllowedInKubeConfig UserAuthProviderNotAllowedInKubeConfig KubernetesConnectionTimeout KubernetesSslHandshakeFailed DeployGroupNotFound DeployGroupDuplicated DeployGroupLocked DeployGroupCreateFailed DeployGroupUpdateFailed DeployGroupDeleteFailed DeployGroupCascadingDeleteFailed CallFlowServiceConnectionFailed CallFlowHostFailed CallFlowHostGroupFailed CallFlowPipelineFailed ChangeOrderDeleteFailed ChangeOrderCascadingDeleteFailed ChangeOrderInputNotExists ChangeOrderNotExists ChangeOrderTaskNotExists ChangeOrderStageNotExists FailedToAcquireChangeOrderLock ChangeOrderJobNotExists EnvironmentBaselineNotFound ChangeOrderJobFailed ChangeOrderJobTypeShouldBeDeploy ChangeOrderJobFirstDeploy ChangeOrderTaskActionNotExists ChangeOrderTaskEventNotFound ChangeOrderArgMapNotExists ChangeOrderTaskAdaptorNotFound UnknownChangeType ChangeOperationNotAllowed ChangeOrderConflict ChangeOrderLogServiceNotFound ChangeOrderOperationNotAccepted MultipleRevisionsOnWorkload ChangeOrderCreateFailed ChangeOrderInputCreateFailed ChangeOrderImageMissing MultipleRevisionOnWorkloadForAde2 ChangeOrderActionRefusedDueToLockedEnv ChangeOrderMissingKubernetesObjectName ChangeOrderBatchDeployTimeoutTooLarge ChangeOrderBatchDeployNoAgentAvailable NullArtifactScmProviderType NullArtifactSpecContent NullArtifactType NullArtifactBuildSpec ArtifactSpecParserNotFound ArtifactScmSpecParserNotFound ResourcePathInvalid ResourceKubeProxyFailed KubernetesBadRequest KubernetesAccessNotAuthenticated KubernetesObjectAccessNotAuthorized KubernetesNotFound KubernetesApiRateLimited KubernetesServiceUnavailable ResourceKubeConfigFetchFailed AckClusterFetchFailed AckClusterNotExists AliyunAuthFailed ResourceAccessNetworkFailure DescribeAckAddonFailed AliyunPkIdNotFound AliyunSdkCreateFailed AckAddonFindVersionFailed ResourceItemDeleteFailed AliyunApiCallFailure EdasRuntimeDetected AgentNotFound AgentInstallTaskRateLimited AgentInstallFailed OnlineGuideStepHandlerNotFound RoleNotFound CannotModifyOwnerPermission CannotModifyOwnerWithoutTransfer AppRoleNameDuplicated AppRoleNameInvalid PermissionDenied PermissionNotInitialized MockUrlNotFound HttpCallFailed ResponseBodyConvertFailed SystemVariableNotFound DeployEngineTaskNotFound NullDeployEngineTaskSpec EmptyDeployEngineContext MissingKubernetesObjectApiGroup MissingKubernetesObjectVersion MissingKubernetesObjectKind MissingChangeType CallbackStatusRequired MissingChangeTerminationConfirmResult MissingChangeBatchNo CallChangeFailed DeployEngineTaskSpecInvalid DeployEngineTaskSpecReplicasInvalid DeployEngineFailed EnvTargetReplicasNotEqualsBaseline KubeConfigLegacyValidateFailed AS-EnterpriseSetting.B002 OpLogRecordCreateFailed NullReleaseWorkflowName ReleaseWorkflowNameDuplicated TooManyReleaseWorkflows ReleaseWorkflowNotFound UnsupportedPipelineWebhook ReleaseWorkflowUpsertWithTemplateFailed FailedToAcquireReleaseWorkflowLock NullReleaseStageName ReleaseStageNameDuplicated TooManyReleaseStages ReleaseStageNotFound ReleaseStagePipelineNotFound ReleaseStagePipelineRunFailed ReleaseStagePipelineCircularError ReleaseStageConfigAlreadyExists ReleaseStageConfigNotFound UnsupportedPipelineTypeForReleaseStage AS-ReleaseStageConfig-B007 ReleaseStagePipelineInstanceNotFound ChangeRequestNotExists BranchCreateOperationNotSupported BranchDeleteOperationNotSupported ChangeRequestBranchExists ChangeRequestsAreNotAllClosed ChangeRequestNotFound ProjexRecommendFailed ProjexSearchFailed ProjexSearchByRequestFailed ProjexBindFailed ProjexUnbindFailed UnsupportedProjexAction ChangeRequestSetNotFound GenerateProjexSignFailed ChangeRequestAlreadyAttachedToRelease ChangeRequestMustBindWorkItem NullReleaseWorkflowTemplateName WorkflowTemplateNameDuplicated WorkflowTemplateNotFound CallCodeUpApiFailed CodeUpBranchAlreadyExists CodeUpApi403 CodeUpApi404 CodeApiAccessTokenNotFound SameCommitOperationNotSupported ListCommitOperationNotSupported ListAllBranchesOperationNotSupported FindBranchOpeartionNotSupported FindProjectOperationNotSupported CustomGitlabApi401 CustomGitlabApi403 CustomGitlabApi404 CustomGitlabApi409 CustomGitlabApiException AS-CodeUpApi-B005 GithubApi401 GithubApi403 GithubApi404 GithubApi409 GithubApiException IamCheckFailed OrganizationOwnerNotFound ApplicationTemplateParamInvalid ApplicationTemplateDuplicated ApplicationTemplateNotFound ApplicationAlreadyBindTemplate ApplicationTemplateCreateFailed ApplicationTemplateDeleteFailed ApplicationTemplateDeleteCheckFailed ApplicationTemplateCopyFailed ApplicationTemplateConfigNotFound ApplicationTemplateConfigDuplicated ApplicationTemplateWorkflowUpsertFailed ReleaseNotFound ReleaseDuplicated ReleaseRevisionDuplicated ReleaseRevisionValidateFailed ReleaseRevisionOrgConfigValidateFailed ReleaseCodeRepoValidate ReleaseUpdateDenied ReleaseCanNotBeReleased ReleaseNotAllEnd ReleaseInstNotFound ReleaseItemNotFound ReleaseItemOrchestrationNotFound ReleaseRelationNameDuplicated ReleaseItemGenericIdDuplicated UserNotFound SubjectTypeNotSupport AuditEngineNotFound AuditRecordDuplicated CallSplcApiFailed AoneAppNotFound AuditSubmitFailed AoneCodeReviewApiAccessFailed NoAoneCodeReviewer AoneCodeReviewSameAsTrunk AsoApiAccessFailed AsoClusterNotCreated KubernetesResourceNotFound NeedPremiumVersion AppSourceTypeUnsupported GlobalVarNotFound GlobalVarExist GlobalVarUsageReferencesExist OrgConfigNotFound MissingValidReplicas HookChannelSubscribeNotFound HookScopeTypeUnsupported HookChannelTypeUnsupported FlowMutationTypeUnsupported FlowMutationPluginUnsupported FlowMutationPluginSendMessageError FlowMutationNotificationParseError]。	ApiDeprecated
errorMap	object
errorMessage	string
showType	integer
success	boolean
traceId	string

返回示例

{
    "data": false,
    "errorAdvice": "",
    "errorCode": "ApiDeprecated",
    "errorMap": {
    },
    "errorMessage": "",
    "showType": 0,
    "success": false,
    "traceId": ""
}

错误码

访问错误码中心查看 API 相关错误码。