Referensi API Throughput Reservation - Alibaba Cloud Model Studio

Autentikasi dan Persiapan Panggilan

Gunakan API Key Bailian dari wilayah pemanggilan, dan sampaikan dalam header permintaan Authorization: Bearer <api-key>. API Key terikat pada wilayah dan tidak dapat digunakan lintas wilayah. Ketika isi permintaan berupa JSON, sampaikan Content-Type: application/json。 Format domain khusus workspace adalah https://{workspaceId}.{region}.maas.aliyuncs.com, gunakan Endpoint dari workspace dan wilayah target. Untuk menentukan sub-ruang bisnis, sertakan dalam header permintaan X-DashScope-WorkSpace: <workspace-id>。 Domain API DashScope adalah https://dashscope-intl.aliyuncs.com. Wilayah Virginia menggunakan https://{workspaceId}.us-east-1.maas.aliyuncs.com。 Hasil operasi kapasitas asinkron diperoleh melalui Kueri Operasi Kapasitas . Untuk entri konsol, lihat Reservasi Throughput, untuk konsep deployment, lihat Deployment, untuk API deployment umum, lihat Menggunakan API untuk Melakukan Deployment Model。

Konvensi Umum

Jalur dasar antarmuka adalah /api/v1/deployments, mewarisi domain DashScope OpenAPI dan metode autentikasi dari wilayah pemanggilan. Isi permintaan menggunakan Content-Type: application/json. Gunakan akun, model, dan deployment dari wilayah target.

deployed_model：pengidentifikasi panggilan dari Reservasi Throughput (ModelCode); dalam respons instans/operasi model_service_id merepresentasikan objek yang sama.
instance_id：ID Instans Kapasitas. Gunakan nilai pengembalian antarmuka, jangan menyimpulkan Metode Penagihan berdasarkan format string.
operation_id：ID Operasi, gunakan nilai string yang dikembalikan oleh antarmuka.
ID contoh, nama model, dan nilai kapasitas di bawah ini adalah contoh placeholder. Model nyata, nilai minimum, ukuran langkah, batas atas, dan durasi pembelian bergantung pada model dan batas pembelian di wilayah target.
Contoh JSON menghilangkan beberapa bidang respons opsional; status tahap dalam contoh bukanlah pengembalian tetap untuk setiap permintaan.

Respons berhasil dibungkus secara seragam sebagai:

{
  "request_id": "example-request",
  "output": {}
}

Contoh kesalahan permintaan:

{
  "request_id": "example-request",
  "code": "CAPACITY_INSTANCE_REQUIRED",
  "message": "需要指定容量实例"
}

Keberhasilan permintaan HTTP tidak sama dengan keberhasilan operasi kapasitas. Bahkan jika antarmuka tulis instans mengembalikan HTTP 200, output.operation_status mungkin juga berupa FAILED。必须检查操作状态和错误字段，确认成功后再使用更新的容量。

Buat Throughput Tereservasi

POST /api/v1/deployments Buat Reserved Throughput dan beli instance kapasitas pertama, mengembalikan ModelCode yang digunakan untuk memanggil model. Untuk menambahkan kapasitas ke Reserved Throughput yang ada, silakan panggil Instance Kapasitas Pembelian Tumpuk。

Bidang	Tipe	Wajib	Deskripsi
`model_name`	String	Ya	Nama Model Dasar
`plan`	String	Ya	`ptu`
`service_tier`	String	Tidak	Tingkat Performa: `ptu_fast` adalah kecepatan tinggi (default), `ptu_default` adalah kecepatan standar
`charge_type`	String	Ya	`pre_paid`(Berlangganan) / `post_paid`(Bayar sesuai pemakaian)
`name`	String	Tidak	Nama tampilan; dibuat secara otomatis jika tidak ditentukan.
`suffix`	String	Tidak	Sufiks ModelCode; dibuat secara otomatis jika tidak diteruskan.
`ptu_capacity`	Object	Ya	Konfigurasi Kapasitas, lihat Parameter Kapasitas
`pre_paid_info`	Object	Wajib Bersyarat	Wajib untuk Berlangganan, lihat Parameter Berlangganan; tidak dikirimkan untuk Bayar sesuai pemakaian

ptu_default mendukung Berlangganan;ptu_fast Mendukung Berlangganan dan Bayar sesuai pemakaian. Instans kapasitas baru mewarisi Tingkat Performa ModelCode. ptu_default Standar mendukung Per Hari dan slot waktu 8 jam dua Siklus Penagihan: Per Hari sesuai dengan pricing_cycle=Day, slot waktu 8 jam sesuai dengan pricing_cycle=Hour Dan duration=8. Slot waktu 8 jam hanya didukung oleh ptu_default Standar,ptu_fast Kecepatan Tinggi tidak mendukung. Contoh Berlangganan Harian:

{
  "model_name": "<base_model>",
  "plan": "ptu",
  "service_tier": "ptu_fast",
  "charge_type": "pre_paid",
  "name": "吞吐预留示例",
  "ptu_capacity": {
    "input_tpm": 10000,
    "output_tpm": 1000
  },
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  }
}

Contoh Berlangganan slot waktu 8 jam (hanya ptu_default Standar):

{
  "model_name": "<base_model>",
  "plan": "ptu",
  "service_tier": "ptu_default",
  "charge_type": "pre_paid",
  "ptu_capacity": {
    "input_tpm": 10000,
    "output_tpm": 1000
  },
  "pre_paid_info": {
    "pricing_cycle": "Hour",
    "duration": 8,
    "auto_renewal": false
  }
}

