メインコンテンツまでスキップ

アカウントリストの取得

CelerData Cloud BYOC 組織内のすべてのアカウントのリストを取得します。

注意

この操作には組織管理権限が必要です。

リクエスト​

基本情報
HTTP URLhttps://cloud-api.celerdata.com/api/1.0/accounts
HTTP メソッドGET
頻度600/分

ヘッダーパラメータ​

パラメータ例必須タイプ説明
AuthorizationBearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUYYesStringCelerData Cloud BYOC API にアクセスするためのアクセストークン。形式: Bearer <access_token>。

アクセストークンの取得 を参照してください。

レスポンス​

サンプルレスポンス​

{
    "code": 20000,
    "data": [
        {
            "account_id": "lbyx0bt7a",
            "account_name": "A1",
            "email": "a@a.com",
            "state": "IN_USE",
            "is_root_account": true,
            "create_at": 1675858169913
        }
    ]
}

レスポンス要素​

パラメータ例タイプ説明
code20000Integerエラーコード。エラーコードが 20000 の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data-ObjectAPI 呼び出しの結果。いくつかの API アクションでは data オブジェクトが返されない場合があります。アカウント情報のリストを返します。
data.account_idlbyx0bt7aStringアカウントの ID。
data.account_name-Stringアカウントの名前。
data.email-Stringアカウントのメールアドレス。
data.stateIN_USEStringアカウントの状態。有効な値:
  • IN_USE: アカウントは使用中です。
  • NO_ACCOUNT_NAME: アカウントは確認メールを通じてアクティベートされていません。
data.is_root_accounttrueBooleanアカウントがルートアカウントかどうか。
data.create_at-Timestampアカウントが作成された時のタイムスタンプ。
message-Stringエラーメッセージ。この要素は、返された code が 20000 でない場合にのみ返されます。
注意
リクエストが成功したか失敗したかを message の返り値に基づいて判断しないでください。