GetIqsUsage API reference

Prerequisites

You must have Python 3.8 or later installed.

Install the SDK

pip install alibabacloud_iqs20241111==1.6.4

Sample code

• Synchronous call

  import os
  
  from Tea.exceptions import TeaException
  from alibabacloud_iqs20241111 import models
  from alibabacloud_iqs20241111.client import Client
  from alibabacloud_tea_openapi import models as open_api_models
  
  
  class Sample:
      def __init__(self):
          pass
  
      @staticmethod
      def create_client() -> Client:
          config = open_api_models.Config(
              # Replace with your AccessKey ID and AccessKey secret.
              # We recommend that you load your credentials from environment variables for improved security.
             access_key_id='$YOUR_ACCESS_KEY',
             access_key_secret='$YOUR_ACCESS_SECRET'
          )
          config.endpoint = f'iqs.cn-zhangjiakou.aliyuncs.com'
          return Client(config)
  
      @staticmethod
      def main() -> None:
          client = Sample.create_client()
          get_iqs_usage_request = models.GetIqsUsageRequest(
              start_date='20250701',
              end_date='20250723'
          )
          try:
              response = client.get_iqs_usage(get_iqs_usage_request)
              print(f"api success, size :{len(response.body.records)}")
              if len(response.body.records) > 0:
                  print(f"records:{response.body.records[0]}")
              for index, item in enumerate(response.body.records):
                  print(f"{index}. {'-' * 20}")
                  print(f"api:{item.api}")
                  print(f"date:{item.date}")
                  print(f"engineType:{item.engine_type}")
                  print(f"mainAccountId:{item.main_account_id}")
                  print(f"subAccountId:{item.sub_account_id}")
                  print(f"totalCalls:{item.total_calls}")
                  print(f"successCalls:{item.success_calls}")
                  print(f"valueAddedSummary:{item.value_added_summary}")
                  print(f"valueAddedAdvanced:{item.value_added_advanced}")
  
          except TeaException as e:
              code = e.code
              request_id = e.data.get("requestId")
              message = e.data.get("message")
              print(f"api exception, requestId:{request_id}, code:{code}, message:{message}")
  
  
  if __name__ == '__main__':
      Sample.main()

• Asynchronous call

  import asyncio
  import os
  import time
  
  from Tea.exceptions import TeaException
  from alibabacloud_iqs20241111 import models
  from alibabacloud_iqs20241111.client import Client
  from alibabacloud_tea_openapi import models as open_api_models
  
  
  class Sample:
      def __init__(self):
          pass
  
      @staticmethod
      def create_client() -> Client:
          config = open_api_models.Config(
              # This example reads the AccessKey ID and AccessKey secret from environment variables.
              access_key_id=os.environ.get('ACCESS_KEY'),
              access_key_secret=os.environ.get('ACCESS_SECRET')
          )
          config.endpoint = f'iqs.cn-zhangjiakou.aliyuncs.com'
          return Client(config)
  
      @staticmethod
      async def main_async() -> None:
          start = time.time()
          client = Sample.create_client()
          get_iqs_usage_request = models.GetIqsUsageRequest(
              start_date='20250701',
              end_date='20250723'
          )
          try:
              # Use the asynchronous method.
              response = await client.get_iqs_usage_async(get_iqs_usage_request)
              print(f"api success, size :{len(response.body.records)}")
              if len(response.body.records) > 0:
                  print(f"records:{response.body.records[0]}")
              for index, item in enumerate(response.body.records):
                  print(f"{index}. {'-' * 20}")
                  print(f"api:{item.api}")
                  print(f"date:{item.date}")
                  print(f"engineType:{item.engine_type}")
                  print(f"mainAccountId:{item.main_account_id}")
                  print(f"subAccountId:{item.sub_account_id}")
                  print(f"totalCalls:{item.total_calls}")
                  print(f"successCalls:{item.success_calls}")
                  print(f"valueAddedSummary:{item.value_added_summary}")
                  print(f"valueAddedAdvanced:{item.value_added_advanced}")
          except TeaException as e:
              code = e.code
              request_id = e.data.get("requestId")
              message = e.data.get("message")
              print(f"api exception, requestId:{request_id}, code:{code}, message:{message}")
  
  if __name__ == '__main__':
      asyncio.run(Sample.main_async())

