Skip to main content

Referência da API de Reserva de Taxa de Transferência

A API de Reserva de Taxa de Transferência (anteriormente Reserva de TPM) permite criar, consultar e gerenciar a capacidade de taxa de transferência reservada. Cada Reserva de Taxa de Transferência é identificada por um ModelCode e pode conter várias instâncias de capacidade. Cada instância representa uma compra de capacidade e pode ser escalonada, renovada ou liberada separadamente.

Autenticação e Preparação de Chamada

Use a API Key do Bailian da região de chamada e passe-a no cabeçalho da solicitação Authorization: Bearer <api-key>. A API Key está vinculada à região e não pode ser usada entre regiões. Quando o corpo da solicitação for JSON, passe Content-Type: application/json。 O formato de domínio específico do espaço de trabalho é https://{workspaceId}.{region}.maas.aliyuncs.com, use o Endpoint do espaço de trabalho e região de destino. Para especificar um subespaço de negócios, inclua-o no cabeçalho da solicitação X-DashScope-WorkSpace: <workspace-id>。 O domínio da API DashScope é https://dashscope-intl.aliyuncs.com. A região da Virgínia usa https://{workspaceId}.us-east-1.maas.aliyuncs.com. Os resultados das operações assíncronas de capacidade são obtidos através de Consultar Operação de Capacidade . Para entrada no console, veja Reserva de Taxa de Transferência, para conceitos de implantação, veja Implantações, para API geral de implantação, veja Usando API para Realizar Implantação de Modelo。

Convenções comuns

O caminho base da interface é /api/v1/deployments, herdando o domínio DashScope OpenAPI e o método de autenticação da região de chamada. O corpo da solicitação usa Content-Type: application/json. Use a conta, o modelo e a implantação da região de destino.
  • deployed_model:o identificador de chamada da Reserva de Throughput (ModelCode); nas respostas de instância/operação model_service_id representa o mesmo objeto.
  • instance_id:ID da Instância de Capacidade. Use o valor de retorno da interface, não infira o Método de Cobrança com base no formato da string.
  • operation_id:ID da Operação, use o valor de string retornado pela interface.
  • Os IDs de exemplo, nomes de modelos e valores de capacidade abaixo são exemplos de espaço reservado. Os modelos reais, valores mínimos, tamanho do passo, limite superior e duração da compra estão sujeitos aos limites de modelo e compra da região de destino.
  • Os exemplos JSON omitem alguns campos de resposta opcionais; o status de estágio nos exemplos não é um retorno fixo para cada solicitação.
As respostas bem-sucedidas são uniformemente encapsuladas como:
{
  "request_id": "example-request",
  "output": {}
}
Exemplo de erro de solicitação:
{
  "request_id": "example-request",
  "code": "CAPACITY_INSTANCE_REQUIRED",
  "message": "需要指定容量实例"
}
Um sucesso na solicitação HTTP não equivale a um sucesso na operação de capacidade. Mesmo que a interface de gravação da instância retorne HTTP 200, output.operation_status também pode ser FAILED。必须检查操作状态和错误字段,确认成功后再使用更新的容量。

Criar Throughput Reservado