ptu_capacity

Satuan kapasitas adalah kTPM (1 kTPM = 1000 Token/ Menit). Model yang didukung saat ini tidak mendukung konfigurasi terpisah untuk kuota output pemikiran.

Bidang	Tipe	Deskripsi
`input_tpm`	Long	Kapasitas input, satuan kTPM, disediakan sesuai persyaratan model dan memenuhi langkah serta Rentang
`output_tpm`	Long	Kapasitas output, satuan kTPM, disediakan sesuai persyaratan model dan memenuhi langkah serta Rentang

Saat Penskalaan, ini menunjukkan kapasitas absolut setelah Instans yang dipilih berubah, bukan kenaikannya, dan bukan kapasitas total target ModelCode.

pre_paid_info

Bidang	Tipe	Deskripsi
`pricing_cycle`	String	Siklus Penagihan:`Day` adalah Per Hari (default),`Hour` adalah slot 8 Jam;`Hour` hanya `ptu_default` kecepatan Standar yang didukung, peka huruf besar/kecil
`duration`	Integer	Durasi Pembelian / Perpanjangan, satuan mengikuti `pricing_cycle`：`Day` sebagai hari,`Hour` sebagai jam dan ditetapkan pada 8, harus lebih besar dari 0
`auto_renewal`	Boolean	secara eksplisit tentukan apakah akan memperpanjang otomatis; skenario `Hour` harus berupa `false`
`auto_renewal_duration`	Integer	Wajib dan lebih besar dari 0 saat perpanjangan otomatis diaktifkan, satuan: hari;`Hour` tidak dikirimkan dalam skenario ini
`auto_renewal_cycle`	String	Opsional. Satuan siklus perpanjangan, kirimkan nilai yang didukung oleh produk, misalnya `Day` menunjukkan hari;`Hour` tidak dikirimkan dalam skenario ini

Respons Pembuatan

output adalah objek deployment (Kueri Reservasi Throughput). Saat membuat instance kapasitas, mungkin mengembalikan operation_id、instance_id; ketika pesanan pembelian instance Berlangganan belum diproses, instance_id mungkin sementara tidak tersedia; dapatkan nanti melalui kueri.

{
  "request_id": "example-request",
  "output": {
    "deployed_model": "example-model-code",
    "model_name": "<base_model>",
    "plan": "ptu",
    "status": "WAIT_PRE_PAID_BILLING_TO_DEPLOYING",
    "operation_id": "100001"
  }
}

Terdapat operation_id saat, dengan Kueri Operasi Kapasitas kueri; untuk permintaan pembuatan yang habis waktu, pertama-tama konfirmasi apakah sudah dibuat untuk menghindari pembuatan ModelCode yang duplikat.

Penskalaan

PUT /api/v1/deployments/{deployed_model}/scale Sesuaikan kapasitas input dan output dari sebuah instance kapasitas di bawah reservasi throughput yang ditentukan. Jika terdapat beberapa instance yang belum dihapus, Anda harus menggunakan instance_id untuk menentukan instance target.

Bidang	Wajib	Deskripsi
`instance_id`	Wajib Bersyarat	Wajib ketika terdapat beberapa Instans yang belum dihapus; dapat dihilangkan ketika hanya ada satu Instans yang belum dihapus
`ptu_capacity`	Ya	Kapasitas absolut setelah perubahan Instans ini
`pre_paid_info`	Tidak	Saat Berlangganan tidak dikirimkan, gunakan kembali informasi yang tersimpan; Bayar sesuai pemakaian tidak mengirimkannya
`order_type`	Tidak	`UPGRADE` untuk peningkatan, `DOWNGRADE` untuk penurunan; jika dihilangkan, server yang menentukannya, dan nilai yang dikirimkan harus konsisten dengan arah perubahan kapasitas

{
  "instance_id": "example-capacity-instance",
  "ptu_capacity": {
    "input_tpm": 20000,
    "output_tpm": 2000
  },
  "order_type": "UPGRADE"
}

output Mengembalikan informasi Reservasi Throughput; ID operasi kapasitas yang sesuai melalui operation_id dikembalikan. Untuk beberapa instance tanpa ID yang ditentukan, mengembalikan CAPACITY_INSTANCE_REQUIRED. Untuk integrasi baru, disarankan Penskalaan Instance Kapasitas Tertentu。 Perubahan Berlangganan melibatkan pesanan; Bayar Sesuai Pemakaian tidak melalui pesanan perubahan Berlangganan. Sebelum perubahan dikonfirmasi, kapasitas efektif asli tetap dipertahankan; jika gagal, kapasitas target tidak dapat ditampilkan sebagai efektif. Penskalaan Semua-Nol tidak setara dengan menghapus Instance.

Kueri Reservasi Throughput

GET /api/v1/deployments/{deployed_model} Kueri konfigurasi dan Status Reservasi Throughput yang ditentukan, serta kapasitas efektif agregat dari semua Instans Kapasitas.

{
  "request_id": "example-request",
  "output": {
    "deployed_model": "example-model-code",
    "model_name": "<base_model>",
    "plan": "ptu",
    "ptu_service_tier": "ptu_fast",
    "status": "RUNNING",
    "charge_type": "pre_paid",
    "ptu_capacity": {
      "input_tpm": 10000,
      "output_tpm": 1000
    },
    "overflow_strategy": "disable"
  }
}

