すべてのプロダクト
Search

このプロダクト

    Application Real-Time Monitoring Service:DescribeEnvironment

    ドキュメントセンター

    Application Real-Time Monitoring Service:DescribeEnvironment

    最終更新日:Apr 11, 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:DescribeEnvironment

    get

    *Environment

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    EnvironmentId

    string

    必須

    環境インスタンスの ID。

    env-xxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    RequestId

    string

    リクエスト ID。

    C21AB7CF-B7AF-410F-BD61-82D1567F****
    Code

    integer

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

    200
    Data

    object

    返される構造体。

    EnvironmentId

    string

    環境インスタンスの ID。

    env-xxxxx
    EnvironmentType

    string

    環境のタイプ。有効な値：

    • CS：Container Service for Kubernetes (ACK)

    • ECS：Elastic Compute Service (ECS)

    • Cloud：クラウドサービス

    CS
    EnvironmentName

    string

    環境名。

    env1
    EnvironmentSubType

    string

    環境サブタイプ：

    • CS：現在 ACK をサポートしています。

    • ECS：現在 ECS をサポートしています。

    • Cloud：現在 Cloud をサポートしています。

    ACK
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    UserId

    string

    ユーザー ID。

    13002222xxxx
    BindResourceId

    string

    環境に関連付けられたリソースの ID (ACK クラスター ID や VPC ID など)。

    vpc-xxxxx
    BindResourceType

    string

    リソースタイプ。

    ECS
    BindResourceStatus

    string

    リソースのステータス。

    running
    BindResourceProfile

    string

    リソースのプロファイル。

    Default
    BindVpcCidr

    string

    VPC CIDR ブロック。

    192.168.0.0/16
    PrometheusInstanceId

    string

    Prometheus インスタンスの ID。

    xxxxyyyyyzzzzz
    PrometheusInstanceName

    string

    Prometheus インスタンスの名前。

    name1
    GrafanaWorkspaceId

    string

    Grafana ワークスペースの ID。

    grafana-cn-i7m2qn9xa01
    GrafanaFolderUid

    string

    Grafana ディレクトリの一意の ID。

    xyz
    GrafanaDatasourceUid

    string

    Grafana データソースの一意の ID。

    zuvw
    VpcId

    string

    VPC ID。

    vpc-8vb02uk57qbcktqcvqqqj
    GrafanaFolderUrl

    string

    Grafana ディレクトリの URL。

    https://gnew.console.alibabacloud.com/dashboards/f/xxx/yyyy
    BindResourceStoreDuration

    string

    リソースの保存期間。単位：日。

    15
    GrafaDataSourceName

    string

    Grafana データソースの名前。

    datasource1
    GrafanaFolderTitle

    string

    Grafana ディレクトリの名前。

    folder1
    ManagedType

    string

    管理タイプ：

    • none：非管理。ACK クラスターのデフォルト値。

    • agent：管理対象エージェント (KSM を含む)。ASK、ACS、AckOne クラスターのデフォルト値。

    • agent-exporter：管理対象エージェントと exporter。クラウドサービスタイプのデフォルト値。

    列挙値:

    • agent :

      管理対象エージェント

    • agent-exporter :

      管理対象エージェントと exporter

    • none :

      非管理

    none
    FeePackage

    string

    支払い対象リソースプラン。有効な値：

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

    • それ以外の場合は、パラメーターを空のままにします。

    列挙値:

    • CS_Pro :
    • CS_Basic :

    CS_Basic
    DbInstanceStatus

    string

    Prometheus インスタンスにバインドされているデータベースのステータス。

    有効な値：

    • UNINSTALLING

    • INSTALLING

    • UNINSTALLED

    • RUNNING

    • MODIFYING

    列挙値:

    • UNINSTALLING :

      UNINSTALLING

    • INSTALLING :

      INSTALLING

    • UNINSTALLED :

      UNINSTALLED

    • RUNNING :

      RUNNING

    • MODIFYING :

      MODIFYING

    RUNNING
    SecurityGroupId

    string

    環境に関連付けられたセキュリティグループの ID。

    sg-8vbdgmf4nraiqa9bx0jo
    VswitchId

    string

    環境に関連付けられた vSwitch の ID。

    vsw-2ze7yr3f1x8snryaioo7u
    ResourceGroupId

    string

    リソースグループの ID。

    rg-aek2vezare****
    Tags

    array<object>

    タグ。

    object

    タグ。

    Key

    string

    タグキー。

    user1
    Value

    string

    タグ値。

    p_运维
    Message

    string

    返されるメッセージ。

    message

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "C21AB7CF-B7AF-410F-BD61-82D1567F****",
  "Code": 200,
  "Data": {
    "EnvironmentId": "env-xxxxx",
    "EnvironmentType": "CS",
    "EnvironmentName": "env1",
    "EnvironmentSubType": "ACK",
    "RegionId": "cn-hangzhou",
    "UserId": "13002222xxxx",
    "BindResourceId": "vpc-xxxxx",
    "BindResourceType": "ECS",
    "BindResourceStatus": "running",
    "BindResourceProfile": "Default",
    "BindVpcCidr": "192.168.0.0/16",
    "PrometheusInstanceId": "xxxxyyyyyzzzzz",
    "PrometheusInstanceName": "name1",
    "GrafanaWorkspaceId": "grafana-cn-i7m2qn9xa01",
    "GrafanaFolderUid": "xyz",
    "GrafanaDatasourceUid": "zuvw",
    "VpcId": "vpc-8vb02uk57qbcktqcvqqqj",
    "GrafanaFolderUrl": "https://gnew.console.alibabacloud.com/dashboards/f/xxx/yyyy",
    "BindResourceStoreDuration": "15",
    "GrafaDataSourceName": "datasource1",
    "GrafanaFolderTitle": "folder1",
    "ManagedType": "none",
    "FeePackage": "CS_Basic",
    "DbInstanceStatus": "RUNNING",
    "SecurityGroupId": "sg-8vbdgmf4nraiqa9bx0jo",
    "VswitchId": "vsw-2ze7yr3f1x8snryaioo7u",
    "ResourceGroupId": "rg-aek2vezare****",
    "Tags": [
      {
        "Key": "user1",
        "Value": "p_运维"
      }
    ]
  },
  "Message": "message"
}

    エラーコード

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

    変更履歴

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