POST /api/v1/deployments Crie Reserva de Taxa de Transferência e compre a primeira instância de capacidade, retornando o ModelCode usado para chamar o modelo. Para adicionar capacidade a uma Reserva de Taxa de Transferência existente, chame Comprar Instância de Capacidade Empilhada。
CampoTipoObrigatórioDescrição
model_nameStringSimNome do modelo base
planStringSimptu
service_tierStringNãoNível de Desempenho: ptu_fast é alta velocidade (padrão), ptu_default é velocidade padrão
charge_typeStringSimpre_paid(Assinatura) / post_paid(Pay-as-you-go)
nameStringNãoNome de exibição; gerado automaticamente se não especificado.
suffixStringNãoSufixo do ModelCode; gerado automaticamente quando não fornecido.
ptu_capacityObjectSimConfiguração de Capacidade, veja Parâmetro de Capacidade
pre_paid_infoObjectObrigatório condicionalmenteAssinatura Obrigatória, veja Parâmetro de Assinatura; não passado para Pay-as-you-go
ptu_default suporta Assinatura;ptu_fast Suporta Assinatura e Pay-as-you-go. Novas instâncias de capacidade herdam o Nível de Desempenho do ModelCode. ptu_default Padrão suporta Por Dia e duas Ciclos de Cobrança de intervalo de tempo de 8 horas: Por Dia corresponde a pricing_cycle=Day, intervalo de tempo de 8 horas corresponde a pricing_cycle=Hour E duration=8. Intervalo de tempo de 8 horas apenas ptu_default Padrão suporta,ptu_fast Alta Velocidade não suporta. Exemplo de assinatura por dia:
{
  "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
  }
}
Exemplo de Assinatura de intervalo de tempo de 8 horas (apenas ptu_default Padrão):
{
  "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

A unidade de capacidade é kTPM (1 kTPM = 1000 Tokens/Minuto). Os modelos suportados atualmente não suportam configurar separadamente a cota de saída de pensamento.
CampoTipoDescrição
input_tpmLongCapacidade de entrada, unidade kTPM, fornecida de acordo com os requisitos do modelo e satisfazendo passo e Intervalo
output_tpmLongCapacidade de saída, unidade kTPM, fornecida de acordo com os requisitos do modelo e satisfazendo passo e Intervalo
Ao Dimensionar, indica a capacidade absoluta após a alteração da Instância selecionada, não o incremento, e não a capacidade total alvo do ModelCode.

pre_paid_info

CampoTipoDescrição
pricing_cycleStringCiclo de Cobrança:Day é Por Dia (padrão),Hour é intervalo de 8 Horas;Hour apenas velocidade Padrão ptu_default suportada, diferencia maiúsculas de minúsculas
durationIntegerDuração da Compra/Renovação, unidade segue pricing_cycle:Day como dias,Hour como horas e fixo em 8, deve ser maior que 0
auto_renewalBooleanespecifique explicitamente se deve renovar automaticamente; cenário Hour deve ser false
auto_renewal_durationIntegerObrigatório e maior que 0 quando a renovação automática está habilitada, unidade: dias;Hour não passado neste cenário
auto_renewal_cycleStringOpcional. Unidade do ciclo de renovação, passe valores suportados pelo produto, por exemplo Day indica dias;Hour não passado neste cenário

Resposta de criação

output é o objeto de implantação (Consultar Reserva de Taxa de Transferência). Ao criar uma instância de capacidade, pode retornar operation_id、instance_id; quando o pedido de compra de uma instância de Assinatura ainda não foi processado, instance_id pode estar temporariamente indisponível; obtenha-o posteriormente via consulta.
{
  "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"
  }
}
Existem operation_id quando, por Consultar Operação de Capacidade consultar; para um tempo limite de solicitação de criação, primeiro confirme se ela já foi criada para evitar a criação duplicada de ModelCode.

Dimensionamento

PUT /api/v1/deployments/{deployed_model}/scale Ajuste a capacidade de entrada e saída de uma instância de capacidade sob a reserva de taxa de transferência especificada. Quando houver várias instâncias não excluídas, você deve usar instance_id para especificar a instância de destino.
CampoObrigatórioDescrição
instance_idObrigatório condicionalmenteObrigatório quando houver múltiplas Instâncias não excluídas; pode ser omitido quando houver apenas uma Instância não excluída
ptu_capacitySimA capacidade absoluta após a alteração desta instância
pre_paid_infoNãoQuando a Assinatura não for passada, reutilize as informações salvas; Pay-as-you-go não passa isso
order_typeNãoUPGRADE para upgrade, DOWNGRADE para downgrade; quando omitido, o servidor determina, e o valor passado deve ser consistente com a direção da alteração de capacidade
{
  "instance_id": "example-capacity-instance",
  "ptu_capacity": {
    "input_tpm": 20000,
    "output_tpm": 2000
  },
  "order_type": "UPGRADE"
}
output Retorna informações de Reserva de Taxa de Transferência; o ID da operação de capacidade correspondente via operation_id é retornado. Para múltiplas instâncias sem ID especificado, retorna CAPACITY_INSTANCE_REQUIRED. Para novas integrações, recomendado Escalonar Instância de Capacidade Especificada。 Alterações de Assinatura envolvem pedidos; o Pós-pago não passa por pedidos de alteração de Assinatura. Antes que a alteração seja confirmada, a capacidade efetiva original continua a ser mantida; em caso de falha, a capacidade alvo não pode ser mostrada como efetiva. Escalonamento para tudo zero não equivale a excluir uma Instância.