Bidang	Deskripsi
`deployed_model`	Pengidentifikasi panggilan dari Reservasi Throughput (ModelCode).
`model_name`	Nama model dasar.
`plan`	Pengidentifikasi tipe, Throughput Reserved adalah `ptu`。
`status`	Status ModelCode, tidak merepresentasikan Status masing-masing CapacityInstance
`ptu_service_tier`	Tingkat Performa:`ptu_fast` adalah kecepatan tinggi,`ptu_default` adalah kecepatan standar
`ptu_capacity`	Kapasitas input dan output agregat dari semua CapacityInstance efektif di bawah ModelCode ini
`charge_type`	Nilai:`pre_paid`(Berlangganan)/ `post_paid`(Bayar sesuai pemakaian)
`pre_paid_info`	Konfigurasi Pembelian dan Perpanjangan Berlangganan, termasuk `pricing_cycle`（`Day` Per Hari / `Hour` untuk periode 8 Jam），`duration` dll. Jika terdapat beberapa Instance kapasitas, silakan kueri Instance target melalui detail Instance `pre_paid_info`。
`pre_paid_instance_id`	Pengidentifikasi Instance Berlangganan. Jika terdapat beberapa Instance kapasitas, silakan Dapatkan setiap Instance melalui daftar instance kapasitas `instance_id`, dan tentukan Instance yang akan dioperasikan.
`pre_paid_gmt_expired`	Waktu kedaluwarsa Berlangganan. Jika terdapat beberapa Instance kapasitas, silakan dapatkan waktu kedaluwarsanya melalui detail Instance target `gmt_expired`. Aturan perhitungan waktu kedaluwarsa ada diPenagihan Reservasi Throughput。
`overflow_strategy`	Strategi overflow,`enable` menunjukkan bahwa penagihan bayar sesuai pemakaian overflow diizinkan,`disable` menunjukkan bahwa pembatasan diterapkan ketika kapasitas terlampaui. Untuk aturan penagihan overflow, lihat Penagihan Reservasi Throughput。
`fail_reason`	Alasan kegagalan.
`gmt_create`	Dibuat Pada.
`gmt_modified`	Waktu modifikasi terakhir.
`operation_id`	ID CapacityOperation, digunakan untuk mengkueri hasil operasi; mungkin dikembalikan dalam respons operasi tulis yang sesuai.
`instance_id`	ID CapacityInstance. Mungkin tidak dikembalikan ketika pesanan pembelian belum diproses sepenuhnya; peroleh melalui kueri selanjutnya.

Penagihan campuran harus ditentukan oleh charge_type masing-masing instans dalam daftar CapacityInstance. Status deployment dan jenis penagihan tidak dapat menggantikan status dan jenis penagihan masing-masing instans.

Kueri Daftar Reservasi Throughput

GET /api/v1/deployments?page_no=1&page_size=10&plan=ptu Melakukan kueri daftar cadangan throughput dengan paginasi.

Parameter Kueri	Deskripsi
`page_no`	Nomor Halaman, default 1
`page_size`	Jumlah item per halaman, default 10, Rentang [1,100]
`plan`	Filter tipe opsional. Kirimkan `ptu`; Tingkat Performa ditunjukkan oleh `service_tier` dan bukan merupakan nilai dari `plan`

{
  "request_id": "example-request",
  "output": {
    "deployments": [
      {
        "deployed_model": "example-model-code",
        "plan": "ptu",
        "status": "RUNNING",
        "ptu_capacity": {
          "input_tpm": 10000,
          "output_tpm": 1000
        }
      }
    ],
    "total": 1,
    "page_no": 1,
    "page_size": 10
  }
}

Daftar Deployment tidak mendukung pemfilteran status melalui parameter status. Untuk pemfilteran instance kapasitas, gunakan Daftar Kueri Instance Kapasitas (Termasuk Instance yang Dihapus) milik statuses。

Perpanjang

PUT /api/v1/deployments/{deployed_model}/renew Perpanjang instans kapasitas Berlangganan yang ditentukan; kapasitas dapat disesuaikan secara bersamaan. Ketika terdapat beberapa instans yang belum dihapus, Anda harus menentukan instans target melalui instance_id.

Bidang	Wajib	Deskripsi
`instance_id`	Wajib Bersyarat	Harus ditentukan ketika terdapat beberapa instans yang belum dihapus; dapat dihilangkan untuk instans tunggal
`pre_paid_info`	Ya	Info perpanjangan, lihat Parameter Berlangganan
`is_change`	Tidak	Default `false`; apakah akan menyesuaikan kapasitas secara bersamaan
`ptu_capacity`	Tidak	Hilangkan untuk mempertahankan kapasitas yang dikonfigurasi; saat mengirimkan kapasitas yang berbeda, harus `is_change=true`

Perpanjang dan aktifkan perpanjangan otomatis:

{
  "instance_id": "example-capacity-instance",
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": true,
    "auto_renewal_duration": 30
  }
}

Perpanjang tetapi jangan aktifkan perpanjangan otomatis:

{
  "instance_id": "example-capacity-instance",
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  }
}

Hanya Berlangganan yang didukung; permintaan perpanjangan tidak dapat melewati order_type。output Mengembalikan informasi Reservasi Throughput, dan mungkin menyertakan ID Operasi Kapasitas; disarankan untuk menggunakan antarmuka tingkat instance Perpanjang Instance Kapasitas Tertentu dan melakukan polling terhadap hasilnya.

Ubah Strategi Overflow

PUT /api/v1/deployments/{deployed_model}/update-overflowstrategy

{
  "overflow_strategy": "disable"
}

