すべてのプロダクト
Search

このプロダクト

    Platform For AI:UpdateInstance

    ドキュメントセンター

    Platform For AI:UpdateInstance

    最終更新日:Jul 17, 2026

    DSW インスタンスの属性を更新します。

    今すぐお試しください

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

    update

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    PUT /api/v2/instances/{InstanceId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンスの ID。インスタンス ID を取得するには、 ListInstances を参照してください。

    dsw-730xxxxxxxxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    body

    object

    任意

    更新するインスタンスの属性。

    InstanceName

    string

    任意

    インスタンス名。フォーマット要件:

    • 英字、数字、アンダースコア (_) のみ使用できます。

    • 27 文字以内です。

    training_data
    EcsSpec

    string

    任意

    ECS インスタンスタイプ。ECS インスタンスタイプを取得するには、 ListEcsSpecs を参照してください。

    ecs.c6.large
    ImageId

    string

    任意

    イメージの ID。イメージ ID を取得するには、 ListImages を参照してください。

    image-05cefd0be2exxxx
    ImageUrl

    string

    任意

    イメージの URL。イメージ URL を取得するには、 ListImages を参照してください。

    registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
    UserVpc

    object

    任意

    ユーザー VPC の構成。

    VpcId

    string

    任意

    VPC ID。

    vpc-xxxxx
    VSwitchId

    string

    任意

    vSwitch の ID。

    vsw-xxxxx
    SecurityGroupId

    string

    任意

    セキュリティグループの ID。

    sg-xxxxxx
    ExtendedCIDRs

    array

    任意

    拡張 CIDR ブロック。

    • vSwitch ID が空の場合、このパラメーターは任意です。システムは VPC 配下のすべての CIDR ブロックを自動的に取得します。

    • vSwitch ID が指定されている場合、このパラメーターは必須です。VPC 配下のすべての CIDR ブロックを指定することを推奨します。

    ["192.168.0.1/24", "192.168.1.1/24"]

    string

    任意

    拡張 CIDR ブロック。

    "172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"
    DefaultRoute

    string

    任意

    デフォルトルート。有効な値:

    • eth0: デフォルトのネットワークインターフェースカード (NIC) を使用して、パブリックゲートウェイ経由で外部ネットワークにアクセスします。

    • eth1: ユーザーの Elastic NIC を使用して、非公開ゲートウェイ経由で外部ネットワークにアクセスします。

    eth0
    ForwardInfos

    array

    任意

    インスタンスのポート フォワーディング構成。

    ForwardInfo

    任意

    ForwardInfo。

    BandwidthLimit

    BandwidthLimit

    任意

    Accessibility

    string

    任意

    インスタンスの可視性。

    列挙値:

    • PUBLIC :

      ワークスペース内のすべてのユーザーに表示されます。

    • PRIVATE :

      ワークスペース内の所有者と管理者にのみ表示されます。

    PRIVATE
    Datasets

    array<object>

    任意

    データセットのリスト。

    object

    任意

    データセットオブジェクト。

    DatasetId

    string

    任意

    データセットの ID。データセットが読み取り専用の場合、MountAccess を使用して読み書き可能に変更することはできません。

    データセット ID を取得するには、 ListDatasets を参照してください。データセット ID を指定する場合、Uri は指定できません。

    d-vsqjvs****rp5l206u
    DatasetVersion

    string

    任意

    データセットのバージョン。DatasetId と同時に指定する必要があります。デフォルト値: v1。

    v1
    Uri

    string

    任意

    直接マウントするためのストレージサービスディレクトリの URI。このフィールドは DatasetId と相互排他です。

    ストレージタイプごとの URI フォーマット:

    • OSS: oss://bucket-name.oss-ap-southeast-1-internal.aliyuncs.com/data/path/

    • NAS: nas://29**d-b12****446.ap-southeast-1.nas.aliyuncs.com/data/path/

    • エクストリーム NAS: nas://29****123-y**r.ap-southeast-1.extreme.nas.aliyuncs.com/data/path/

    • CPFS: cpfs://cpfs-213****87.cn-wulanchabu/ptc-292*****cbb/exp-290********03e/data/path/

    • インテリジェントコンピューティング CPFS: bmcpfs://cpfs-290******foflh-vpc-x****8r.cn-wulanchabu.cpfs.aliyuncs.com/data/path/

    oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/
    MountPath

    string

    任意

    データセットのマウントパス。

    /mnt/data
    MountAccess

    string

    任意

    データセットマウント後の読み書き権限。データセットが読み取り専用の場合、読み書き可能に変更することはできません。

    列挙値:

    • RW :

      読み書き。

    • RO :

      読み取り専用。

    RW
    Options

    string

    任意

    カスタムデータセットのマウント属性。現在、OSS のみがサポートされています。OptionType と同時に指定することはできません。詳細については、DSW マウント構成 を参照してください。

    { "fs.oss.download.thread.concurrency": "10", "fs.oss.upload.thread.concurrency": "10", "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink" }
    OptionType deprecated

    string

    任意

    マウントタイプ。Options と同時に指定することはできません。このパラメーターは非推奨です。代わりに Options パラメーターを使用してください。

    ReadOnly
    Dynamic

    boolean

    任意

    動的マウントを有効にするかどうかを指定します。デフォルト値: false。

    • 現在、汎用コンピューティングリソースを持つインスタンスのみがサポートされています。

    • 現在、OSS データセットのみがサポートされています。マウントされたデータセットは読み取り専用モードになります。

    • 動的にマウントされるデータセットの MountPath は、動的マウントルートパス (デフォルト: /mnt/dynamic/) のサブディレクトリである必要があります (例: /mnt/dynamic/data1/)。

    • 動的にマウントされるデータセットは、非動的マウントデータセットの後に配置する必要があります。

    false
    RoleArn

    string

    任意

    DisassociateDatasets

    boolean

    任意

    関連付けられたデータセットを削除するかどうかを指定します。

    • true: 関連付けられたデータセットを削除します。

    • false: 関連付けられたデータセットを保持します。

    false
    DisassociateVpc

    boolean

    任意

    関連付けられたユーザー VPC を削除するかどうかを指定します。

    false
    DisassociateForwardInfos

    boolean

    任意

    関連付けられたポート フォワーディング情報を削除するかどうかを指定します。

    false
    RequestedResource

    object

    任意

    リソースの構成。

    {"CPU":"4","Memory":"8Gi","SharedMemory":"4Gi","GPU":"1","GPUType":"Tesla-V100-16G"}
    CPU

    string

    任意

    CPU のコア数。

    32
    Memory

    string

    任意

    メモリサイズ。単位: GB。

    32
    SharedMemory

    string

    任意

    共有メモリサイズ。単位: GB。

    32
    GPU

    string

    任意

    GPU の数。

    4
    GPUType

    string

    任意

    GPU のタイプ。

    v100
    WorkspaceSource

    string

    任意

    ワークスペースディレクトリのストレージを指定します。クラウドディスクまたは Datasets のデータセットを /mnt/workspace 作業ディレクトリにマウントできます。OSS データセットおよび動的マウントデータセットはサポートされていません。

    有効な値:

    • rootfsCloudDisk: クラウドディスクを作業ディレクトリにマウントします。

    • データセットマウントパス: Datasets 内のデータセットの MountPath (例: /mnt/data)。URI フォーマットのデータセットはこの方法でのみ指定できます。

    • データセット ID: d-vsqjvs****rp5l206u など。同じデータセットが複数のパスにマウントされている場合、最初のパスが選択されます。代わりにマウントパスを使用することを推奨します。

    このパラメーターが空の場合:

    • インスタンスがクラウドディスクを使用している場合、デフォルトでクラウドディスクが選択されます。

    • 利用可能なクラウドディスクがない場合、最初の NAS または CPFS データセットが作業ディレクトリとして選択されます。

    • クラウドディスクまたは NAS/CPFS の作業ディレクトリが利用できない場合、ホストマシンの領域が使用されます。

    /mnt/data
    UserId

    string

    任意

    インスタンスユーザーの ID。

    16122**********
    CloudDisks

    array<object>

    任意

    クラウドディスクのリスト。

    []

    object

    任意

    Capacity

    string

    任意

    リソースタイプがパブリックリソースに設定されている場合、またはリソースクォータがサブスクリプション汎用コンピューティングリソース (CPU コア数 ≥ 2 かつメモリ ≥ 4 GB、または GPU 構成あり) に設定されている場合:

    各インスタンスには、永続ストレージ用に無料の 100 GiB システムクラウドディスククォータが含まれます。インスタンスが 15 日以上停止されると、クラウドディスクの内容はクリアされます。クラウドディスクの拡張がサポートされています。具体的な拡張料金については、コンソールを参照してください。

    警告

    • 拡張後の縮小はサポートされていません。必要に応じてのみ拡張してください。

    • 拡張後、システムクラウドディスク全体 (無料分 + 有料分) は 15 日間の停止・リリース制限の対象外となりますが、課金は継続されます。

    • インスタンスが削除されると、システムクラウドディスクも同時にリリースされます。削除前に必要なデータをバックアップしてください。

    永久ストレージの場合は、データセットマウントを設定するか、ストレージパスマウントに OSS、NAS、または CPFS のパスを追加してください。

    100Gi
    SubType

    string

    任意

    クラウドディスクタイプ:

    • rootfs: システムクラウドディスクとしてマウントされます。システム環境がこのディスクに保存されます。

    rootfs
    Priority

    integer

    任意

    優先度。リソースがインスタンスに割り当てられる際、優先度の高いインスタンスから先に割り当てられます。有効な値: 1～9。

    • 1: 最低優先度。

    • 9: 最高優先度。

    1
    Driver

    string

    任意

    NVIDIA ドライバーの構成。

    535.54.03
    DisassociateDriver

    boolean

    任意

    NVIDIA ドライバー構成を削除するかどうかを指定します。

    false
    CredentialConfig CredentialConfig

    任意

    認証情報の構成。

    DisassociateCredential

    boolean

    任意

    認証情報注入情報を削除するかどうかを指定します。

    false
    Affinity

    object

    任意

    アフィニティ構成。

    CPU

    object

    任意

    CPU アフィニティ構成。サブスクリプション汎用コンピューティングインスタンスのみがサポートされています。

    Enable

    boolean

    任意

    CPU アフィニティを有効にするかどうかを指定します。

    • true: 有効にします。

    • false: 無効にします。

    true
    ImageAuth

    string

    任意

    ユーザーの非公開イメージの Base64 エンコードされた認証情報。パスワード部分はマスクされています。

    ****
    DynamicMount DynamicMount

    任意

    動的マウント構成。

    EnvironmentVariables

    object

    任意

    DSW インスタンスに注入される環境変数。

    警告 ここで渡される環境変数は、システムプリセットの環境変数をオーバーライドする可能性があります。

    { "ENABLE_TRAIN": "true", "ENABLE_DEBUG":"false", "INSTANCE_ENV":"prod" }
    DisassociateEnvironmentVariables

    boolean

    任意

    ユーザー指定の環境変数を削除するかどうかを指定します。

    false
    UserCommand

    object

    任意

    ユーザー定義の実行コマンド。

    OnStart

    object

    任意

    インスタンスの起動時に毎回実行されるカスタムコマンド。このコマンドは、インスタンス環境の初期化後、jupyter-lab や code-server などのサーバーが開始される前に実行されます。

    Content

    string

    任意

    カスタム起動コマンドの内容。

    apt update && echo initialized
    DisassociateUserCommand

    boolean

    任意

    ユーザー指定のカスタムコマンドを削除するかどうかを指定します。

    false
    OversoldType

    string

    任意

    アイドルリソースのタイプ。

    ForceQuotaOverSold: Use only idle resources AcceptQuotaOverSold: Accept idle resources ForbiddenQuotaOverSold: Use guaranteed resources
    DisassociateSpot

    boolean

    任意

    SpotSpec

    object

    任意

    SpotStrategy

    string

    任意

    SpotWithPriceLimit
    SpotPriceLimit

    string

    任意

    0.12
    SpotDuration

    string

    任意

    0
    SpotDiscountLimit

    string

    任意

    0.1
    DisassociateAssignNode

    boolean

    任意

    AssignNodeSpec

    object

    任意

    NodeNames

    string

    任意

    node-a
    AntiAffinityNodeNames

    string

    任意

    node-b
    StartInstance

    boolean

    任意

    DisassociateMigrationOptions

    boolean

    任意

    MigrationOptions

    object

    任意

    UserMetricsEndpoints

    array

    任意

    UserMetricsEndpoint

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    実行結果。

    RequestId

    string

    リクエストの ID。

    E7D55162-4489-1619-AAF5-3F97D5FCA948
    Success

    boolean

    成功フラグ。有効な値:

    • true

    • false

    true
    Message

    string

    返されるメッセージ。

    "XXX"
    Code

    string

    状態コード。有効な値:

    • InternalError: 内部エラーが発生しました。パラメーター検証エラー以外のすべてのエラーは内部エラーとして分類されます。

    • ValidationError: パラメーター検証エラーが発生しました。

    null
    HttpStatusCode

    integer

    HTTP 状態コード。有効な値:

    • 400

    • 404

    null
    InstanceId

    string

    インスタンスの ID。

    dsw-730xxxxxxxxxx

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "InstanceId": "dsw-730xxxxxxxxxx"
}

    エラーコード

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

    変更履歴

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