Consultar Reserva de Throughput

GET /api/v1/deployments/{deployed_model} Consulte a configuração e o Status da Reserva de Throughput especificada, bem como a capacidade efetiva agregada de todas as Instâncias de Capacidade.
{
  "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"
  }
}
CampoDescrição
deployed_modelO identificador de chamada da Reserva de Throughput (ModelCode).
model_nameNome do modelo base.
planIdentificador de tipo, Throughput Reserved é ptu.
statusStatus do ModelCode, não representa o Status de cada CapacityInstance
ptu_service_tierNível de Desempenho:ptu_fast é alta velocidade,ptu_default é velocidade padrão
ptu_capacityA capacidade agregada de entrada e saída de todas as CapacityInstances efetivas sob este ModelCode
charge_typeValor:pre_paid(Assinatura)/ post_paid(Pay-as-you-go)
pre_paid_infoConfiguração de Compra e Renovação por Assinatura, incluindo pricing_cycle(Day Por Dia / Hour para período de 8 Horas),duration etc. Quando existirem várias Instâncias de capacidade, consulte a Instância de destino através dos detalhes da Instância pre_paid_info。
pre_paid_instance_idIdentificador da instância por assinatura. Quando existirem várias instâncias de capacidade, obtenha cada instância através da lista de instâncias de capacidade instance_id e especifique a instância na qual operar.
pre_paid_gmt_expiredTempo de expiração da assinatura. Quando existirem várias Instâncias de capacidade, obtenha seu tempo de expiração através dos detalhes da Instância de destino gmt_expired. As regras de cálculo do tempo de expiração estão emCobrança de Reserva de Taxa de Transferência。
overflow_strategyEstratégia de estouro,enable indica que a cobrança pós-paga por estouro é permitida,disable indica que o limitador é aplicado quando a capacidade é excedida. Para regras de cobrança de estouro, veja Cobrança de Reserva de Taxa de Transferência。
fail_reasonMotivo da falha.
gmt_createCriado em.
gmt_modifiedHora da última modificação.
operation_idID da CapacityOperation, usado para consultar resultados da operação; pode ser retornado na resposta da operação de gravação correspondente.
instance_idID da CapacityInstance. Pode não ser retornado quando o pedido de compra não foi totalmente processado; obtenha-o através de consultas subsequentes.
A cobrança mista deve ser determinada pelo charge_type de cada instância na lista CapacityInstance. O status da implantação e o tipo de cobrança não podem substituir o status e o tipo de cobrança de cada instância.

Consultar Lista de Reservas de Throughput

GET /api/v1/deployments?page_no=1&page_size=10&plan=ptu Consulte a lista de reservas de throughput com paginação.
Parâmetro de consultaDescrição
page_noNúmero da página, padrão 1
page_sizeNúmero de itens por página, padrão 10, Intervalo [1,100]
planFiltro de tipo opcional. Passe ptu; O Nível de Desempenho é indicado por service_tier e não é um valor de 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
  }
}
A lista de implantações não suporta filtragem de status via parâmetro status. Para filtragem de instâncias de capacidade, use Consultar Lista de Instâncias de Capacidade (Incluindo Instâncias Excluídas) 's statuses。

Renovar

PUT /api/v1/deployments/{deployed_model}/renew Renove a instância de capacidade de Assinatura especificada; a capacidade pode ser ajustada ao mesmo tempo. Quando houver múltiplas instâncias não excluídas, você deve especificar a instância alvo via instance_id.
CampoObrigatórioDescrição
instance_idObrigatório condicionalmenteDeve ser especificado quando houver múltiplas instâncias não excluídas; instância única pode ser omitida
pre_paid_infoSimInformações de renovação, veja Parâmetros de Assinatura
is_changeNãoPadrão false; se deve ajustar a capacidade ao mesmo tempo
ptu_capacityNãoOmita para reter a capacidade configurada; ao passar uma capacidade diferente, deve is_change=true
Renovar e habilitar renovação automática:
{
  "instance_id": "example-capacity-instance",
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": true,
    "auto_renewal_duration": 30
  }
}
Renovar, mas não habilitar renovação automática:
{
  "instance_id": "example-capacity-instance",
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  }
}
Apenas Assinatura é suportada; solicitações de renovação não podem passar order_type。output Retorna informações de Reserva de Taxa de Transferência e pode incluir um ID de Operação de Capacidade; recomenda-se usar a interface de nível de instância Renovar Instância de Capacidade Especificada e sondar os resultados.

