DescribeConfigMap 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:DescribeConfigMap

get

*All Resource

*

なし

リクエスト構文

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ConfigMapId	integer	必須	ConfigMap の ID。 ListNamespacedConfigMaps 操作を呼び出して ID を取得できます。	1

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	返されたメッセージ。リクエストが成功した場合、値は success です。リクエストが失敗した場合、値はエラーコードです。	success
TraceId	string	トレース ID。この ID を使用して、呼び出しの詳細を特定できます。	0a98a02315955564772843261e****
Data	object	返されたデータ。
UpdateTime	integer	インスタンスが最後に更新された時刻。	1593747274195
Data	object	ConfigMap のキーと値のペア。データは次の形式です： {"k1":"v1", "k2":"v2"} 設定項目の詳細については、「設定項目の管理と使用」をご参照ください。	{"k1":"v1","k2":"v2"}
NamespaceId	string	名前空間 ID。	cn-hangzhou
Description	string	ConfigMap インスタンスの説明。	test-desc
CreateTime	integer	インスタンスが作成された時刻。	1593746835111
RelateApps	array<object>	関連付けられたアプリケーション。
	object	アプリケーションの詳細。
AppName	string	アプリケーション名。	test-app
AppId	string	アプリケーション ID。	f16b4000-9058-4c22-a49d-49a28f0b****
ConfigMapId	integer	ConfigMap インスタンスの ID。	1
Name	string	ConfigMap インスタンスの名前。	test-configmap
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": {
    "UpdateTime": 1593747274195,
    "Data": {
      "k1": "v1",
      "k2": "v2"
    },
    "NamespaceId": "cn-hangzhou",
    "Description": "test-desc",
    "CreateTime": 1593746835111,
    "RelateApps": [
      {
        "AppName": "test-app",
        "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****"
      }
    ],
    "ConfigMapId": 1,
    "Name": "test-configmap"
  },
  "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
400	NotFound.ConfigMap	The ConfigMap object (ID: %s) does not exist.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.

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

変更履歴

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