すべてのプロダクト
Search

このプロダクト

    Serverless App Engine:DescribeSecret

    ドキュメントセンター

    Serverless App Engine:DescribeSecret

    最終更新日:Apr 22, 2026

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sae:DescribeSecret

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /pop/v1/sam/secret/secret HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    NamespaceId

    string

    必須

    Secret が存在する名前空間の ID。 名前空間がデフォルトの名前空間である場合は、cn-beijing などのリージョン ID のみ入力する必要があります。

    cn-beijing:test
    SecretId

    integer

    必須

    照会対象の Secret インスタンスの ID。 ListSecrets 操作を呼び出して、Secret インスタンスの ID を表示できます。

    16

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    RequestId

    string

    リクエスト ID。

    91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    Message

    string

    返される追加情報。 有効な値：

    • success：呼び出しが成功した場合、success が返されます。

    • エラーコード：呼び出しが失敗した場合、エラーコードが返されます。

    success
    TraceId

    string

    リクエストの詳細の照会に使用されるトレース ID。

    0a98a02315955564772843261e****
    Data

    object

    応答。

    NamespaceId

    string

    名前空間 ID。

    cn-beijing:test
    SecretId

    integer

    Secret インスタンスの ID。

    16
    SecretName

    string

    Secret インスタンスの名前。

    registry-auth
    SecretType

    string

    Secret インスタンスのタイプ。

    kubernetes.io/dockerconfigjson
    SecretData

    object

    Secret のキーと値のペアのデータ。

    string

    Secret のキーと値のペアのデータ。

    {".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}
    CreateTime

    integer

    タスクが作成された時間。

    1593746835111
    UpdateTime

    integer

    タスクが更新された時間。

    1593746835111
    RelateApps

    array<object>

    関連付けられたアプリケーション。

    object

    アプリケーションに関する情報。

    AppId

    string

    アプリケーション ID。

    f16b4000-9058-4c22-a49d-49a28f0b****
    AppName

    string

    アプリケーション名。

    test-app
    ErrorCode

    string

    返されるエラーコード。 有効な値：

    • リクエストが成功した場合、ErrorCode パラメーターは返されません。

    • 呼び出しが失敗した場合、ErrorCode パラメーターが返されます。 詳細については、このトピックの「エラーコード」をご参照ください。

    Code

    string

    HTTP ステータスコード。 有効な値：

    • 2xx：呼び出しは成功しました。

    • 3xx：呼び出しはリダイレクトされました。

    • 4xx：呼び出しは失敗しました。

    • 5xx：サーバーエラーが発生しました。

    200
    Success

    boolean

    Secret インスタンスの詳細が正常に照会されたかどうかを示します。 有効な値：

    • true：情報が照会されました。

    • false：イメージが見つかりませんでした。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "NamespaceId": "cn-beijing:test",
    "SecretId": 16,
    "SecretName": "registry-auth",
    "SecretType": "kubernetes.io/dockerconfigjson",
    "SecretData": {
      "key": "{\".dockerconfigjson\":\"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0=\"}"
    },
    "CreateTime": 1593746835111,
    "UpdateTime": 1593746835111,
    "RelateApps": [
      {
        "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****",
        "AppName": "test-app"
      }
    ]
  },
  "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 InvalidSecretId.NotFound The specified SecretId [%s] does not exist in our records.
    404 InvalidNamespaceId.NotFound The specified NamespaceId does not exist.

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

    変更履歴

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