通過地域ID、部署類型、服務(wù)類型、服務(wù)名稱等參數(shù),創(chuàng)建新的服務(wù)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
computenestsupplier:CreateService | create | *Service acs:computenestsupplier:{#regionId}:{#accountId}:service/* |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
ClientToken | string | 否 | 客戶端 Token,用于保證請(qǐng)求的冪等性。從您的客戶端生成一個(gè)參數(shù)值,確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 | 10CM943JP0EN9D51H |
ServiceId | string | 否 | 服務(wù) ID。 | service-0e6fca6a51a544xxxxxx |
DeployType | string | 是 | 部署類型。可能值:
| ros |
DeployMetadata | string | 否 | 存儲(chǔ)服務(wù)部署配置的信息。存儲(chǔ)的信息與部署類型有關(guān),不同的部署類型存儲(chǔ)的數(shù)據(jù)格式不一樣,因此使用 JSON String 格式進(jìn)行數(shù)據(jù)存儲(chǔ)。 | {\"TemplateConfigs\":[{\"Name\":\"模板1\",\"Url\":\"oss://computenest-test/template" + ".json?RegionId=cn-beijing\",\"PredefinedParameters\":[{\"Name\":\"低配版\"," + "\"Parameters\":{\"InstanceType\":\"ecs.g5.large\",\"DataDiskSize\":40}},{\"Name\":\"高配版\"," + "\"Parameters\":{\"InstanceType\":\"ecs.g5.large\",\"DataDiskSize\":200}}]}]} |
ServiceType | string | 是 | 服務(wù)類型。可能的值:
| private |
ServiceInfo | array<object> | 否 | 服務(wù)詳情。 | |
object | 否 | 服務(wù)詳情。 | ||
Locale | string | 是 | 服務(wù)語言。可能的值:
| zh-CN |
ShortDescription | string | 否 | 服務(wù)概述。 | TiDB是A公司自主設(shè)計(jì)、研發(fā)的開源分布式關(guān)系型數(shù)據(jù)庫。 |
Image | string | 否 | 服務(wù)圖標(biāo)地址。 | http://img.tidb.oss.url |
Name | string | 是 | 服務(wù)名稱。 | TiDB Database |
LongDescriptionUrl | string | 否 | 服務(wù)詳細(xì)描述 | http://description.tidb.oss.url |
Agreements | array<object> | 否 | 服務(wù)的協(xié)議文檔信息。 | |
object | 否 | 服務(wù)的協(xié)議文檔信息。 | ||
Name | string | 否 | 協(xié)議名稱。 | Name |
Url | string | 否 | 協(xié)議鏈接。 | https://aliyun.com/xxxxxxxx.html |
Softwares | array<object> | 否 | 服務(wù)中用到的軟件信息。 | |
object | 否 | 服務(wù)中用到的軟件信息。 | ||
Name | string | 否 | 軟件名稱。 | MySQL |
Version | string | 否 | 軟件版本。 | 5.7 |
IsSupportOperated | boolean | 否 | 是否代運(yùn)維,默認(rèn)為:false。可能的值:
說明
當(dāng) ServiceType 為 private 時(shí)需要填入該值。
| false |
PolicyNames | string | 否 | 策略名稱。單個(gè)策略名稱長度不超過 128 個(gè)字符,多個(gè)名稱使用英文逗號(hào)(,)分隔。暫時(shí)只支持代運(yùn)維相關(guān)參數(shù)策略。 | policyName1, policyName2 |
Duration | long | 否 | 代運(yùn)維時(shí)間。單位:秒。 | 0 |
AlarmMetadata | string | 否 | 服務(wù)報(bào)警配置。 說明
當(dāng) PolicyNames 中配置了報(bào)警權(quán)限策略后,該配置才會(huì)生效。
| { "TemplateUrl": "http://template.file.url", // 應(yīng)用分組級(jí)別告警元數(shù)據(jù) "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] } |
ShareType | string | 否 | 共享類型。可能的值:
| Public |
ApprovalType | string | 否 | 服務(wù)使用申請(qǐng)審批類型。可能的值:
| Manual |
VersionName | string | 否 | 版本名稱。 | Draft |
UpgradeMetadata | string | 否 | 升級(jí)元數(shù)據(jù)。 | {\"Description\":\"xxx\",\"SupportRollback\":true,\"SupportUpgradeFromVersions\":[],\"UpgradeComponents\":[\"Configuration\"]} |
TrialDuration | long | 否 | 試用時(shí)長。單位:天。試用時(shí)長的最長天數(shù)不超過 30 天。 | 7 |
Tag | array<object> | 否 | 用戶自定義標(biāo)簽。 | |
object | 否 | 用戶自定義標(biāo)簽。 | ||
Key | string | 否 | 標(biāo)簽鍵。 | Usage |
Value | string | 否 | 標(biāo)簽值。 | Web |
TenantType | string | 否 | 租戶類型。可能的值:
| SingleTenant |
LicenseMetadata | string | 否 | 許可證元數(shù)據(jù)。 | {\"PayType\":\"CustomFixTime\",\"DefaultLicenseDays\":7,\"CustomMetadata\":[{\"TemplateName\":\"模板1\",\"SpecificationName\":\"bandwith-0\",\"CustomData\":\"1\"}]} |
OperationMetadata | string | 否 | 代運(yùn)維配置。 | {\"PrometheusConfigMap\":{\"New_Vpc_Ack_And_Jumpserver\":{}}} |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-aek25refu7r3opq |
LogMetadata | string | 否 | 應(yīng)用日志配置。 | { "Logstores": [ { "LogstoreName": "access-log", "LogPath": "/home/admin/app/logs", # 對(duì)容器不需要,在YAML中配置 "FilePattern": "access.log*" # 對(duì)容器不需要,在YAML中配置 } ] } |
SourceServiceId | string | 否 | 分銷源服務(wù) ID。 | service-70a3b15bb62643xxxxxx |
SourceServiceVersion | string | 否 | 分銷源服務(wù)版本。 | 1 |
Resellable | boolean | 否 | 是否支持分銷。可能的值:
| false |
BuildParameters | string | 否 | 構(gòu)建服務(wù)參數(shù)。 | { "ServiceTemplateId": "st-xxxxx"} |
DryRun | boolean | 否 | 是否空跑檢查。 | true |
ComplianceMetadata | object | 否 | 合規(guī)檢查元數(shù)據(jù)。 | |
CompliancePacks | array | 否 | 選擇的合規(guī)包。 | |
string | 否 | 選擇的合規(guī)包。可選值:
| VpcDataRisk |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Status": "Created",
"RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D550C",
"Version": "draft",
"ServiceId": "service-0e6fca6a51a544xxxxxx",
"DryRunResult": {
"RolePolicy": {
"Policy": "{\n\t\"Statement\": [{\n\t\t\"Action\": [\"oos:CancelExecutions\", \"oos:DeleteExecutions\", \"oos:GetTemplate\", \"oos:ListExecutions\", \"oos:ListTemplates\", \"oos:NotifyExecution\", \"oos:StartExecution\"],\n\t\t\"Effect\": \"Allow\",\n\t\t\"Resource\": \"*\"\n\t}, {\n\t\t\"Action\": [\"ram:PassRole\"],\n\t\t\"Effect\": \"Allow\",\n\t\t\"Resource\": \"*\"\n\t}, {\n\t\t\"Action\": [\"ros:CreateStack\", \"ros:GetStack\", \"ros:UpdateStack\", \"ros:ListStackEvents\", \"ros:ListStackResources\", \"ros:ListStackResources\", \"ros:DeleteStack\", \"ram:GetRole\"],\n\t\t\"Effect\": \"Allow\",\n\t\t\"Resource\": \"*\"\n\t}],\n\t\"Version\": \"1\"\n}",
"MissingPolicy": [
{
"ServiceName": "ecs",
"Resource": "*",
"Action": [
"CreateStack"
]
}
]
}
}
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-10-25 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-10-22 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2024-08-23 | OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2024-03-22 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2023-10-24 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-09-15 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-08-11 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-08-03 | OpenAPI 描述信息更新、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-05-25 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2023-05-08 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2022-07-27 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2022-07-22 | 新增 OpenAPI | 查看變更詳情 |
2021-12-15 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2021-09-22 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |