DescribeHybridMonitorNamespaceList でハイブリッドモニター名前空間とデータソースをクエリ - CMS

名前空間のリストとそのデータソースの詳細をクエリします。

操作説明

この例では、現在のアカウントに属するすべての名前空間をクエリする方法を示します。応答は、aliyun-test という名前空間が 1 つだけ存在することを示しています。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeCustomNamespace

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageSize	integer	任意	各ページで返すエントリ数。最小値: 1。デフォルト値: 10。	10
PageNumber	integer	任意	ページ番号。最小値: 1。デフォルト値: 1。	1
Keyword	string	任意	検索用のキーワード。	aliyun
Namespace	string	任意	名前空間の名前。名前には、大文字、小文字、数字、ハイフン (-) を使用できます。	aliyun-test
ShowTaskStatistic	boolean	任意	Alibaba Cloud サービスのデータインポートタスクの構成詳細と、Alibaba Cloud 以外のサービスのデータインポートタスクの数を表示するかどうかを指定します。有効な値: true false (デフォルト)	false

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	利用可能な説明はありません。
RequestId	string	リクエスト ID。	1EC450A4-3221-5148-B77E-2827576CFE48
Success	string	操作が成功したかどうかを示します。有効な値: true: 操作は成功しました。 false: 操作は失敗しました。	true
Code	string	状態コード。	Success
Message	string	エラーメッセージ。	Specified parameter PageSize is not valid.
PageSize	integer	ページごとに返されるエントリ数。	10
PageNumber	integer	ページ番号。	1
Total	integer	エントリの総数。	1
DescribeHybridMonitorNamespace	array<object>	名前空間の詳細。
	array<object>	利用可能な説明はありません。
Description	string	名前空間の説明。	aliyun-test
CreateTime	string	名前空間が作成されたときのタイムスタンプ。単位: ミリ秒。	1652682744000
Namespace	string	名前空間の名前。	aliyun-test
IsDelete	integer	名前空間が削除されたかどうかを示します。有効な値: 0: 名前空間は削除されていません。 1: 名前空間は削除されました。	0
Id	string	名前空間 ID。	3****
ModifyTime	string	名前空間が最後に変更されたときのタイムスタンプ。単位: ミリ秒。	1652682744000
Detail	object	データストレージ期間の詳細。
Spec	string	データストレージ期間。有効な値: cms.s1.large: 15 日。 cms.s1.xlarge: 32 日。 cms.s1.2xlarge: 63 日。 cms.s1.3xlarge: 93 日。 cms.s1.6xlarge: 185 日。 cms.s1.12xlarge: 376 日。	cms.s1.3xlarge
NamespaceRegion	string	モニタリングデータが保存されているリージョン。説明このパラメーターは、名前空間の作成時に `NamespaceType` を `m_prom_user` に設定した場合に返されます。	cn-hangzhou
SLSProject	string	モニタリングデータが保存されている Simple Log Service (SLS) プロジェクト。説明このパラメーターは、名前空間の作成時に `NamespaceType` を `m_prom_user` に設定した場合に返されます。	cms-hybrid-120886317861****-cn-hangzhou-a83d
PrometheusInstanceId	string	モニタリングデータが保存されている Prometheus インスタンス。説明このパラメーターは、名前空間の作成時に `NamespaceType` を `aliyun_prometheus` に設定した場合に返されます。	rw-57******************7f
NotAliyunTaskNumber	integer	Alibaba Cloud 以外のサービスのデータインポートタスクの数。	0
AliyunProductMetricList	array<object>	Alibaba Cloud サービスのデータインポートタスクの構成詳細。
	array<object>	利用可能な説明はありません。
UserId	integer	名前空間の作成に使用されるアカウント。	120886317861****
NamespaceList	array<object>	名前空間のリスト。
	array<object>	利用可能な説明はありません。
Namespace	string	Alibaba Cloud サービスのデータ名前空間。	acs_ecs_dashboard
MetricList	array<object>	Alibaba Cloud サービスのメトリックのリスト。
	object	利用可能な説明はありません。
Period	integer	メトリックの収集期間。単位: 秒。	60
List	array	メトリックのリスト。
	string	メトリック。	["cpu_total"]
YAMLConfig	string	ハイブリッドクラウド監視に接続されている Alibaba Cloud サービスの構成ファイル。 namespace: Alibaba Cloud サービスの名前空間。 metric_list: Alibaba Cloud サービスのメトリック。 dimension: ハイブリッドクラウド監視でクエリできる Alibaba Cloud サービスのリソース。このパラメーターが空の場合、すべてのリソースが監視されます。	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: ''
NamespaceType	string	モニタリングデータのストレージソリューション。有効な値: m_prom_user: モニタリングデータは SLS に保存されます。 m_prom_pool: モニタリングデータは Cloud Monitor が提供するストレージスペースに保存されます。 aliyun_prometheus: モニタリングデータは Prometheus インスタンスに保存されます。	aliyun_prometheus

例

成功レスポンス

JSONJSON

{
  "RequestId": "1EC450A4-3221-5148-B77E-2827576CFE48",
  "Success": "true",
  "Code": "Success",
  "Message": "Specified parameter PageSize is not valid.",
  "PageSize": 10,
  "PageNumber": 1,
  "Total": 1,
  "DescribeHybridMonitorNamespace": [
    {
      "Description": "aliyun-test",
      "CreateTime": "1652682744000",
      "Namespace": "aliyun-test",
      "IsDelete": 0,
      "Id": "3****",
      "ModifyTime": "1652682744000",
      "Detail": {
        "Spec": "cms.s1.3xlarge",
        "NamespaceRegion": "cn-hangzhou",
        "SLSProject": "cms-hybrid-120886317861****-cn-hangzhou-a83d",
        "PrometheusInstanceId": "rw-57******************7f"
      },
      "NotAliyunTaskNumber": 0,
      "AliyunProductMetricList": [
        {
          "UserId": 0,
          "NamespaceList": [
            {
              "Namespace": "acs_ecs_dashboard",
              "MetricList": [
                {
                  "Period": 60,
                  "List": [
                    "[\"cpu_total\"]"
                  ]
                }
              ]
            }
          ],
          "YAMLConfig": "products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: ''"
        }
      ],
      "NamespaceType": "aliyun_prometheus"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	%s	%s
500	InternalError	%s
403	%s	%s
404	%s	%s
409	%s	Resources already exist.

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

変更履歴

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