Modificar Estratégia de Overflow

PUT /api/v1/deployments/{deployed_model}/update-overflowstrategy
{
  "overflow_strategy": "disable"
}
overflow_strategy Obrigatório, apenas minúsculas são suportadas enable / disable。enable indica que o tráfego que excede a capacidade PTU tem permissão para transbordar para o pool público para cobrança paga conforme o uso;disable indica limitação após o limite ser excedido. A configuração aplica-se a todo o ModelCode; os pacotes de capacidade não possuem estratégias individuais de overflow. Para detalhes sobre a cobrança de overflow, consulteCobrança de Reserva de Taxa de Transferência。 A resposta contém request_id e output. Após a modificação, você pode passar Reserva de Taxa de Transferência Obter overflow_strategy, confirme que a configuração foi atualizada.
{
  "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
    }
  }
}
Após ativar a estratégia de overflow, o tráfego que exceder a capacidade será cobrado com base no pagamento conforme o uso, incorrendo em taxas adicionais. Após desativá-la, as solicitações que excederem a capacidade serão limitadas. Para detalhes sobre a cobrança de overflow, consulteCobrança de Reserva de Taxa de Transferência; para mais informações, consulteEntrada Longa e Cache de Taxa de Transferência Provisionada。

Interface da instância de capacidade

As interfaces a seguir usam todas /api/v1/deployments/{deployed_model} como prefixo. Operações de escrita de instância retornam o objeto de operação Operação de Capacidade, diferente do antigo objeto de Implantações /scale、/renew.

Instância de Capacidade de Compra Empilhada

POST /api/v1/deployments/{deployed_model}/capacity-instances
CampoObrigatórioDescrição
billing_methodSimMétodo de Cobrança:PRE_PAY é Assinatura,POST_PAY é Pay-as-you-go. Os valores diferenciam maiúsculas de minúsculas
ptu_capacitySimNova capacidade da instância
pre_paid_infoObrigatório condicionalmenteObrigatório para Assinatura, não transmitido para Pay-as-you-go
Exemplo de assinatura:
{
  "billing_method": "PRE_PAY",
  "ptu_capacity": {
    "input_tpm": 10000,
    "output_tpm": 1000
  },
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  }
}
Exemplo de compra adicional de período de tempo de 8 Horas (apenas velocidade padrão ptu_default, billing_method fixo PRE_PAY,pre_paid_info passe 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
  }
}
Instância de período de tempo de 8 Horas criada com sucesso, Passar Consultar Detalhes da Instância de Capacidade pode Obter os seguintes Campos: pricing_cycle é Hour;gmt_effective é a Hora efetiva em hora cheia no horário de Pequim; gmt_expired e gmt_effectiveuma diferença de 8 Horas;can_scale、can_renew、can_enable_auto_renew、can_disable_auto_renew、can_deletesão todos false。 Exemplo de pagamento conforme o uso:
{
  "billing_method": "POST_PAY",
  "ptu_capacity": {
    "input_tpm": 10000,
    "output_tpm": 1000
  }
}
Retorna o objeto de operação; a resposta inicial pode indicar sucesso, falha ou ainda em andamento. Reutilize o ModelCode, modelo e Nível de Desempenho existentes; apenas uma Instância Pós-paga não excluída é permitida por ModelCode. Quando as condições de compra ou a quantidade de Instâncias não atenderem aos requisitos, trate de acordo com o erro retornado pela interface.

Consultar Lista de Instâncias de Capacidade (incluindo instâncias excluídas)

