DSW カスタムコマンドの GetUserCommand API リファレンス - Platform for AI - Alibaba Cloud - Platform For AI

今すぐお試しください

この 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:GetUserCommand

get

*All Resource

*

なし

リクエスト構文

GET /api/v2/usercommands/{UserCommandId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
UserCommandId	string	任意	ユーザー定義コマンドの ID。この ID は、GetInstance などの API オペレーションを呼び出すことで取得できます。	1900

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	Data Science Workshop (DSW) インスタンスの ID。このパラメーターを指定して、インスタンスにアタッチされているユーザーコマンドを検索します。このパラメーターは UserCommandId 設定を上書きします。	dsw-dlsd0fskn193213xxx
Token	string	任意	ユーザーコマンドにアクセスするために使用されるトークン。このトークンは GetToken API オペレーションによって発行されます。	eyJhbGci......

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ
UserCommandId	string	ユーザー定義コマンドの ID。	1900
OnStart	object	カスタム起動コマンド。このコマンドは、インスタンスが起動するたびに実行されます。
Content	string	カスタム起動コマンドのコンテンツ。	apt update
Message	string	結果の説明。	null
Code	string	状態コード。有効な値は次のとおりです。 null：リクエストは成功しました。 ValidationError：パラメーターが無効です。 InternalError：内部エラーが発生しました。	ValidationError
RequestId	string	リクエスト ID。	BEBDF2EE-642E-5992-8907-D2011A7ACEFE
Success	boolean	リクエストが成功したかどうかを示します。有効な値は次のとおりです。 true false	true
accessDeniedDetail	object	アクセス拒否に関する詳細。このパラメーターは、ユーザーに必要な RAM 権限がないためにアクセスが拒否された場合に返されます。	"AccessDeniedDetail": { "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "AQIBIAAAA....bwhg==", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "ram:GetUserCommand" }

例

成功レスポンス

JSONJSON

{
  "UserCommandId": "1900",
  "OnStart": {
    "Content": "apt update"
  },
  "Message": "null",
  "Code": "ValidationError",
  "RequestId": "BEBDF2EE-642E-5992-8907-D2011A7ACEFE",
  "Success": true,
  "accessDeniedDetail": {
    "test": "test",
    "test2": 1
  }
}

エラーコード

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

変更履歴

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