ListNamespacedConfigMaps API 概要 - SAE - Alibaba Cloud - Serverless App Engine

指定された名前空間内の ConfigMap インスタンスを一覧表示します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:ListNamespacedConfigMaps

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/configmap/listNamespacedConfigMaps HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NamespaceId	string	必須	名前空間の ID です。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータです。
RequestId	string	リクエスト ID です。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	応答メッセージです。有効値：リクエストが成功した場合、success が返されます。リクエストが失敗した場合、エラーメッセージが返されます。	success
TraceId	string	リクエストのトレースに使用できるトレース ID です。	0a98a02315955564772843261e****
Data	object	リクエストによって返されるデータです。
ConfigMaps	array<object>	ConfigMap インスタンスのリストです。
	array<object>	各 ConfigMap インスタンスの詳細です。
UpdateTime	integer	最終更新時間です。	1593760185111
Data	object	ConfigMap インスタンスのキーと値のペアです。 ConfigMap の詳細については、「設定項目の管理と使用」をご参照ください。	{"k1":"v1","k2":"v2"}
NamespaceId	string	名前空間 ID です。	cn-hangzhou
Description	string	インスタンスの説明です。	test-desc
CreateTime	integer	作成時間です。	1593760185111
RelateApps	array<object>	関連付けられたアプリケーションです。
	object	各アプリケーションの詳細です。
AppName	string	アプリケーション名です。	test-app
AppId	string	アプリケーション ID です。	f16b4000-9058-4c22-a49d-49a28f0b****
ConfigMapId	integer	ConfigMap インスタンスの ID です。	1
Name	string	インスタンスの名前です。	test-name
ErrorCode	string	エラーコードです。このパラメーターは、リクエストが失敗した場合にのみ返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	HTTP ステータスコードです。有効値： 2xx：リクエストは成功しました。 3xx：リクエストはリダイレクトされました。 4xx：クライアントエラーが発生しました。 5xx：サーバーエラーが発生しました。	200
Success	boolean	リクエストが成功したかどうかを示します。有効値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ConfigMaps": [
      {
        "UpdateTime": 1593760185111,
        "Data": {
          "k1": "v1",
          "k2": "v2"
        },
        "NamespaceId": "cn-hangzhou",
        "Description": "test-desc",
        "CreateTime": 1593760185111,
        "RelateApps": [
          {
            "AppName": "test-app",
            "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****"
          }
        ],
        "ConfigMapId": 1,
        "Name": "test-name"
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.

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

変更履歴

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