GET /api/v1/deployments/{deployed_model}/capacity-instances?page_no=1&page_size=20&include_deleted=true
Parâmetro de consultaTipoDescrição
page_noIntegerPadrão 1
page_sizeIntegerPadrão 20, Intervalo [1,100]
include_deletedBooleanPadrão true; passe explicitamente false ao mostrar apenas instâncias não excluídas
statusesLista de stringsOpcional, múltiplos valores separados por vírgula, por exemplo RUNNING,STOPPED
charge_typesLista de stringsOpcional,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
  }
}
A estrutura de paginação difere da lista de Implantações:records é a página atual,items é a contagem total,page é o Número da Página,itemsPerPage / pageCount mantém a grafia camelCase do Retorno atual. Instâncias com capacidade ativa têm prioridade, seguidas de ordenação por Data de Criação em ordem decrescente. A Lista suporta apenas o Parâmetro de consulta listado nesta seção.

Consultar Detalhes da Instância de Capacidade

GET /api/v1/deployments/{deployed_model}/capacity-instances/{instance_id} Retorna objeto de instância CapacityInstance; instâncias excluídas também podem ser consultadas. ModelCode e a instância devem corresponder; instâncias não podem ser operadas entre ModelCodes.
Após uma Instância Pós-paga ser liberada, a recompra de capacidade Pós-paga sob o mesmo ModelCode reutilizará o ID da instância original. A Lista e os detalhes são atualizados para as informações da instância após a recompra, e não retêm mais separadamente o registro de Exclusão original. Após a liberação, configured_capacity pode ser zero; não há garantia de retenção da capacidade configurada antes da liberação.

Dimensionar CapacityInstance Especificado

PUT /api/v1/deployments/{deployed_model}/capacity-instances/{instance_id}/scale
{
  "ptu_capacity": {
    "input_tpm": 20000,
    "output_tpm": 2000
  },
  "order_type": "UPGRADE"
}
Semântica de parâmetro igual a Escalonamento, o ID da instância é determinado pelo caminho; o corpo da solicitação não precisa ser repetido. Retorna o objeto de operação. Leia antes de chamar can_scale;Instâncias com expiração de Assinatura pendente não podem sofrer Escalonamento diretamente, Renove primeiro. Instâncias de intervalo de tempo de 8 horas não suportam Escalonamento, a chamada retorna CAPACITY_INSTANCE_OPERATION_UNSUPPORTED。

Renovar Instância de Capacidade Especificada

PUT /api/v1/deployments/{deployed_model}/capacity-instances/{instance_id}/renew Renovação regular:
{
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  }
}
Renovar e ajustar capacidade:
{
  "pre_paid_info": {
    "duration": 30,
    "auto_renewal": false
  },
  "is_change": true,
  "ptu_capacity": {
    "input_tpm": 20000,
    "output_tpm": 2000
  }
}
Restrições de parâmetro iguais a Renovar, não passe order_type。Apenas Assinatura pode ser Renovada, verifique primeiro can_renew;Retorna objeto de operação. Instâncias de intervalo de tempo de 8 horas não suportam Renovação e renovação automática, a chamada retorna CAPACITY_INSTANCE_OPERATION_UNSUPPORTED。

Excluir / Liberar Instância de Capacidade

DELETE /api/v1/deployments/{deployed_model}/capacity-instances/{instance_id} Parâmetro de consulta opcional reason é o motivo da exclusão, codificado em URL; nenhum corpo de solicitação JSON é necessário. Retorna um objeto de operação.
  • Pay-as-you-go: Liberado via processo de exclusão e, após a conclusão, o deleted=true、status=STOPPED, com capacidade efetiva de zero.
  • Assinatura Efetiva: Esta interface não pode ser usada no lugar do cancelamento da assinatura; chamá-la diretamente retorna PREPAID_UNSUBSCRIBE_REQUIRED. Após concluir o cancelamento da assinatura e liberar a capacidade, ela também retorna, em última análise, deleted=true、status=STOPPED。
  • Instâncias de intervalo de tempo de 8 horas não suportam exclusão direta; chamá-lo retorna PREPAID_UNSUBSCRIBE_REQUIRED, e você deve passar pelo processo comercial de cancelamento de assinatura.
  • can_delete=true indica que o status atual permite entrar no processo de exclusão/cancelamento de assinatura, mas não significa que a Assinatura possa pular o cancelamento e executar DELETE diretamente. Para instâncias falhas que ainda não possuem pedidos associados, trate-as com base nos resultados retornados pela interface.
