すべてのプロダクト
Search

このプロダクト

    :ListHandshakesForResourceDirectory

    ドキュメントセンター

    :ListHandshakesForResourceDirectory

    最終更新日:Dec 21, 2025

    リソースディレクトリ内の招待を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    返すページ番号。

    ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    integer

    任意

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

    有効な値：1～100。デフォルト値：10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返された結果。

    TotalCount

    integer

    返されたエントリの総数。

    2
    RequestId

    string

    リクエストの ID。

    9B34724D-54B0-4A51-B34D-4512372FE1BE
    PageSize

    integer

    ページあたりに返されるエントリ数。

    10
    PageNumber

    integer

    返されたページのページ番号。

    1
    Handshakes

    object

    Handshake

    array<object>

    招待の情報。

    object

    招待の情報。

    Status

    string

    招待のステータス。有効な値：

    • Pending：招待は確認待ちです。

    • Accepted：招待は承諾済みです。

    • Cancelled：招待はキャンセル済みです。

    • Declined：招待は拒否済みです。

    • Expired：招待は期限切れです。

    Pending
    ExpireTime

    string

    招待の有効期限。時刻は UTC で表示されます。

    2018-08-24T09:55:41Z
    ResourceDirectoryId

    string

    リソースディレクトリの ID。

    rd-abcdef****
    CreateTime

    string

    招待が作成された時刻。時刻は UTC で表示されます。

    2018-08-10T09:55:41Z
    Note

    string

    招待の説明。

    Welcome

    TargetEntity

    string

    招待されたアカウントの ID またはログインメールアドレス。

    someone@example.com
    MasterAccountId

    string

    リソースディレクトリの管理アカウントの ID。

    172841235500****
    MasterAccountName

    string

    リソースディレクトリの管理アカウントの名前。

    Alice
    ModifyTime

    string

    招待が更新された時刻。時刻は UTC で表示されます。

    2018-08-10T09:55:41Z
    TargetType

    string

    招待されたアカウントのタイプ。有効な値：

    • Account：アカウントの ID を示します。

    • Email：アカウントのログインメールアドレスを示します。

    Email
    HandshakeId

    string

    招待の ID。

    h-ycm4rp****

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 2,
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "PageSize": 10,
  "PageNumber": 1,
  "Handshakes": {
    "Handshake": [
      {
        "Status": "Pending",
        "ExpireTime": "2018-08-24T09:55:41Z",
        "ResourceDirectoryId": "rd-abcdef****",
        "CreateTime": "2018-08-10T09:55:41Z",
        "Note": "Welcome\n",
        "TargetEntity": "someone@example.com",
        "MasterAccountId": "172841235500****",
        "MasterAccountName": "Alice",
        "ModifyTime": "2018-08-10T09:55:41Z",
        "TargetType": "Email",
        "HandshakeId": "h-ycm4rp****"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 EntityNotExists.ResourceDirectory The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.

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

    変更履歴

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