全部产品
Search
文档中心

可观测监控 Prometheus 版:CreateEnvironment - 创建环境

更新时间:Nov 05, 2024

创建环境实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:CreateEnvironmentcreate
  • Environment
    acs:arms:{#regionId}:{#accountId}:environment/*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
AliyunLangstring

语言环境, 默认为中文。

枚举值:
  • en英文
  • zh中文
zh
EnvironmentNamestring

环境名称。

env1
EnvironmentTypestring

环境类型:

  • CS:容器服务。
  • ECS:ECS。
  • Cloud:云服务。
CS
EnvironmentSubTypestring

环境的子类型:

  • CS 类型的环境:目前支持 ACK、One 子类型。
  • ECS 类型的环境:目前支持 ECS 子类型。
  • Cloud 类型的环境:目前支持 Cloud 子类型。
ECS、ACK等。
BindResourceIdstring

环境绑定的资源实例 ID,包括容器实例 ID 或 VpcId。 对于 Cloud 类型的环境,当前字段值为 RegionId。

c6e9dec475dca4a50a188411d8cbxxx
ManagedTypestring

托管类型:

  • none: 非托管。ACK 集群的默认值。
  • agent:托管 agent(含 ksm)。ASK、ACS、AckOne 集群的默认值。
  • agent-exporter: 托管 agent 和 exporter。云服务类型的默认值。
none
FeePackagestring

付费套餐。

  • EnvironmentType 为 CS 时:可以指定为 CS_Basic(默认值)或 CS_Pro。
  • EnvironmentType 为其它值时,请输入空值。
CS_Basic
PrometheusInstanceIdstring

可空,环境绑定的 prom 实例 id。如果未提供,请调用 InitEnvironment 接口完成存储实例的初始化。

c6e9dec475dca4a50a188411d8cbxxx
GrafanaWorkspaceIdstring

环境绑定的 grafana 工作区 id。传空时,表示使用默认的共享 grafana。

grafana-rnglkcdrntlhk0****
ResourceGroupIdstring

资源组 Id。

rg-acfmxyexli2****
Tagsarray<object>

可以传此参数,给实例创建标签进行管理。

object

标签。

Keystring

标签名。

TestKey
Valuestring

标签值。

TestValue
InitEnvironmentboolean

是否初始化环境

false

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

16AF921B-8187-489F-9913-43C808B4****
Codeinteger

状态码。200 表示成功。

200
Datastring

返回成功增加的环境 Id。

env-xxxxx
Messagestring

返回结果的提示信息。

message

示例

正常返回示例

JSON格式

{
  "RequestId": "16AF921B-8187-489F-9913-43C808B4****",
  "Code": 200,
  "Data": "env-xxxxx",
  "Message": "message"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-17OpenAPI 入参发生变更查看变更详情
2024-05-28OpenAPI 入参发生变更查看变更详情
2024-05-08API 内部配置变更,不影响调用查看变更详情
2024-03-19OpenAPI 入参发生变更查看变更详情
2024-02-23OpenAPI 入参发生变更查看变更详情
2024-01-09OpenAPI 入参发生变更查看变更详情
2023-11-03API 内部配置变更,不影响调用查看变更详情