A liberação por cancelamento de assinatura é uma operação assíncrona. Quando o mesmo ModelCode estiver processando outras operações, uma operação de liberação aceita entrará na fila e aguardará; a consulta antes da conclusão ainda pode retornar o status original e a capacidade efetiva. O aceite do cancelamento da assinatura não significa que a capacidade foi liberada; verifique através dos resultados da operação e da instância deleted Verificação de campo concluída. Para detalhes da fórmula de reembolso de cancelamento de assinatura, consulteCobrança de Reserva de Taxa de Transferência。

Operação de Consulta de Capacidade

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"
  }
}
O request_id externo é o identificador desta solicitação de consulta, e aquele dentro do objeto de operação request_id é o identificador original da operação; os dois podem diferir. O caminho da consulta deve pertencer ao ModelCode que criou esta operação. Use o valor real retornado pela operação de escrita operation_id, não o construa manualmente. Ao consultar um ID numérico inexistente ou operações de outro ModelCode, retorna HTTP 404, CAPACITY_OPERATION_NOT_FOUND; ao passar um ID inválido contendo caracteres não numéricos, como letras, pode retornar HTTP 500, InternalError. Ao encontrar esse erro, verifique primeiro o ID; não reemita diretamente a operação de escrita de capacidade.

Excluir Throughput Reservado

DELETE /api/v1/deployments/{deployed_model} É necessário primeiro liberar todas as Instâncias de Capacidade, e o ModelCode deve ser STOPPED、nenhuma CapacityOperation está executando ou enfileirada, então exclua toda a implantação. Retorna o objeto de implantação. Após a última Instância ser liberada, o ModelCode torna-se STOPPED, o ModelCode não será excluído automaticamente. Excluir uma Instância de Capacidade e excluir um ModelCode são duas operações diferentes.

Objeto de resposta e status

Instância de Capacidade (CapacityInstance)

CampoTipoDescrição
model_service_idStringO ModelCode ao qual a Instância de Capacidade ou Operação pertence.
instance_idStringID da instância de capacidade.
charge_typeStringpre_paid(Assinatura)/ post_paid(Pay-as-you-go)
statusStringStatus do ciclo de vida da instância; veja a tabela abaixo
deletedBooleanSe foi excluído/liberado, usado para identificar Instâncias liberadas
effective_capacityObjectCapacidade de serviço confirmada atualmente
configured_capacityObjectConfiguração da instância/capacidade contratada; retida mesmo quando parada ou suspensa
target_capacityObjectCapacidade alvo sendo alterada; pode não ser retornada ou estar vazia em estado estável
pre_paid_infoObjectConfiguração de compra e renovação por assinatura desta Instância, incluindo pricing_cycle(Day Por Dia / Hour para intervalos de tempo de 8 horas), veja Parâmetros de Assinatura。
gmt_effectiveStringHora de vigência da instância por assinatura; instâncias de intervalo de tempo de 8 horas entram em vigor em horas cheias no horário de Pequim. Analise pelo deslocamento do fuso horário, não utilize o número da hora de +00:00 diretamente como horário de Pequim.
gmt_expiredStringTempo de expiração da instância por assinatura; instâncias de intervalo de tempo de 8 horas e gmt_effective diferem em 8 horas. Para as regras de cálculo do tempo de expiração, vejaCobrança de Reserva de Taxa de Transferência。
can_scaleBooleanSe o dimensionamento é permitido atualmente para a instância; instâncias de intervalo de tempo de 8 horas são fixas em false.
can_renewBooleanSe a renovação da instância é permitida atualmente; instâncias de intervalo de tempo de 8 horas são fixas em false.
can_enable_auto_renewBooleanSe é permitido habilitar a renovação automática atualmente; instâncias de período de 8 horas são fixas false.
can_disable_auto_renewBooleanSe é permitido desabilitar a renovação automática atualmente; instâncias de período de 8 horas são fixas false.
can_deleteBooleanSe a exclusão ou cancelamento da assinatura da instância é permitido atualmente; instâncias pré-pagas ainda precisam concluir o processo de cancelamento, instâncias de período de 8 horas são fixas em false.
fail_reasonStringMotivo da falha
gmt_createdTempoHora de criação.
gmt_modifiedTempoHora da última modificação.
gmt_deletedTempoHora de exclusão.
StatusSignificado e sugestões de exibição
WAIT_PRE_PAID_BILLING_TO_DEPLOYING / WAIT_TO_DEPLOYAguardando processamento da compra / Aguardando entrar em vigor
RUNNINGEm execução
WAIT_PRE_PAID_BILLING_TO_SCALING / SCALINGAguardando pedido de upgrade / Atualizando
STOPPING / STOPPEDParando / Parado; combinado com deleted distingue Liberado
SUSPENDING / SUSPENDEDSuspendendo / Suspenso
STARTING / RECOVERINGIniciando / Recuperando
DELETINGExcluindo
FAILEDFalhou, trate com base no motivo da falha
A exclusão Pós-paga e o cancelamento de Assinatura podem ser uniformemente mostrados como "Liberado": a condição é deleted=true, e não apenas status=STOPPED。STOPPED + deleted=false ainda são instâncias Reservadas. Instâncias deleted=true não têm permissão para escalar, renovar ou excluir. RUNNING O status não significa que todas as ações estão disponíveis. Quando o mesmo ModelCode tem uma operação em andamento ou restrições de cobrança, a ação correspondente pode estar indisponível. Instâncias de assinatura SUSPENDED não podem ser escalonadas; podem ser renovadas quando atenderem às condições de renovação; instâncias pagas conforme o uso não podem ser renovadas. Antes de chamar, consulte novamente os detalhes da instância, via can_scale、can_renew、can_delete para verificar se a ação está disponível e trate os erros retornados pela interface.

