创建环境实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
arms:CreateEnvironment | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
AliyunLang | string | 否 | 语言环境, 默认为中文。 枚举值:
| zh |
EnvironmentName | string | 是 | 环境名称。 | env1 |
EnvironmentType | string | 是 | 环境类型:
| CS |
EnvironmentSubType | string | 是 | 环境的子类型:
| ECS、ACK等。 |
BindResourceId | string | 是 | 环境绑定的资源实例 ID,包括容器实例 ID 或 VpcId。 对于 Cloud 类型的环境,当前字段值为 RegionId。 | c6e9dec475dca4a50a188411d8cbxxx |
ManagedType | string | 否 | 托管类型:
| none |
FeePackage | string | 否 | 付费套餐。
| CS_Basic |
PrometheusInstanceId | string | 否 | 可空,环境绑定的 prom 实例 id。如果未提供,请调用 InitEnvironment 接口完成存储实例的初始化。 | c6e9dec475dca4a50a188411d8cbxxx |
GrafanaWorkspaceId | string | 否 | 环境绑定的 grafana 工作区 id。传空时,表示使用默认的共享 grafana。 | grafana-rnglkcdrntlhk0**** |
ResourceGroupId | string | 否 | 资源组 Id。 | rg-acfmxyexli2**** |
Tags | array<object> | 否 | 可以传此参数,给实例创建标签进行管理。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 标签名。 | TestKey |
Value | string | 否 | 标签值。 | TestValue |
InitEnvironment | boolean | 否 | 是否初始化环境 | false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "16AF921B-8187-489F-9913-43C808B4****",
"Code": 200,
"Data": "env-xxxxx",
"Message": "message"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-17 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-28 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-08 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-03-19 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-02-23 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-01-09 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-11-03 | API 内部配置变更,不影响调用 | 查看变更详情 |