GetUserConfig を使用したユーザー情報のクエリ - Platform for AI (PAI)

GetUserConfig を呼び出して、ユーザー情報をクエリできます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paidsw:GetUserConfig

get

*All Resource

*

なし

リクエスト構文

GET /api/v2/userconfig HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	ユーザー構成。
AccountSufficient	boolean	アカウントに十分な残高があるかどうかを示します。	false
FreeTierSpecAvailable	boolean	フリーティアインスタンスが購入可能かどうかを示します。	true
FreeTier	object	フリーティアのプロパティ。
IsFreeTierUser	boolean	ユーザーがフリーティアを持っているかどうかを示します。	true
StartTime	string	フリーティアの開始時刻。	2020-11-08T15:00:00Z
EndTime	string	フリーティアの終了時刻。	2020-11-08T15:00:00Z
Status	string	フリーティアのステータス。値は `valid` または `invalid` です。	valid
InitBaseValue	number	フリーティアリソースの初期値。	5000
InitShowValue	string	フリーティアリソースの初期表示値。	5000
InitBaseUnit	string	フリーティアリソースの初期値の単位。	个
InitShowUnit	string	フリーティアリソースの初期値の表示単位。	个
PeriodBaseValue	number	フリーティアリソースの現在値。	3000
PeriodShowValue	string	フリーティアリソースの現在表示値。	3000
PeriodBaseUnit	string	フリーティアリソースの現在値の単位。	个
PeriodShowUnit	string	フリーティアリソースの現在値の表示単位。	个
EnableEciDisk	boolean	eciDisk が有効になっているかどうかを示します。	true
RequestId	string	リクエスト ID。	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	リクエストが成功したかどうかを示します。指定可能な値： true false	true
Message	string	返されたメッセージ。	"Access denied"
Code	string	状態コード。指定可能な値： InternalError: 内部エラーが発生しました。パラメーター検証エラー以外のエラーは、内部エラーとして分類されます。 ValidationError: パラメーター検証エラーが発生しました。	null
HttpStatusCode	integer	HTTP ステータスコード。指定可能な値： 400 404	null

例

成功レスポンス

JSONJSON

{
  "AccountSufficient": false,
  "FreeTierSpecAvailable": true,
  "FreeTier": {
    "IsFreeTierUser": true,
    "StartTime": "2020-11-08T15:00:00Z",
    "EndTime": "2020-11-08T15:00:00Z",
    "Status": "valid",
    "InitBaseValue": 5000,
    "InitShowValue": "5000",
    "InitBaseUnit": "个",
    "InitShowUnit": "个",
    "PeriodBaseValue": 3000,
    "PeriodShowValue": "3000",
    "PeriodBaseUnit": "个",
    "PeriodShowUnit": "个"
  },
  "EnableEciDisk": true,
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"Access denied\"",
  "Code": "null",
  "HttpStatusCode": 0
}

エラーコード

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

変更履歴

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