Operação de Capacidade (CapacityOperation)

CampoDescrição
operation_idID da operação de capacidade, usado para consultar resultados da operação; pode ser retornado na resposta da operação de gravação correspondente.
request_idO identificador de solicitação que iniciou esta operação de capacidade.
operation_typeComum CREATE、SCALE、RENEW、DELETE; o processamento do ciclo de vida também pode apresentar STOP、REFUND, o que não significa que exista uma interface pública de escrita com o mesmo nome
operation_statusValores:PROCESSING、SUCCEEDED、FAILED
model_service_idO ModelCode ao qual a instância de capacidade ou operação pertence.
instance_idID da instância de capacidade. Pode não ser retornado quando o pedido de compra ainda não foi processado; obtenha-o através de consultas subsequentes.
from_statusO status da instância antes da operação.
current_statusStatus atual da instância.
error_codeCódigo de erro quando a operação falha.
error_messageDescrição do erro quando a operação falha.
gmt_createdCriado em.
gmt_finishedHora de conclusão da operação.
Quando a operação estiver sendo executada ou enfileirada para espera, retorna PROCESSING。SUCCEEDED / FAILED é o estado terminal. Ao receber o estado terminal, pare a sondagem e atualize o resumo da Instância e da Implantação.

Chamada assíncrona, idempotência e tratamento de erros

Sequência de chamadas recomendada

  1. Consulte detalhes da Instância, leia switches de capacidade e a configuração mais recente.
  2. Inicie uma solicitação de Compra / Dimensionamento / Renovação / Exclusão e Salve operation_id.
  3. Se Retornar PROCESSING, consulte periodicamente a operação e faça backoff gradualmente; se o estado terminal for alcançado, processe o resultado diretamente.
  4. SUCCEEDED então atualize a Instância e o ModelCode; FAILED Mostrar error_code / error_message. Timeout de rede não equivale a falha na operação; consulte primeiro as operações existentes.
Alterações de capacidade para o mesmo ModelCode são processadas em ordem; quando houver uma operação em andamento, novas alterações podem ser rejeitadas. Liberações de cancelamento de assinatura aceitas são enfileiradas e continuam após a conclusão das operações anteriores. Antes que uma alteração entre em vigor, as consultas ainda Retornam a capacidade efetiva original; a capacidade alvo não deve ser tratada como já efetiva. Após o empilhamento, o escalonamento ou a liberação entrar em vigor, você pode obter a capacidade efetiva agregada atualizada por meio da interface de consulta de Implantação e continuar usando o ModelCode original. A chamada de um modelo também exige a conclusão das implantações correspondentes do modelo e o uso da autenticação de conta e dos parâmetros de chamada corretos; uma operação de capacidade bem-sucedida não significa que todas as outras condições para a invocação do modelo foram atendidas.

