OpenAPI Documentation
OpenAPI Documentation

Static proxy renewal workflow

Static proxy renewals enter asynchronous processing after the order is accepted and payment succeeds. One request may renew 1–500 deduplicated resources. All resources use the same renewal duration, but individual resource outcomes may differ.

sequenceDiagram
    participant C as Caller
    participant A as Open API
    participant W as Callback receiver

    C->>A: List static proxy resources
    A-->>C: Return resource IDs and expiration times
    C->>A: Get renewal quote (resources, common duration)
    A-->>C: Return current total amount without locking the price
    C->>A: Create renewal order (resources, common duration, request_no, optional callback_url)
    A-->>C: Payment succeeds; return PROCESSING and order number
    par Automatic polling
        loop While order is PROCESSING, or FAILED with resources still PROCESSING
            C->>A: Get renewal order details
            A-->>C: Return order-level and resource-level statuses
        end
    and callback_url was provided
        A->>W: Notify once on first transition to COMPLETED or FAILED
        W-->>A: Return any 2xx response
    end
    C->>A: Get renewal order details
    A-->>C: Return latest order and resource results

Integration steps

  1. Call List static proxy resources, then select IDs that are currently ACTIVE and have not expired.
  2. Select one duration for the entire order: all-ISP orders support 7 and 30 days; all-ISP_NATIVE orders support 7, 30, and 90 days; mixed orders support 7 and 30 days.
  3. Call Get a static proxy renewal quote to obtain the current total amount. The quote does not create an order, charge the wallet, or lock the price.
  4. Call Create a static proxy renewal order and save the returned order_no. Resource states and prices are checked again at creation time, so the final amount may differ from the quote.
  5. Call Get static proxy renewal order details every 10–30 seconds. Stop when the order is COMPLETED. If the order is FAILED, continue until every resource status is no longer PROCESSING, then stop automatic polling and contact support.
  6. Read each resource's status and latest expiration time from resources.

For a COMPLETED order, order-level finish_time is the time when all resources completed. For a FAILED order, order-level finish_time is the first time a failure was observed; it does not mean that all resources have finished. Resources that renewed successfully retain their new expiration times.

A callback is sent only once, when the order first enters COMPLETED or FAILED. Failed callback delivery is not retried, and no second callback is sent after remaining resources finish. FAILED orders are not refunded automatically. After support completes manual handling, query order details again for the latest result.

Creation error 300320 means that the resource price does not exist or does not match the requested specification. The actual msg follows X-LANG; if omitted or unsupported, en_US is used.

On this page