overflow_strategy Wajib diisi, hanya mendukung huruf kecil enable / disable。enable menunjukkan bahwa lalu lintas yang melebihi kapasitas PTU diizinkan untuk overflow ke pool publik guna penagihan Pay-as-you-go;disable menunjukkan pembatasan (throttling) setelah batas terlampaui. Konfigurasi ini berlaku untuk seluruh ModelCode; paket kapasitas tidak memiliki strategi overflow individual. Untuk rincian penagihan overflow, lihatPenagihan Throughput Reservation。 Respons berisi request_id dan output. Setelah modifikasi, Anda dapat Melewati Reservasi Throughput Mendapatkan overflow_strategy, konfirmasi bahwa konfigurasi telah diperbarui.

{
  "request_id": "example-request",
  "output": {
    "deployed_model": "example-model-code",
    "model_name": "<base_model>",
    "plan": "ptu_v2",
    "ptu_service_tier": "ptu_fast",
    "status": "RUNNING",
    "charge_type": "post_paid",
    "overflow_strategy": "disable",
    "ptu_capacity": {
      "input_tpm_quota": 10000,
      "output_tpm_quota": 10000
    }
  }
}

Setelah mengaktifkan strategi overflow, lalu lintas yang melebihi kapasitas akan ditagih berdasarkan pay-as-you-go, sehingga menimbulkan biaya tambahan. Setelah menonaktifkannya, permintaan yang melebihi kapasitas akan dibatasi (throttled). Untuk rincian penagihan overflow, lihatPenagihan Throughput Reservation; untuk informasi selengkapnya, lihatInput Panjang dan Cache Provisioned Throughput。

Antarmuka Instans Kapasitas

Antarmuka berikut semuanya menggunakan /api/v1/deployments/{deployed_model} sebagai awalan. Operasi tulis Instance mengembalikan objek operasi Operasi Kapasitas, berbeda dari objek Deployments /scale、/renew yang lama.

Instans Kapasitas Pembelian Bertumpuk

POST /api/v1/deployments/{deployed_model}/capacity-instances

Bidang	Wajib	Deskripsi
`billing_method`	Ya	Metode Penagihan:`PRE_PAY` adalah Berlangganan,`POST_PAY` adalah Bayar sesuai pemakaian. Nilai peka huruf besar/kecil
`ptu_capacity`	Ya	Kapasitas Instans Baru
`pre_paid_info`	Wajib Bersyarat	Wajib untuk Berlangganan, tidak dikirimkan untuk Bayar sesuai pemakaian

Contoh Berlangganan:

{
  "billing_method": "PRE_PAY",
  "ptu_capacity": {
    "input_tpm": 10000,
    "output_tpm": 1000
  },
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  }
}

Contoh pembelian tambahan periode waktu 8 Jam (hanya kecepatan standar ptu_default, billing_method ditetapkan PRE_PAY，pre_paid_info kirimkan pricing_cycle=Hour / duration=8 / auto_renewal=false）：

{
  "billing_method": "PRE_PAY",
  "ptu_capacity": {
    "input_tpm": 10000,
    "output_tpm": 1000
  },
  "pre_paid_info": {
    "pricing_cycle": "Hour",
    "duration": 8,
    "auto_renewal": false
  }
}

Instance periode waktu 8 Jam berhasil dibuat, Lewati Detail Kueri Instance Kapasitas dapat Memperoleh Bidang berikut: pricing_cycle adalah Hour；gmt_effective adalah Waktu efektif tepat jam waktu Beijing; gmt_expired dan gmt_effectiveselisih 8 Jam;can_scale、can_renew、can_enable_auto_renew、can_disable_auto_renew、can_deletesemuanya adalah false。 Contoh Bayar sesuai pemakaian:

{
  "billing_method": "POST_PAY",
  "ptu_capacity": {
    "input_tpm": 10000,
    "output_tpm": 1000
  }
}

Mengembalikan objek operasi; respons awal mungkin menunjukkan keberhasilan, kegagalan, atau masih dalam proses. Gunakan kembali ModelCode, model, dan Tingkat Performa yang ada; hanya satu Instance Bayar Sesuai Pemakaian yang belum dihapus yang diizinkan per ModelCode. Ketika kondisi pembelian atau jumlah Instance tidak memenuhi persyaratan, tangani sesuai dengan kesalahan yang dikembalikan oleh antarmuka.

Kueri Daftar Instans Kapasitas (termasuk instans yang dihapus)

GET /api/v1/deployments/{deployed_model}/capacity-instances?page_no=1&page_size=20&include_deleted=true

Parameter Kueri	Tipe	Deskripsi
`page_no`	Integer	Default 1
`page_size`	Integer	Default 20, Rentang [1,100]
`include_deleted`	Boolean	Default true; secara eksplisit kirimkan false saat hanya menampilkan instans yang belum dihapus
`statuses`	Daftar String	Opsional, beberapa nilai dipisahkan koma, misalnya `RUNNING,STOPPED`
`charge_types`	Daftar String	Opsional,`pre_paid,post_paid`

{
  "request_id": "example-request",
  "output": {
    "records": [
      {
        "model_service_id": "example-model-code",
        "instance_id": "example-capacity-instance",
        "charge_type": "post_paid",
        "status": "STOPPED",
        "deleted": true,
        "effective_capacity": {
          "input_tpm": 0,
          "output_tpm": 0
        },
        "configured_capacity": {
          "input_tpm": 0,
          "output_tpm": 0
        },
        "can_scale": false,
        "can_renew": false,
        "can_delete": false
      }
    ],
    "items": 1,
    "page": 1,
    "itemsPerPage": 20,
    "pageCount": 1
  }
}

Struktur halaman berbeda dari daftar Deployment:records adalah halaman saat ini,items adalah jumlah total,page adalah Nomor Halaman,itemsPerPage / pageCount mempertahankan ejaan camelCase dari Pengembalian saat ini. Instance dengan kapasitas aktif diprioritaskan terlebih dahulu, kemudian diurutkan berdasarkan Waktu Dibuat secara menurun. Daftar ini hanya mendukung Parameter kueri yang tercantum di bagian ini.

Kueri Detail Instans Kapasitas

GET /api/v1/deployments/{deployed_model}/capacity-instances/{instance_id} Mengembalikan objek instans CapacityInstance; instans yang dihapus juga dapat dikueri. ModelCode dan instans harus cocok; instans tidak dapat dioperasikan lintas ModelCode.

Setelah Instance Bayar Sesuai Pemakaian dirilis, pembelian ulang kapasitas Bayar Sesuai Pemakaian di bawah ModelCode yang sama akan menggunakan kembali ID instance asli. Daftar dan detail diperbarui ke info instance setelah pembelian ulang, dan tidak lagi menyimpan catatan Hapus asli secara terpisah. Setelah rilis configured_capacity mungkin nol; mempertahankan kapasitas yang dikonfigurasi sebelum rilis tidak dijamin.

Penskalaan CapacityInstance Tertentu

PUT /api/v1/deployments/{deployed_model}/capacity-instances/{instance_id}/scale

{
  "ptu_capacity": {
    "input_tpm": 20000,
    "output_tpm": 2000
  },
  "order_type": "UPGRADE"
}

Semantik parameter sama dengan Penskalaan, ID instance ditentukan oleh jalur; isi permintaan tidak perlu diulang. Mengembalikan objek operasi. Baca sebelum memanggil can_scale；Instance dengan kedaluwarsa Berlangganan yang tertunda tidak dapat langsung dilakukan Penskalaan, Perpanjang terlebih dahulu. Instance slot waktu 8 jam tidak mendukung Penskalaan, panggilan mengembalikan CAPACITY_INSTANCE_OPERATION_UNSUPPORTED。

Perpanjang Instans Kapasitas Tertentu

PUT /api/v1/deployments/{deployed_model}/capacity-instances/{instance_id}/renew Perpanjangan Reguler:

{
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  }
}