Identificador de nova tentativa e solicitação

Para tentativas de rede da mesma operação de escrita de capacidade, mantenha o identificador de solicitação e os parâmetros inalterados. Recomenda-se definir x-acs-req-uuid e X-DashScope-RequestId como o mesmo UUID para evitar que inconsistências entre os dois causem alterações reais no identificador. A prioridade de leitura atual é x-acs-req-uuid、X-DashScope-RequestId、X-Request-Id, um novo identificador é gerado quando nenhum é fornecido. Operações de capacidade com o mesmo ModelCode, o mesmo identificador de solicitação válido e os mesmos parâmetros de operação reutilizam operações existentes; usar o mesmo identificador com parâmetros diferentes retornará IDEMPOTENCY_KEY_CONFLICT. Novas operações de negócios usam novos identificadores. Não aplique diretamente esta convenção de idempotência de operação de instância à primeira criação de ModelCode.

Código de Erro

Código de erroHTTPSugestão de tratamento
CAPACITY_INSTANCE_REQUIRED400Especificar o alvo para múltiplas instâncias instance_id
CAPACITY_INSTANCE_OPERATION_UNSUPPORTED400Atualize detalhes e switches de capacidade, confirme se o status atual e o método de cobrança suportam a operação
PREPAID_UNSUBSCRIBE_REQUIRED400Transferido para processo de cancelamento existente
POSTPAID_INSTANCE_ALREADY_EXISTS400Reutilize a instância pós-paga existente ou libere-a antes de criar uma nova
CAPACITY_SLOT_LIMIT_EXCEEDED / TOTAL_CAPACITY_INSTANCE_LIMIT_EXCEEDED400Limite de slots de instância válida / limite total incluindo registros históricos atingido
MODEL_CODE_DELETED400Não inicie mais operações de escrita em reservas de throughput excluídas
MODEL_CODE_NOT_FOUND / CAPACITY_INSTANCE_NOT_FOUND404Verificar região, conta, ModelCode e归属 da instância; executar scale em instâncias excluídas também pode retornar CAPACITY_INSTANCE_NOT_FOUND
CAPACITY_OPERATION_NOT_FOUND404A operação não existe ou não pertence ao ModelCode especificado. Verifique o ID retornado pela operação de gravação
InternalError500Pode ser retornado quando um ID não numérico inválido é passado na consulta de operação; verifique primeiro o ID, para outros erros internos retenha request_id e contate o suporte técnico
CAPACITY_INSTANCE_OPERATION_CONFLICT409Primeiro consulte operações existentes e, após a conclusão, inicie uma nova operação
IDEMPOTENCY_KEY_CONFLICT409A nova tentativa mantém os parâmetros originais; diferentes operações de negócios usam um novo identificador
BILLING_ACCOUNT_NOT_READY403Verifique se a conta atende às condições de compra
BILLING_SERVICE_UNAVAILABLE503Consulte operações existentes e trate novas tentativas de acordo com a política de backoff
A tabela lista erros lançados durante a fase de requisição correspondentes ao HTTP; falhas de operações assíncronas são retornadas através do campo de erro do objeto de operação, portanto, você não pode julgar apenas pelo status HTTP. Outros erros comuns:
Código de status HTTPCódigo de erroSugestão de tratamento
400InvalidParameterVerifique nomes de parâmetros, tipos, direção de alteração de capacidade e valores.
401InvalidApiKeyVerifique a validade e a região da chave de API.
403AccessDenied / Model.AccessDenied / App.AccessDeniedVerifique as permissões da conta, o workspace e a autorização do modelo.
404ModelNotFoundVerifique o nome do modelo base e o escopo suportado.
409ConflictConflito de nome de implantação, altere o nome ou sufixo.
429Throttling / Throttling.RateQuota / Throttling.AllocationQuotaReserva de throughput acima da cota corresponde a AllocationQuota, você pode dimensionar ou ajustar a estratégia de overflow.
500RequestTimeOutVerifique primeiro as operações existentes para evitar compras duplicadas; mantenha o request_id para contatar o suporte técnico.
503ModelUnavailableTente novamente mais tarde ou mude para um modelo disponível.
Para tratamento de limite de taxa, vejaMelhores Práticas de Limite de Taxa.