Ace Data Cloud平台剩余配额查询教程

Ace Data Cloud平台提供了一系列API服务，这些服务的调用通常是基于配额计费的。为了避免因配额耗尽而导致业务中断或损失，Ace Data Cloud平台提供了一个接口供用户查询剩余配额。通过这个接口，您的平台可以及时发现配额不足的情况，并进行充值，从而确保业务的连续性。

本文将手把手教您如何集成查询剩余配额的接口。

环境准备

在开始之前，请确保您已注册Ace Data Cloud账户，并能访问以下链接： - Ace Data Cloud控制台 - 平台令牌管理

1. 查看应用程序ID

每个API服务对应一个"应用程序"实例，每个实例都有自己的ID、密钥、剩余配额等信息。您可以在应用程序列表中查看。

假设您想查询"Midjourney API"的剩余配额，请复制对应的应用程序ID并记录为 application_id。

2. 创建平台令牌

Ace Data Cloud平台提供了"平台令牌"机制，允许开发者通过API查询账户信息，包括订单列表、应用程序列表、分配信息和调用记录等。与用户令牌不同，平台令牌的有效期为永久，而用户令牌会在一段时间后过期。

要创建平台令牌，请访问平台令牌管理，如图所示：

复制"平台令牌"，并记录为 token。

3. 查询配额

有了 application_id 和 token，您可以构建一个URL来查询剩余配额。查询配额的API格式如下：

请求方法：GET
请求URL：https://platform.acedata.cloud/api/v1/applications/{application_id}
请求头：
accept: application/json
authorization: Bearer {token}

您可以使用以下CURL命令进行请求：

shell 复制代码

curl -X GET \
  -H "accept: application/json" \
  -H "authorization: Bearer {token}" \
  "https://platform.acedata.cloud/api/v1/applications/{application_id}"

例如，如果 token 为 platform-v1-5b8fbef60bc547098034db3e9f36a623731c490abe854f72972a0a3473b4c56b，application_id 为 107f8d0f-e465-4a7e-a49e-d633d26f7aa2，则命令如下：

shell 复制代码

curl -X GET \
  -H "accept: application/json" \
  -H "authorization: Bearer platform-v1-5b8fbef60bc547098034db3e9f36a623731c490abe854f72972a0a3473b4c56b" \
  "https://platform.acedata.cloud/api/v1/applications/107f8d0f-e465-4a7e-a49e-d633d26f7aa2"

请将 {application_id} 替换为实际的应用程序ID，{token} 替换为有效的平台令牌。

执行该CURL命令后，将向指定的URL发送GET请求，并在请求头中包含所需的 accept 和 authorization 信息。返回的示例结果如下：

json 复制代码

{
  "id": "107f8d0f-e465-4a7e-a49e-d633d26f7aa2",
  "service_id": "d87e5e99-b797-4ade-9e73-b896896b0461",
  "remaining_amount": 493.2210000000001,
  "used_amount": 21.778999999999996,
  "service": {
    ...
  },
  "user_id": "b87f67c1-b04f-4332-99a1-7a5e651331c6",
  "created_at": "2024-05-30T14:41:20.052849Z",
  "updated_at": "2024-08-16T07:51:15.603207Z",
  "tags": null,
  "expired_at": null,
  "type": "Usage",
  "metadata": null
}

在返回的JSON结果中，remaining_amount 表示剩余配额。

4. 使用其他编程语言

您可以将CURL命令转换为其他编程语言的格式，如果您在转换过程中遇到困难，可以使用 CURL转换工具帮助转换。

Python 示例

python 复制代码

import requests

url = "https://platform.acedata.cloud/api/v1/applications/{application_id}"
headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}"
}

response = requests.get(url, headers=headers)
print(response.json())

Node.js 示例

javascript 复制代码

import axios from "axios";

const url =
  "https://platform.acedata.cloud/api/v1/applications/{application_id}";
const headers = {
  accept: "application/json",
  authorization: "Bearer {token}",
};

axios
  .get(url, { headers })
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Java 示例

java 复制代码

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

import java.io.IOException;

public class Main {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        String url = "https://platform.acedata.cloud/api/v1/applications/{application_id}";
        String token = "{token}";

        Request request = new Request.Builder()
                .url(url)
                .addHeader("accept", "application/json")
                .addHeader("authorization", "Bearer " + token)
                .build();

        try {
            Response response = client.newCall(request).execute();
            String responseData = response.body().string();
            System.out.println(responseData);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

PHP 示例

php 复制代码

<?php

$url = 'https://platform.acedata.cloud/api/v1/applications/{application_id}';
$token = '{token}';

$headers = array(
    'accept: application/json',
    'authorization: Bearer ' . $token
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

curl_close($ch);

echo $response;
?>

常见问题

如何获取应用程序ID？
您可以在应用程序列表中查看每个应用的ID，链接为应用程序列表。
平台令牌的有效期是多久？
平台令牌是永久有效的，用户无需定期更新。
如何处理返回的JSON数据？
您可以根据编程语言的特性解析JSON数据，获取 remaining_amount 来了解剩余配额。

总结

通过本文的介绍，您应该能够顺利地查询Ace Data Cloud平台的剩余配额。这对于确保业务的连续性至关重要，尤其是在调用API服务时。希望您能灵活运用这个接口，确保您的业务不会因配额耗尽而受到影响。

技术标签

Ace Data Cloud
API查询
平台令牌
编程教程
数据服务