指定された個人用開発環境インスタンスの構成を更新します。
操作説明
指定された個人用開発環境 (ServerIDE) インスタンスの構成を更新します。CU、イメージ、インスタンス名、VPC、データセット、および認証情報の設定を変更できます。CU およびイメージのパラメーターが指定されていない場合、既存のインスタンス構成が保持されます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
個人用開発環境インスタンスの ID。ListServerIdeInstances を呼び出して ID を取得できます。 |
699573 |
| ProjectId |
integer |
任意 |
DataWorks ワークスペースの ID。 |
10000 |
| Cu |
integer |
任意 |
インスタンスで使用される CU 数。 |
10 |
| ImageId |
string |
任意 |
イメージの ID。ListServerIdeImages を呼び出して ID を取得できます。 |
System_serveride_notebook_20240822 |
| ImageUrl |
string |
任意 |
イメージの URL。DataWorks 公式以外のイメージを使用する場合、このパラメーターは必須です。 |
registry.cn-hangzhou.aliyuncs.com/example/serveride:latest |
| InstanceName |
string |
任意 |
個人用開発環境インスタンスの名前。 |
notebook_dev |
| UserVpc |
object |
任意 |
インスタンスで使用される VPC 構成。 |
|
| SecurityGroupId |
string |
任意 |
セキュリティグループの ID。 |
sg-bp1**** |
| VSwitchId |
string |
任意 |
vSwitch の ID。 |
vsw-bp1**** |
| VpcId |
string |
任意 |
VPC の ID。 |
vpc-bp1**** |
| ForwardInfos |
array<object> |
任意 |
ポート フォワーディング構成のリスト。 |
|
|
object |
任意 |
ポート フォワーディング構成。 |
||
| AccessType |
array |
任意 |
アクセスタイプのリスト。 |
|
|
string |
任意 |
アクセスタイプ。有効な値:
|
intranet |
|
| ContainerName |
string |
任意 |
対象コンテナの名前。 |
dsw-notebook |
| Enable |
boolean |
任意 |
ポート フォワーディング構成を有効にするかどうかを指定します。 |
true |
| ForwardPort |
string |
任意 |
インスタンスコンテナ内の対象ポート。 |
22 |
| Name |
string |
任意 |
ポート フォワーディング構成の名前。 |
ssh |
| NatGatewayId |
string |
任意 |
NAT Gateway の ID。 |
ngw-bp1**** |
| SSHPublicKey |
string |
任意 |
SSH アクセスに使用される公開鍵。 |
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ**** |
| EipAllocationId |
string |
任意 |
パブリック EIP のインスタンス ID。 |
eip-bp1**** |
| ExternalPort |
string |
任意 |
マッピングされたパブリックポート。 |
1024 |
| Datasets |
array<object> |
任意 |
インスタンスにマウントされるデータセットのリスト。 |
|
|
object |
任意 |
データセットのマウント構成。 |
||
| Identifier |
string |
任意 |
データセットの識別子。 |
d-vsqjvs****rp5l206u |
| Version |
integer |
任意 |
データセットのバージョン番号。 |
1 |
| MountPath |
string |
任意 |
インスタンス内のデータセットのマウントパス。 |
/mnt/data |
| ReadOnly |
boolean |
任意 |
データセットを読み取り専用モードでマウントするかどうかを指定します。 |
|
| ExtOptions |
string |
任意 |
データセットのカスタムマウントプロパティ。内容はマウントオプションとして渡されます。 |
{"fs.oss.download.thread.concurrency":"10"} |
| Uri |
string |
任意 |
直接マウント用のストレージサービスディレクトリ URI。 |
oss://example-bucket/data/ |
| CredentialConfig |
object |
任意 |
インスタンスの認証情報注入構成。この特徴を有効にすると、デフォルトの RAM ロールチェーンを使用するか、カスタム RAM ロールを指定できます。 |
|
| Enable |
boolean |
任意 |
認証情報注入を有効にするかどうかを指定します。 |
|
| AliyunEnvRoleKey |
string |
任意 |
環境変数のロールキー。 |
0 |
| Configs |
array<object> |
任意 |
認証情報構成のリスト。 |
|
|
array<object> |
任意 |
認証情報構成。 |
||
| Key |
string |
任意 |
認証情報構成の識別子キー。 |
0 |
| Type |
string |
任意 |
認証情報構成のタイプ。有効な値:
|
RoleChain |
| Roles |
array<object> |
任意 |
認証情報構成内のロールのリスト。 |
|
|
array<object> |
任意 |
ロールの引き受け構成。 |
||
| AssumeRoleFor |
string |
任意 |
ロールを引き受けるプリンシパルの Alibaba Cloud アカウント ID。 |
123456789012**** |
| Policy |
string |
任意 |
ロールの権限をさらに制限するために使用されるポリシー。 |
{} |
| RoleArn |
string |
任意 |
RAM ロールの Amazon リソースネーム (ARN)。 |
acs:ram::123456789012****:role/DataWorksRole |
| RoleType |
string |
任意 |
ロールの引き受けタイプ。有効な値:
|
service |
| UserInfo |
object |
任意 |
委任されたユーザーの情報。 |
|
| Id |
string |
任意 |
委任されたユーザーのアカウント ID。 |
20933221576142**** |
| Type |
string |
任意 |
ユーザータイプ。有効な値:
|
sub |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| RequestId |
string |
リクエストの ID。 |
E7D55162-4489-1619-AAF5-3F97D5FCA948 |
| InstanceId |
string |
個人用開発環境インスタンスの ID。 |
699573 |
例
成功レスポンス
JSONJSON
{
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
"InstanceId": "699573"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。