Perpanjang dan Sesuaikan Kapasitas:

{
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  },
  "is_change": true,
  "ptu_capacity": {
    "input_tpm": 20000,
    "output_tpm": 2000
  }
}

Batasan parameter sama dengan Perpanjangan, jangan sampaikan order_type。Hanya Berlangganan yang dapat Diperpanjang, periksa terlebih dahulu can_renew；Mengembalikan objek operasi. Instance slot waktu 8 jam tidak mendukung Perpanjangan dan perpanjangan otomatis, panggilan mengembalikan CAPACITY_INSTANCE_OPERATION_UNSUPPORTED。

Hapus / Lepaskan Instans Kapasitas

DELETE /api/v1/deployments/{deployed_model}/capacity-instances/{instance_id} Parameter Kueri opsional reason adalah alasan penghapusan, dikodekan URL; tidak diperlukan isi permintaan JSON. Mengembalikan objek operasi.

Bayar sesuai pemakaian: Dilepaskan melalui proses penghapusan, dan setelah selesai, deleted=true、status=STOPPED, dengan kapasitas efektif nol.
Berlangganan Efektif: Antarmuka ini tidak dapat digunakan sebagai pengganti penghentian langganan; memanggilnya secara langsung mengembalikan PREPAID_UNSUBSCRIBE_REQUIRED. Setelah menyelesaikan penghentian langganan dan melepaskan kapasitas, pada akhirnya juga mengembalikan deleted=true、status=STOPPED。
Instans slot waktu 8 jam tidak mendukung penghapusan langsung; memanggilnya mengembalikan PREPAID_UNSUBSCRIBE_REQUIRED, dan Anda harus melalui proses berhenti berlangganan komersial.
can_delete=true menunjukkan bahwa status saat ini mengizinkan masuk ke proses penghapusan/penghentian langganan, tetapi tidak berarti bahwa Berlangganan dapat melewatkan penghentian langganan dan langsung DELETE. Untuk instance yang gagal yang belum memiliki pesanan terkait, silakan tangani berdasarkan hasil pengembalian antarmuka.

Pelepasan unsubscription adalah operasi asinkron. Ketika ModelCode yang sama sedang memproses operasi lain, operasi pelepasan yang diterima akan masuk antrean dan menunggu; melakukan kueri sebelum penyelesaian mungkin masih mengembalikan status asli dan kapasitas efektif. Diterimanya unsubscription tidak berarti kapasitas telah dilepaskan; harap verifikasi melalui hasil operasi dan Field verifikasi instans deleted secara lengkap. Untuk rincian rumus pengembalian dana unsubscription, lihatPenagihan Throughput Reservation。

Kueri Operasi Kapasitas

GET /api/v1/deployments/{deployed_model}/capacity-operations/{operation_id}

{
  "request_id": "example-poll-request",
  "output": {
    "operation_id": "100001",
    "request_id": "example-original-request",
    "operation_type": "SCALE",
    "operation_status": "SUCCEEDED",
    "model_service_id": "example-model-code",
    "instance_id": "example-capacity-instance",
    "from_status": "RUNNING",
    "current_status": "RUNNING"
  }
}