Prerequisites

You must have Java 8 or later installed.

Maven dependency

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>iqs20241111</artifactId>
  <version>1.6.4</version>
</dependency>

Sample code

package com.aliyun.iqs;
import com.aliyun.iqs20241111.Client;
import com.aliyun.iqs20241111.models.*;
import com.aliyun.teaopenapi.models.Config;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

/**
 * @author zj-407802
 * @date 2025/7/25 10:03
 * @desc
 **/
public class GetIqsUsageExample {
    public static void main(String[] args) throws Exception {
        Client client = initClient();
        invoke(client, "20250701", "20250723");
    }
    private static Client initClient() throws Exception {
        // Replace with your AccessKey ID and AccessKey secret.
        // We recommend that you load your credentials from environment variables for improved security.
        String accessKeyId = "$YOUR_ACCESS_KEY";
        String accessKeySecret = "$YOUR_ACCESS_SECRET";
        Config config = new Config()
                .setAccessKeyId(accessKeyId)
                .setAccessKeySecret(accessKeySecret);

        config.setEndpoint("iqs.cn-zhangjiakou.aliyuncs.com");
        return new Client(config);
    }
    private static void invoke(Client client, String startDate, String endDate) {
        GetIqsUsageRequest request = new GetIqsUsageRequest();
        request.setStartDate(startDate);
        request.setEndDate(endDate);

        try {
            GetIqsUsageResponse response = client.getIqsUsage(request);
            GetIqsUsageResult body = response.getBody();

            printOutput(body);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    private static void printOutput(GetIqsUsageResult output) {
        // Create a Gson instance with pretty printing using GsonBuilder.
        Gson gson = new GsonBuilder()
                .setPrettyPrinting()
                .disableHtmlEscaping()
                .create();

        // Print the formatted JSON.
        String prettyJson = gson.toJson(output);
        System.out.println(prettyJson);
    }
}

Prerequisites

You must have Go 1.10.x or later installed.

Install the SDK

require (
  github.com/alibabacloud-go/iqs-20241111 v1.6.4
  github.com/alibabacloud-go/darabonba-openapi/v2 v2.0.10
)

Sample code

package main

import (
	"fmt"
	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	iqs20241111 "github.com/alibabacloud-go/iqs-20241111/client"
	util "github.com/alibabacloud-go/tea-utils/v2/service"
	"github.com/alibabacloud-go/tea/tea"
	"log"
)

const endpointURL = "iqs.cn-zhangjiakou.aliyuncs.com"


func createClient() (*iqs20241111.Client, error) {
	// Replace with your AccessKey ID and AccessKey secret.
	accessKeyID := "YOUR_ACCESS_KEY"
	accessKeySecret := "YOUR_ACCESS_SECRET"

	if accessKeyID == "" || accessKeySecret == "" {
		return nil, fmt.Errorf("ACCESS_KEY or ACCESS_SECRET environment variable is not set")
	}

	config := &openapi.Config{
		AccessKeyId:     tea.String(accessKeyID),
		AccessKeySecret: tea.String(accessKeySecret),
		Endpoint:        tea.String(endpointURL),
	}

	return iqs20241111.NewClient(config)
}

func runGetIqsUsage(client *iqs20241111.Client) error {
	request := &iqs20241111.GetIqsUsageRequest{
		StartDate: tea.String("20250610"),
		EndDate:   tea.String("20250723"),
	}
	runtime := &util.RuntimeOptions{}

	resp, err := client.GetIqsUsageWithOptions(request, nil, runtime)
	if err != nil {
		return fmt.Errorf("GetIqsUsage failed: %w", err)
	}

	fmt.Printf("response: %s\n", resp.Body)
	return nil
}

func main() {
	client, err := createClient()
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}

	if err := runGetIqsUsage(client); err != nil {
		log.Fatalf("Error running GetIqsUsage: %v", err)
	}
}

}