すべてのプロダクト
Search

このプロダクト

    Simple Application Server:ListKeyPairs

    ドキュメントセンター

    Simple Application Server:ListKeyPairs

    最終更新日:Sep 09, 2026

    キーペアの一覧を照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    swas-open:ListKeyPairs

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID です。利用可能なリージョンを確認するには、ListRegions API を呼び出してください。

    cn-hangzhou
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用するクライアントトークンです。クライアント側で一意の値を生成し、このパラメーターに設定してください。リクエストごとに一意の値を指定してください。 ClientToken には ASCII 文字のみ使用可能です。 64 文字を超えることはできません。詳細については、「べき等性の確保方法」をご参照ください。

    123e4567-e89b-12d3-a456-426655440000
    KeyPairName

    string

    任意

    キーペアの名前です。名前は 2 ～ 64 文字で、英字と中国語を含めることができます。先頭は、大文字または小文字の英字、または中国語である必要があります。http:// または https:// で始めることはできません。数字、コロン (:)、アンダースコア (_)、またはハイフン (-) を含めることができます。

    KeyPairName
    PageNumber

    integer

    任意

    キーペア一覧のページ番号です。最小値： 1。デフォルト値： 1。

    1
    PageSize

    integer

    任意

    各ページに返すエントリ数です。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    キーペアの合計数です。

    3
    RequestId

    string

    リクエスト ID です。

    20758A-585D-4A41-A9B2-28DA8F4F534F
    PageSize

    integer

    各ページに返されるエントリ数です。

    10
    PageNumber

    integer

    現在のページ番号です。

    1
    KeyPairs

    array<object>

    キーペア情報のコレクションです。

    object

    キーペアの情報です。

    CreationTime

    string

    キーペアが作成された時刻です。時刻は UTC (Z) タイムゾーンに準拠し、 YYYY-MM-DDThh:mmZ 形式です。

    2024-05-06T02:28Z
    KeyPairName

    string

    キーペアの名前です。名前は 2 ～ 64 文字で、英字と中国語を含めることができます。先頭は、大文字または小文字の英字、または中国語である必要があります。http:// または https:// で始めることはできません。数字、コロン (:)、アンダースコア (_)、またはハイフン (-) を含めることができます。

    testKeyPairName
    PublicKey

    string

    パブリックキーの内容です。

    ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****
    InstanceIds

    array

    Simple Application Server インスタンスの ID の配列です。最大 50 個のインスタンス ID に対応します。

    string

    Simple Application Server インスタンスの ID です。

    2ad1ae67295445f598017499dc****

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 3,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "KeyPairs": [
    {
      "CreationTime": "2024-05-06T02:28Z",
      "KeyPairName": "testKeyPairName",
      "PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****",
      "InstanceIds": [
        "2ad1ae67295445f598017499dc****"
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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