request_id luar adalah pengidentifikasi untuk permintaan kueri ini, dan yang ada di dalam objek operasi request_id adalah pengidentifikasi operasi asli; keduanya mungkin berbeda. Jalur kueri harus termasuk dalam ModelCode yang membuat operasi ini. Gunakan nilai aktual yang dikembalikan oleh operasi tulis operation_id, jangan membuatnya sendiri. Saat melakukan kueri terhadap ID numerik yang tidak ada atau operasi dari ModelCode lain, sistem akan mengembalikan HTTP 404, CAPACITY_OPERATION_NOT_FOUND; saat meneruskan ID tidak valid yang mengandung karakter non-numerik seperti huruf, sistem mungkin mengembalikan HTTP 500, InternalError. Jika mengalami kesalahan ini, verifikasi terlebih dahulu ID tersebut; jangan langsung menerbitkan ulang operasi tulis kapasitas.

Hapus Throughput Tereservasi

DELETE /api/v1/deployments/{deployed_model} Perlu melepaskan semua Instans Kapasitas terlebih dahulu, dan ModelCode adalah STOPPED、tidak ada CapacityOperation yang sedang dieksekusi atau diantrikan, lalu hapus seluruh deployment. Mengembalikan objek deployment. Setelah Instans terakhir dilepaskan, ModelCode menjadi STOPPED, ModelCode tidak akan dihapus secara otomatis. Menghapus Instans Kapasitas dan menghapus ModelCode adalah dua operasi yang berbeda.

Objek Respons dan Status

Instans Kapasitas (CapacityInstance)

Bidang	Tipe	Deskripsi
`model_service_id`	String	ModelCode tempat Instans Kapasitas atau Operasi berada.
`instance_id`	String	ID Instans Kapasitas.
`charge_type`	String	`pre_paid`（Berlangganan）/ `post_paid`（Bayar sesuai pemakaian）
`status`	String	Status siklus hidup instans; lihat tabel di bawah ini
`deleted`	Boolean	Apakah dihapus/dilepaskan, digunakan untuk mengidentifikasi Instans yang dilepaskan
`effective_capacity`	Object	Kapasitas layanan yang dikonfirmasi saat ini
`configured_capacity`	Object	Konfigurasi/kapasitas kontrak instans; dipertahankan bahkan ketika dihentikan atau ditangguhkan
`target_capacity`	Object	Kapasitas target yang sedang diubah; mungkin tidak dikembalikan atau kosong dalam status stabil
`pre_paid_info`	Object	Konfigurasi pembelian dan perpanjangan Berlangganan untuk Instance ini, termasuk `pricing_cycle`（`Day` Per Hari / `Hour` untuk slot waktu 8 jam), lihat Parameter Berlangganan。
`gmt_effective`	String	Waktu berlaku instance Berlangganan; instance slot waktu 8 jam mulai berlaku pada jam bulat waktu Beijing. Uraikan berdasarkan offset zona waktu, jangan mengambil angka jam dari `+00:00` secara langsung sebagai waktu Beijing.
`gmt_expired`	String	Waktu kedaluwarsa instance Berlangganan; instance slot waktu 8 jam dan `gmt_effective` berbeda sebesar 8 jam. Aturan perhitungan waktu kedaluwarsa lihatPenagihan Reservasi Throughput。
`can_scale`	Boolean	Apakah penskalaan saat ini diizinkan untuk instans; instans slot waktu 8 jam ditetapkan sebagai `false`。
`can_renew`	Boolean	Apakah perpanjangan instans saat ini diizinkan; instans slot waktu 8 jam ditetapkan sebagai `false`。
`can_enable_auto_renew`	Boolean	Apakah saat ini diperbolehkan mengaktifkan perpanjangan otomatis; instans periode 8 jam tetap `false`.
`can_disable_auto_renew`	Boolean	Apakah saat ini diperbolehkan menonaktifkan perpanjangan otomatis; instans periode 8 jam tetap `false`.
`can_delete`	Boolean	Apakah penghapusan atau berhenti berlangganan instans saat ini diizinkan; instans prabayar tetap harus menyelesaikan proses berhenti berlangganan, instans slot waktu 8 jam ditetapkan sebagai `false`.
`fail_reason`	String	Penyebab kegagalan
`gmt_created`	Waktu	Waktu pembuatan.
`gmt_modified`	Waktu	Waktu modifikasi terakhir.
`gmt_deleted`	Waktu	Waktu penghapusan.

Status	Makna dan Saran Tampilan
`WAIT_PRE_PAID_BILLING_TO_DEPLOYING` / `WAIT_TO_DEPLOY`	Menunggu pemrosesan pembelian / Menunggu berlaku
`RUNNING`	Berjalan
`WAIT_PRE_PAID_BILLING_TO_SCALING` / `SCALING`	Menunggu pesanan peningkatan / Memperbarui
`STOPPING` / `STOPPED`	Menghentikan / Dihentikan; dikombinasikan dengan `deleted` untuk membedakan yang Dilepaskan
`SUSPENDING` / `SUSPENDED`	Menangguhkan / Ditangguhkan
`STARTING` / `RECOVERING`	Memulai / Memulihkan
`DELETING`	Menghapus
`FAILED`	Gagal, tangani berdasarkan alasan kegagalan

