共通仕様

オーガニゼーションとユーザー

ABEJA Platform におけるリソース（チャンネルやデータソース）は、「オーガニゼーション (組織)」 という単位で管理されています。 リソースを使用するために認証/許可された単位を「ユーザー」という単位で管理されています。また、ユーザごとに実行できる操作の種類によって「ロール (役割)」 を割り当てが可能です。

オーガニゼーションおよび管理者ユーザーの情報は ABEJA より発行いたします。

ロールとユーザーの権限

ロールおよび、実行できる操作の種類については以下となります。 ユーザーは所属するオーガニゼーションにおいて、以下のいずれかのロールを割り当てられています。

ロール 説明
Admin (管理者) オーガニゼーションに属するすべてのリソースの閲覧および変更（新規作成 / 更新 / 削除）が可能です。
Developer (開発者) オーガニゼーションに属するリソースのうちモデルの開発に関わるリソースの閲覧および変更が可能です。
Regular (通常) オーガニゼーションに属するリソースの閲覧のみが可能です。

操作権限一覧

操作項目 Admin Developer Regular
ユーザー追加 / 削除 ◯ ✕ ✕
ユーザー権限変更 ◯ ✕ ✕
データレイク チャンネル追加 / アーカイブ ◯ ◯ ✕
データレイク ファイルアップロード ◯ ◯ ✕
データレイク ファイル削除 ◯ ◯ ✕
データセット 作成 / 削除 ◯ ◯ ✕
学習ジョブ ジョブ定義作成 / アーカイブ ◯ ◯ ✕
学習ジョブ バージョン作成 / アーカイブ ◯ ◯ ✕
学習ジョブ ジョブ作成 / アーカイブ ◯ ◯ ✕
Notebook 作成 / 変更 / 削除 ◯ ◯ ✕
モデル アップロード / ダウンロード / 削除 ◯ ◯ ✕
デプロイメント コードバージョン作成 / 削除 ◯ ◯ ✕
デプロイメント コードダウンロード ◯ ◯ ✕
HTTP Service 作成 / 削除 ◯ ◯ ✕
エンドポイント 作成 / 切替 / 削除 ◯ ◯ ✕
トリガー 作成 / 削除 ◯ ◯ ✕
カスタムイメージ リポジトリ作成 / 削除 ◯ ◯ ✕
利用量ページ 閲覧 ◯ ◯ ◯
アクセスキー 作成 / 削除 ◯ ◯ ✕

認証

API を利用するための以下の認証情報は、ABEJA Platform管理画面右上の 「ユーザ名」 より確認いただけます。

  • オーガニゼーションの ORGANIZATION_ID
  • 管理者ロールをもつユーザーの USER_ID
  • 管理者ロールをもつユーザーの PERSONAL_ACCESS_TOKEN

認証は Basic 認証で行います。ユーザー名とパスワードには以下のものを指定してください。

  • ユーザー名 user-{USER_ID}
  • パスワード {PERSONAL_ACCESS_TOKEN}
$ curl --user user-9876543210321:b9555a16ad6513d91af399807c0c22bff3484c64 ...

リクエスト・ヘッダー

API のリクエスト・ボディに JSON を指定するときは必ず、Content-Type リクエスト・ヘッダーに application/json を指定してください。

$ curl -H "Content-Type: application/json" ...

ユーザーの指定可能な環境変数

ジョブ定義バージョン/学習ジョブ/コードバージョン/HTTP サービス/トリガー/ Run 作成時には、実行時の環境変数を指定することが可能です。

いわゆる環境変数のため、キーは英数字とアンダースコアで構成され、先頭文字に数字は使用できません。 また、以下のキーはシステムで予約されており、ユーザーは指定できません。

  • ABEJA_ で始まる名前
  • CONTEXT
  • DATADOG_ENV
  • DATADOG_SERVICE_NAME
  • DATADOG_TRACE_AGENT_HOSTNAME
  • DATASETS
  • DISPLAY
  • HANDLER
  • INPUT
  • LD_LIBRARY_PATH
  • OUTPUT
  • PLATFORM_AUTH_TOKEN
  • PYTHONUNBUFFERED
  • SERVICE_TYPE
  • STOP_AFTER
  • TENSORBOARD_ID
  • TRAINING_CLUSTER_NAMESPACE
  • TRAINING_JOB_DATASET_IDS
  • TRAINING_JOB_DATASETS
  • TRAINING_JOB_IDS
  • TRAINING_JOB_DEFINITION_NAME
  • TRAINING_JOB_DEFINITION_VERSION
  • TRAINING_JOB_ID
  • TRAINING_NOTEBOOK_ID

Updated on 07 Jul 2017