ListK8sSecrets API による名前空間間 Kubernetes シークレットのクエリ - EDAS

Kubernetes Secret をクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

edas:ReadCluster

get

*All Resource

*

なし

リクエスト構文

GET /pop/v5/k8s/acs/k8s_secret HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	任意	クラスターの ID。	7a953f9a-2946-4c7a-9d82-9939db******
Namespace	string	任意	Kubernetes クラスターの名前空間。	default
RegionId	string	任意	リージョン ID。	cn-hangzhou
PageNo	integer	任意	返すページの番号。ページは 0 から始まります。	0
PageSize	integer	任意	各ページで返すエントリの数。値 0 は、すべてのエントリが 1 ページで返されることを示します。	10
Condition	string	任意	フィルター条件。このパラメーターを `{"field":"Name", "pattern":"configmap-"}` のフォーマットの JSON 文字列に設定します。	{\"field\":\"Name\",\"pattern\":\"product\"}
ShowRelatedApps	boolean	任意	Secret を使用するアプリケーションのリストを返すかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object
Code	integer	返される HTTP ステータスコード。	200
Message	string	返される追加情報。	success
RequestId	string	リクエスト ID。	b197-40ab-9155-****
Result	object	返された Kubernetes Secret のクエリ結果。
Total	integer	返されたエントリの総数。	6
Secrets	array<object>	Kubernetes Secret に関する情報。
	array<object>
Type	string	Secret のタイプ。有効な値： Opaque：ユーザー定義データ kubernetes.io/tls：Transport Layer Security (TLS) 証明書	Opaque
CreationTime	string	Secret が作成された時間。時間は、yyyy-MM-ddThh:mm:ssZ 形式の ISO 8601 標準に従います。時間は UTC で表示されます。	2022-05-26T02:57:02Z
ClusterName	string	クラスターの名前。	test-cluster
Namespace	string	Kubernetes クラスターの名前空間。	default
Base64Encoded	boolean	データが Base64 エンコードされているかどうかを示します。有効な値： true：データは Base64 エンコードされています。 false：データは Base64 エンコードされていません。	false
CertRegionId	string	証明書が保存されているリージョン。	cn-hangzhou
CertId	string	Alibaba Cloud Certificate Management Service によって提供される証明書の ID。	123456
Name	string	Secret の名前。名前は文字で始まる必要があり、数字、文字、ハイフン (-) を含めることができます。長さは最大 63 文字です。	my-secret
ClusterId	string	Enterprise Distributed Application Service (EDAS) のクラスター ID。	4472a6d3-f01d-4087-85a7-3dc52********
RelatedIngressRules	array<object>	Secret に関連付けられている Ingress 内のルール。
	array<object>
Name	string	Ingress 内のルールの名前。	testrulename
Namespace	string	Kubernetes クラスターの名前空間。	default
RelatedApps	array<object>	Ingress に関連付けられているアプリケーション。
	object
AppName	string	EDAS アプリケーションの名前。	app-test
AppId	string	アプリケーションの ID。	6dc74432-5a35-4e68-8aaa-3700********
Data	array<object>	Kubernetes Secret のデータ。
	object
Key	string	Kubernetes Secret のユーザー定義キー。	name
Value	string	Kubernetes Secret のユーザー定義値。	william
RelatedApps	array<object>	Secret を使用するアプリケーション。
	object
AppName	string	アプリケーションの名前。	my-app
AppId	string	アプリケーションの ID。	b08eeb18-8946-410c-a1ea-dbbc********
CertDetail	object	Secure Sockets Layer (SSL) 証明書の詳細。
EndTime	string	SSL 証明書の有効期限が切れた時間。	2022-02-22T02:32:41Z
Status	string	SSL 証明書の状態。有効な値： normal：SSL 証明書は有効です。 invalid：SSL 証明書は無効です。 expired：SSL 証明書の有効期限が切れています。 not_yet_valid：SSL 証明書は現在無効です。 about_to_expire：SSL 証明書の有効期限がまもなく切れます。	normal
StartTime	string	SSL 証明書が有効になった時間。	2022-01-02T22:40:00Z
Issuer	string	SSL 証明書を発行した認証局 (CA)。	CN=GlobalSign Root CA, OU=Root CA, O=GlobalSign nv-sa, C=BE
DomainNames	array	SSL 証明書に関連付けられているドメイン名。
	string	ドメイン名。	example.com

例

成功レスポンス

JSONJSON

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-****",
  "Result": {
    "Total": 6,
    "Secrets": [
      {
        "Type": "Opaque",
        "CreationTime": "2022-05-26T02:57:02Z",
        "ClusterName": "test-cluster",
        "Namespace": "default",
        "Base64Encoded": false,
        "CertRegionId": "cn-hangzhou",
        "CertId": "123456",
        "Name": "my-secret",
        "ClusterId": "4472a6d3-f01d-4087-85a7-3dc52********",
        "RelatedIngressRules": [
          {
            "Name": "testrulename",
            "Namespace": "default",
            "RelatedApps": [
              {
                "AppName": "app-test",
                "AppId": "6dc74432-5a35-4e68-8aaa-3700********"
              }
            ]
          }
        ],
        "Data": [
          {
            "Key": "name",
            "Value": "william"
          }
        ],
        "RelatedApps": [
          {
            "AppName": "my-app",
            "AppId": "b08eeb18-8946-410c-a1ea-dbbc********"
          }
        ],
        "CertDetail": {
          "EndTime": "2022-02-22T02:32:41Z",
          "Status": "normal",
          "StartTime": "2022-01-02T22:40:00Z",
          "Issuer": "CN=GlobalSign Root CA, OU=Root CA, O=GlobalSign nv-sa, C=BE",
          "DomainNames": [
            "example.com"
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	Edas.errorcode.PermissionDenied.message	You are not authorized to perform the operation.	権限なしに操作する

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

変更履歴

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