Penghapusan Bayar Sesuai Pemakaian dan pembatalan Berlangganan dapat ditampilkan secara seragam sebagai "Dirilis": kondisinya adalah deleted=true, bukan hanya status=STOPPED。STOPPED + deleted=false masih merupakan instance Reserved. Instance deleted=true tidak diizinkan untuk diskalakan, diperpanjang, atau dihapus. RUNNING Status tidak berarti semua Tindakan tersedia. Ketika ModelCode yang sama memiliki operasi yang sedang berlangsung atau pembatasan penagihan, tindakan terkait mungkin tidak tersedia. Instans Subscription SUSPENDED tidak dapat diskalakan; namun dapat diperpanjang jika memenuhi syarat Perpanjangan; instans Pay-as-you-go tidak dapat diperpanjang. Sebelum memanggil, lakukan kueri ulang detail instans, melalui can_scale、can_renew、can_delete untuk memeriksa apakah tindakan tersebut tersedia, dan tangani kesalahan yang dikembalikan oleh antarmuka.

Operasi Kapasitas (CapacityOperation)

Bidang	Deskripsi
`operation_id`	ID operasi kapasitas, digunakan untuk mengkueri hasil operasi; mungkin dikembalikan dalam respons operasi tulis yang sesuai.
`request_id`	Pengidentifikasi permintaan yang memulai operasi kapasitas ini.
`operation_type`	Umum `CREATE`、`SCALE`、`RENEW`、`DELETE`; pemrosesan siklus hidup juga mungkin memunculkan `STOP`、`REFUND`, yang tidak berarti ada antarmuka tulis publik dengan nama yang sama
`operation_status`	Nilai:`PROCESSING`、`SUCCEEDED`、`FAILED`
`model_service_id`	ModelCode tempat instans kapasitas atau operasi berada.
`instance_id`	ID instans kapasitas. Mungkin tidak dikembalikan ketika pesanan pembelian belum diproses; silakan peroleh melalui kueri selanjutnya.
`from_status`	Status instans sebelum operasi.
`current_status`	Status instans saat ini.
`error_code`	Kode Kesalahan saat operasi gagal.
`error_message`	Deskripsi kesalahan saat operasi gagal.
`gmt_created`	Dibuat Pada.
`gmt_finished`	Waktu penyelesaian operasi.

Ketika operasi sedang dieksekusi atau dalam antrean tunggu, Mengembalikan PROCESSING。SUCCEEDED / FAILED adalah status terminal. Setelah menerima status terminal, hentikan polling dan segarkan ringkasan Instance serta Deploy.

Panggilan Asinkron, Idempotensi, dan Penanganan Kesalahan

Urutan panggilan yang disarankan

Kueri detail Instans, baca sakelar kapabilitas dan konfigurasi terbaru.
Mulai permintaan Pembelian / Penskalaan / Perpanjangan / Penghapusan dan Simpan operation_id。
Jika Mengembalikan PROCESSING, kueri operasi secara berkala dan kurangi frekuensi secara bertahap; jika mencapai status terminal, proses hasilnya secara langsung.
SUCCEEDED lalu segarkan Instans dan ModelCode; FAILED Tampilkan error_code / error_message. Waktu habis jaringan tidak sama dengan kegagalan operasi; pertama kueri operasi yang ada.

Perubahan kapasitas untuk ModelCode yang sama diproses secara berurutan; ketika ada operasi yang sedang berlangsung, perubahan baru mungkin ditolak. Pelepasan penghentian langganan yang diterima masuk dalam antrean dan berlanjut setelah operasi sebelumnya selesai. Sebelum perubahan berlaku, kueri masih Mengembalikan kapasitas efektif asli; kapasitas target tidak boleh dianggap sudah efektif. Setelah penumpukan, Penskalaan, atau pelepasan berlaku, Anda dapat memperoleh kapasitas efektif agregat yang diperbarui melalui antarmuka kueri Deploy dan terus menggunakan ModelCode asli. Memanggil model juga memerlukan penyelesaian Deployment model yang sesuai serta penggunaan autentikasi Akun dan parameter pemanggilan yang benar; operasi kapasitas yang berhasil tidak berarti semua kondisi lain untuk pemanggilan model telah terpenuhi.

Percobaan Ulang dan Pengidentifikasi Permintaan

Untuk percobaan ulang jaringan dari operasi tulis kapasitas yang sama, jaga agar pengidentifikasi permintaan dan parameter tetap tidak berubah. Disarankan untuk mengatur x-acs-req-uuid dan X-DashScope-RequestId ke UUID yang sama untuk menghindari ketidakkonsistenan di antara keduanya yang menyebabkan perubahan pengidentifikasi aktual. Prioritas baca saat ini adalah x-acs-req-uuid、X-DashScope-RequestId、X-Request-Id, pengidentifikasi baru dihasilkan jika tidak ada yang disediakan. Operasi kapasitas dengan ModelCode yang sama, pengidentifikasi permintaan valid yang sama, dan parameter operasi yang sama menggunakan kembali operasi yang ada; menggunakan pengidentifikasi yang sama dengan parameter berbeda akan mengembalikan IDEMPOTENCY_KEY_CONFLICT. Operasi bisnis baru menggunakan pengidentifikasi baru. Jangan menerapkan konvensi idempotensi operasi instance ini secara langsung pada pembuatan pertama ModelCode.

Kode Kesalahan

