通过地域ID、部署类型、服务类型、服务名称等参数,创建新的服务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
computenestsupplier:CreateService | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 | 10CM943JP0EN9D51H |
ServiceId | string | 否 | 服务 ID。 | service-0e6fca6a51a544xxxxxx |
DeployType | string | 是 | 部署类型。可能值:
| ros |
DeployMetadata | string | 否 | 存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用 JSON String 格式进行数据存储。 | {\"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 | 是 | 服务类型。可能的值:
| private |
ServiceInfo | array<object> | 否 | 服务详情。 | |
object | 否 | 服务详情。 | ||
Locale | string | 是 | 服务语言。可能的值:
| zh-CN |
ShortDescription | string | 否 | 服务概述。 | TiDB是A公司自主设计、研发的开源分布式关系型数据库。 |
Image | string | 否 | 服务图标地址。 | http://img.tidb.oss.url |
Name | string | 是 | 服务名称。 | TiDB Database |
LongDescriptionUrl | string | 否 | 服务详细描述 | http://description.tidb.oss.url |
Agreements | array<object> | 否 | 服务的协议文档信息。 | |
object | 否 | 服务的协议文档信息。 | ||
Name | string | 否 | 协议名称。 | Name |
Url | string | 否 | 协议链接。 | https://aliyun.com/xxxxxxxx.html |
IsSupportOperated | boolean | 否 | 是否代运维,默认为:false。可能的值:
说明
当 ServiceType 为 private 时需要填入该值。
| false |
PolicyNames | string | 否 | 策略名称。单个策略名称长度不超过 128 个字符,多个名称使用英文逗号(,)分隔。暂时只支持代运维相关参数策略。 | policyName1, policyName2 |
Duration | long | 否 | 代运维时间。单位:秒。 | 0 |
AlarmMetadata | string | 否 | 服务报警配置。 说明
当 PolicyNames 中配置了报警权限策略后,该配置才会生效。
| { "TemplateUrl": "http://template.file.url", // 应用分组级别告警元数据 "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] } |
ShareType | string | 否 | 共享类型。可能的值:
| Public |
ApprovalType | string | 否 | 服务使用申请审批类型。可能的值:
| Manual |
VersionName | string | 否 | 版本名称。 | Draft |
UpgradeMetadata | string | 否 | 升级元数据。 | {\"Description\":\"xxx\",\"SupportRollback\":true,\"SupportUpgradeFromVersions\":[],\"UpgradeComponents\":[\"Configuration\"]} |
TrialDuration | long | 否 | 试用时长。单位:天。试用时长的最长天数不超过 30 天。 | 7 |
Tag | array<object> | 否 | 用户自定义标签。 | |
object | 否 | 用户自定义标签。 | ||
Key | string | 否 | 标签键。 | Usage |
Value | string | 否 | 标签值。 | Web |
TenantType | string | 否 | 租户类型。可能的值:
| SingleTenant |
LicenseMetadata | string | 否 | 许可证元数据。 | {\"PayType\":\"CustomFixTime\",\"DefaultLicenseDays\":7,\"CustomMetadata\":[{\"TemplateName\":\"模板1\",\"SpecificationName\":\"bandwith-0\",\"CustomData\":\"1\"}]} |
OperationMetadata | string | 否 | 代运维配置。 | {\"PrometheusConfigMap\":{\"New_Vpc_Ack_And_Jumpserver\":{}}} |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-aek25refu7r3opq |
LogMetadata | string | 否 | 应用日志配置。 | { "Logstores": [ { "LogstoreName": "access-log", "LogPath": "/home/admin/app/logs", # 对容器不需要,在YAML中配置 "FilePattern": "access.log*" # 对容器不需要,在YAML中配置 } ] } |
SourceServiceId | string | 否 | 分销源服务 ID。 | service-70a3b15bb62643xxxxxx |
SourceServiceVersion | string | 否 | 分销源服务版本。 | 1 |
Resellable | boolean | 否 | 是否支持分销。可能的值:
| false |
BuildParameters | string | 否 | 构建服务参数。 | { "ServiceTemplateId": "st-xxxxx"} |
返回参数
示例
正常返回示例
JSON
格式
{
"Status": "Created",
"RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D550C",
"Version": "draft",
"ServiceId": "service-0e6fca6a51a544xxxxxx",
"DryRunResult": {
"RolePolicy": {
"Policy": "",
"MissingPolicy": [
{
"ServiceName": "",
"Resource": "",
"Action": [
""
]
}
]
}
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-22 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-10-24 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-09-15 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-08-11 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-08-03 | OpenAPI 描述信息更新、OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-25 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-05-08 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-07-27 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-07-22 | 新增 OpenAPI | 查看变更详情 |
2021-12-15 | OpenAPI 入参发生变更 | 查看变更详情 |
2021-09-22 | OpenAPI 入参发生变更 | 查看变更详情 |