すべてのプロダクト
Search
ドキュメントセンター

Application Real-Time Monitoring Service:CreateEnvironment

最終更新日:May 29, 2026

環境インスタンスを作成します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

arms:CreateEnvironment

create

*Environment

acs:arms:{#regionId}:{#accountId}:environment/*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID。

cn-hangzhou

AliyunLang

string

任意

言語。デフォルト値: zh

有効な値:

  • en: 英語

  • zh: 中国語

列挙値:

  • en :

    en

  • zh :

    zh

zh

EnvironmentName

string

必須

環境名。

env1

EnvironmentType

string

必須

環境タイプ。有効な値:

  • CS: コンテナサービス

  • ECS: Elastic Compute Service (ECS)

  • Cloud: クラウドサービス

CS

EnvironmentSubType

string

必須

環境サブタイプ。有効な値:

  • CS: Container Service for Kubernetes (ACK) または Distributed Cloud Container Platform for Kubernetes (ACK One)

  • ECS: ECS

  • Cloud: クラウドサービス

列挙値:

  • ECS :

    ECS

  • Cloud :

    Cloud

  • One :

    One

  • ACK :

    ACK

ECS、ACK等。

BindResourceId

string

必須

環境にバインドするリソースの ID (コンテナ ID や VPC ID など) 。Cloud 環境の場合は、リージョン ID を指定します。

c6e9dec475dca4a50a188411d8cbxxx

ManagedType

string

任意

エージェントまたはエクスポーターを管理するかどうかを指定します。有効な値:

  • none: 管理しません。デフォルトでは、ACK クラスターにマネージドエージェントまたはエクスポーターは提供されません。

  • agent: エージェントが管理されます。デフォルトでは、ASK クラスター、ACS クラスター、および ACK One クラスターにマネージドエージェントが提供されます。

  • agent-exporter: エージェントとエクスポーターが管理されます。デフォルトでは、マネージドエージェントとエクスポーターがクラウドサービスに提供されます。

none

FeePackage

string

任意

有料のリソースプラン。

  • EnvironmentType パラメーターが CS に設定されている場合は、値を CS_Basic または CS_Pro に設定します。デフォルト値: CS_Basic。

  • それ以外の場合は、このパラメーターを空のままにしてください。

CS_Basic

PrometheusInstanceId

string

任意

Prometheus インスタンスの ID。Prometheus インスタンスが作成されていない場合は、InitEnvironment API を呼び出してください。

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

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ

RequestId

string

リクエスト ID。

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

Code

integer

HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。

200

Data

string

作成された環境の ID。

env-xxxxx

Message

string

返されたメッセージ。

message

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。