Kode Kesalahan	HTTP	Saran Penanganan
`CAPACITY_INSTANCE_REQUIRED`	400	Tentukan target untuk beberapa instans `instance_id`
`CAPACITY_INSTANCE_OPERATION_UNSUPPORTED`	400	Segarkan detail dan sakelar kapabilitas, konfirmasi status saat ini dan metode penagihan mendukung operasi tersebut
`PREPAID_UNSUBSCRIBE_REQUIRED`	400	Masuk ke proses berhenti berlangganan yang ada
`POSTPAID_INSTANCE_ALREADY_EXISTS`	400	Gunakan kembali instans pascabayar yang ada, atau lepaskan terlebih dahulu lalu buat baru
`CAPACITY_SLOT_LIMIT_EXCEEDED` / `TOTAL_CAPACITY_INSTANCE_LIMIT_EXCEEDED`	400	Telah mencapai slot instans aktif / Batas jumlah total termasuk riwayat
`MODEL_CODE_DELETED`	400	Tidak lagi melakukan operasi tulis pada Cadangan Throughput yang telah dihapus
`MODEL_CODE_NOT_FOUND` / `CAPACITY_INSTANCE_NOT_FOUND`	404	Periksa wilayah, akun, ModelCode, dan kepemilikan instans; melakukan penskalaan pada instans yang telah dihapus juga dapat mengembalikan CAPACITY_INSTANCE_NOT_FOUND
`CAPACITY_OPERATION_NOT_FOUND`	404	Operasi tidak ada atau bukan milik ModelCode yang ditentukan. Verifikasi ID yang dikembalikan oleh operasi tulis
`InternalError`	500	Mungkin dikembalikan ketika ID non-numerik yang tidak valid dikirimkan dalam kueri operasi; pertama verifikasi ID, untuk kesalahan internal lainnya simpan request_id dan hubungi dukungan teknis
`CAPACITY_INSTANCE_OPERATION_CONFLICT`	409	Pertama kueri operasi yang ada, dan setelah selesai mulailah operasi baru
`IDEMPOTENCY_KEY_CONFLICT`	409	Percobaan ulang mempertahankan parameter asli; operasi bisnis yang berbeda menggunakan pengidentifikasi baru
`BILLING_ACCOUNT_NOT_READY`	403	Periksa apakah akun memenuhi syarat pembelian
`BILLING_SERVICE_UNAVAILABLE`	503	Kueri operasi yang ada dan tangani percobaan ulang sesuai kebijakan backoff

Tabel ini mencantumkan kesalahan yang muncul selama fase permintaan yang sesuai dengan HTTP; kegagalan operasi asinkron dikembalikan melalui bidang error pada objek operasi, sehingga Anda tidak dapat menilai hanya berdasarkan status HTTP. Kesalahan umum lainnya:

Kode Status HTTP	Kode Kesalahan	Saran Penanganan
400	`InvalidParameter`	Verifikasi nama parameter, tipe, arah perubahan kapasitas, dan nilai.
401	`InvalidApiKey`	Periksa validitas dan wilayah Kunci API.
403	`AccessDenied` / `Model.AccessDenied` / `App.AccessDenied`	Periksa izin akun, ruang kerja, dan otorisasi model.
404	`ModelNotFound`	Verifikasi nama model dasar dan cakupan yang didukung.
409	`Conflict`	Konflik nama deployment, ubah nama atau sufiksnya.
429	`Throttling` / `Throttling.RateQuota` / `Throttling.AllocationQuota`	Kelebihan kuota reservasi throughput sesuai dengan AllocationQuota, Anda dapat melakukan penskalaan atau menyesuaikan strategi overflow.
500	`RequestTimeOut`	Periksa operasi yang ada terlebih dahulu untuk menghindari pembelian ganda; simpan request_id untuk menghubungi dukungan teknis.
503	`ModelUnavailable`	Coba lagi nanti atau beralih ke model yang tersedia.

Untuk penanganan batas laju, lihatPraktik Terbaik Batas Laju。

​Autentikasi dan Persiapan Panggilan

​Konvensi Umum

​Buat Throughput Tereservasi

​ptu_capacity

​pre_paid_info

​Respons Pembuatan

​Penskalaan

​Kueri Reservasi Throughput

​Kueri Daftar Reservasi Throughput

​Perpanjang

​Ubah Strategi Overflow

​Antarmuka Instans Kapasitas

​Instans Kapasitas Pembelian Bertumpuk

​Kueri Daftar Instans Kapasitas (termasuk instans yang dihapus)

​Kueri Detail Instans Kapasitas

​Penskalaan CapacityInstance Tertentu

​Perpanjang Instans Kapasitas Tertentu

​Hapus / Lepaskan Instans Kapasitas

​Kueri Operasi Kapasitas

​Hapus Throughput Tereservasi

​Objek Respons dan Status

​Instans Kapasitas (CapacityInstance)

​Operasi Kapasitas (CapacityOperation)

​Panggilan Asinkron, Idempotensi, dan Penanganan Kesalahan

​Urutan panggilan yang disarankan

​Percobaan Ulang dan Pengidentifikasi Permintaan

​Kode Kesalahan

Autentikasi dan Persiapan Panggilan

Konvensi Umum

Buat Throughput Tereservasi

ptu_capacity

pre_paid_info

Respons Pembuatan

Penskalaan

Kueri Reservasi Throughput

Kueri Daftar Reservasi Throughput

Perpanjang

Ubah Strategi Overflow

Antarmuka Instans Kapasitas

Instans Kapasitas Pembelian Bertumpuk

Kueri Daftar Instans Kapasitas (termasuk instans yang dihapus)

Kueri Detail Instans Kapasitas

Penskalaan CapacityInstance Tertentu

Perpanjang Instans Kapasitas Tertentu

Hapus / Lepaskan Instans Kapasitas

Kueri Operasi Kapasitas

Hapus Throughput Tereservasi

Objek Respons dan Status

Instans Kapasitas (CapacityInstance)

Operasi Kapasitas (CapacityOperation)

Panggilan Asinkron, Idempotensi, dan Penanganan Kesalahan

Urutan panggilan yang disarankan

Percobaan Ulang dan Pengidentifikasi Permintaan

Kode Kesalahan