Query asynchronous jobs
This document provides sample code in popular programming languages to show how to query asynchronous jobs.
-
For real-time assistance, start an online consultation.
-
If you have questions about API access or usage for the Alibaba Cloud Vision AI Platform, join our DingTalk group (ID: 23109592) to contact us.
Overview
For an overview of the QueryAsyncJobList API and a description of its parameters, see QueryAsyncJobList.
Install the SDK package
For the required SDK dependency packages, see the installation comments in the sample code for your language.
Configure environment variables
Configure the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.
An Alibaba Cloud account has full access to all API operations. We recommend that you use a RAM user for API calls or routine O&M. For more information, see Create a RAM user.
Do not save your AccessKey ID or AccessKey Secret in project code. Otherwise, the AccessKey pair may be leaked and the security of all resources in your account may be compromised.
Configure environment variables on Linux and macOS
Open a terminal in IntelliJ IDEA.
Run the following commands to configure the environment variables.
Replace
<access_key_id>with the AccessKey ID of your RAM user and<access_key_secret>with the AccessKey Secret of your RAM user. If you need to configure more permissions, see Control access permissions using a RAM policy.export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
Configure environment variables on Windows
Create a new environment variable file, add the environment variables
ALIBABA_CLOUD_ACCESS_KEY_IDandALIBABA_CLOUD_ACCESS_KEY_SECRET, and set them to the AccessKey ID and AccessKey Secret that you have prepared. Then, restart the Windows operating system. The following example uses Windows 10.Open File Explorer, right-click This PC, and then select Properties.
In the left-side navigation pane, click Advanced system settings.
On the Advanced tab of the System Properties dialog box, click Environment Variables.
In the Environment Variables dialog box, click New.
In the New System Variable dialog box, add the environment variables
ALIBABA_CLOUD_ACCESS_KEY_IDandALIBABA_CLOUD_ACCESS_KEY_SECRET, and set them to the AccessKey ID and AccessKey Secret that you have prepared.Restart the Windows operating system for the configurations to take effect.
Sample code
/*
Add the dependency.
The minimum required SDK version for viapi20230117 is 2.0.1.
For the latest version, see the repository at: https://mvnrepository.com/artifact/com.aliyun/viapi20230117
<!-- https://mvnrepository.com/artifact/com.aliyun/viapi20230117 -->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>viapi20230117</artifactId>
<version>${aliyun.viapi.version}</version>
</dependency>
*/
import com.aliyun.tea.TeaModel;
import com.aliyun.viapi20230117.models.QueryAsyncJobListResponse;
public class QueryAsyncJobList {
public static com.aliyun.viapi20230117.Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
/*
Initializes the configuration object com.aliyun.teaopenapi.models.Config.
This object stores configuration parameters such as your AccessKey ID, AccessKey Secret, and API endpoint.
*/
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
.setAccessKeyId(accessKeyId)
.setAccessKeySecret(accessKeySecret);
// The API endpoint.
config.endpoint = "viapi.cn-shanghai.aliyuncs.com";
return new com.aliyun.viapi20230117.Client(config);
}
public static void main(String[] args_) throws Exception {
// 1. To get your AccessKey pair, see https://help.aliyun.com/document_detail/175144.html
// 2. If you are using a RAM user's AccessKey, you must grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html
// 3. Set the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET. You must configure the environment variables before running this sample code.
String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
com.aliyun.viapi20230117.Client client = QueryAsyncJobList.createClient(accessKeyId, accessKeySecret);
com.aliyun.viapi20230117.models.QueryAsyncJobListRequest queryAsyncJobListRequest = new com.aliyun.viapi20230117.models.QueryAsyncJobListRequest()
.setJobId("1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2")
.setStartTime("2023-02-23 00:00:00")
.setEndTime("2023-02-23 23:00:00");
com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
try {
QueryAsyncJobListResponse queryAsyncJobListResponse = client.queryAsyncJobListWithOptions(queryAsyncJobListRequest, runtime);
// Get the full response.
System.out.println(com.aliyun.teautil.Common.toJSONString(TeaModel.buildMap(queryAsyncJobListResponse)));
// Get a specific field from the response.
System.out.println(queryAsyncJobListResponse.getBody());
} catch (com.aliyun.tea.TeaException teaException) {
// Get the full error message.
System.out.println(com.aliyun.teautil.Common.toJSONString(teaException));
// Get a specific field from the error.
System.out.println(teaException.getCode());
}
}
}
# -*- coding: utf-8 -*-
# Add the dependency.
# The minimum required SDK version for viapi20230117 is 2.0.1.
# For the latest version, see the repository at: https://pypi.org/project/alibabacloud-viapi20230117/
# pip install alibabacloud_viapi20230117
import os
from alibabacloud_tea_openapi.models import Config
from alibabacloud_tea_util.models import RuntimeOptions
from alibabacloud_viapi20230117.client import Client
from alibabacloud_viapi20230117.models import QueryAsyncJobListRequest
config = Config(
# 1. To get your AccessKey pair, see https://help.aliyun.com/document_detail/175144.html
# 2. If you are using a RAM user's AccessKey, you must grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html
# 3. Set the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET. You must configure the environment variables before running this sample code.
access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
# The API endpoint.
endpoint='viapi.cn-shanghai.aliyuncs.com',
# The region ID for the endpoint.
region_id='cn-shanghai'
)
query_async_job_list_request = QueryAsyncJobListRequest(
start_time='2023-02-23 00:00:00',
end_time='2023-02-23 23:00:00',
job_id='1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2'
)
runtime = RuntimeOptions()
try:
# Initialize the client.
client = Client(config)
response = client.query_async_job_list_with_options(query_async_job_list_request, runtime)
# Get the full response.
print(response.body)
except Exception as error:
# Get the full error message.
print(error)
# Get a specific field from the error.
print(error.code)
<?php
// Add the dependency.
// The minimum required SDK version for viapi20230117 is 1.0.0.
// For the latest version, see the repository at: https://packagist.org/packages/alibabacloud/viapi-20230117
// composer require alibabacloud/viapi-20230117
use AlibabaCloud\SDK\Viapi\V20230117\Viapi;
use \Exception;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Viapi\V20230117\Models\QueryAsyncJobListRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class QueryAsyncJobList {
/**
* Initializes the client by using an AccessKey pair.
* @param string $accessKeyId
* @param string $accessKeySecret
* @return Viapi Client
*/
public static function createClient($accessKeyId, $accessKeySecret){
// Initializes the configuration object Darabonba\OpenApi\Models\Config.
// This object stores configuration parameters such as your accessKeyId, accessKeySecret, and API endpoint.
$config = new Config([
"accessKeyId" => $accessKeyId,
"accessKeySecret" => $accessKeySecret
]);
// The API endpoint.
$config->endpoint = "viapi.cn-shanghai.aliyuncs.com";
return new Viapi($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
// 1. To get your AccessKey pair, see https://help.aliyun.com/document_detail/175144.html
// 2. If you are using a RAM user's AccessKey, you must grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html
// 3. Set the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET. You must configure the environment variables before running this sample code.
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
$accessKeySecret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
$client = self::createClient($accessKeyId, $accessKeySecret);
$queryAsyncJobListRequest = new QueryAsyncJobListRequest([
"startTime" => "2023-02-27 00:00:00",
"endTime" => "2023-02-27 23:00:00"
]);
$runtime = new RuntimeOptions([]);
try {
$resp = $client->queryAsyncJobListWithOptions($queryAsyncJobListRequest, $runtime);
# Get the full response.
echo Utils::toJSONString($resp->body);
} catch (Exception $exception) {
# Get the full error message.
echo Utils::toJSONString($exception);
# Get a specific field from the error.
echo $exception->getCode();
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
// $argv is a reserved array for input arguments and does not need to be modified.
QueryAsyncJobList::main(array_slice($argv, 1));
// Add the dependency.
// The minimum required SDK version for viapi20230117 is 1.0.0.
// For the latest version, see the repository at: https://www.npmjs.com/package/@alicloud/viapi20230117
// npm install @alicloud/viapi20230117
const ViapiClient = require('@alicloud/viapi20230117');
const OpenapiClient = require('@alicloud/openapi-client');
const TeaUtil = require('@alicloud/tea-util');
let config = new OpenapiClient.Config({
// 1. To get your AccessKey pair, see https://help.aliyun.com/document_detail/175144.html
// 2. If you are using a RAM user's AccessKey, you must grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html
// 3. Set the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET. You must configure the environment variables before running this sample code.
accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,
accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET
});
// The API endpoint.
config.endpoint = `viapi.cn-shanghai.aliyuncs.com`;
const client = new ViapiClient.default(config);
let queryAsyncJobListRequest = new ViapiClient.QueryAsyncJobListRequest({
startTime: "2023-02-23 00:00:00",
endTime: "2023-02-23 23:00:00",
jobId: "1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2",
});
let runtime = new TeaUtil.RuntimeOptions({ });
client.queryAsyncJobListWithOptions(queryAsyncJobListRequest, runtime)
.then(function(queryAsyncJobListResponse) {
// Get the full response.
console.log(queryAsyncJobListResponse);
// Get a specific field from the response.
console.log(queryAsyncJobListResponse.body.data);
}, function(error) {
// Get the full error message.
console.log(error);
// Get a specific field from the error.
console.log(error.data.Code);
})
/**
Add the dependency: github.com/alibabacloud-go/viapi-20230117/v2
The minimum required SDK version for viapi20230117 is v2.0.1.
We recommend using 'go mod tidy' to install dependencies.
*/
package main
import (
"fmt"
"os"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
util "github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
viapi20230117 "github.com/alibabacloud-go/viapi-20230117/v2/client"
)
func main() {
// 1. To get your AccessKey pair, see https://help.aliyun.com/document_detail/175144.html
// 2. If you are using a RAM user's AccessKey, you must grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html
// 3. Set the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET. You must configure the environment variables before running this sample code.
accessKeyId := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
accessKeySecret := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
// Initializes an `openapi.Config` object.
// This object stores configuration parameters such as your AccessKey ID, AccessKey Secret, and API endpoint.
config := &openapi.Config{
AccessKeyId: tea.String(accessKeyId),
AccessKeySecret: tea.String(accessKeySecret)
}
// The API endpoint.
config.Endpoint = tea.String("viapi.cn-shanghai.aliyuncs.com")
client, err := viapi20230117.NewClient(config)
if err != nil {
panic(err)
}
queryAsyncJobListRequest := &viapi20230117.QueryAsyncJobListRequest{
StartTime: tea.String("2023-02-23 00:00:00"),
EndTime: tea.String("2023-02-23 23:00:00"),
JobId: tea.String("1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2"),
}
runtime := &util.RuntimeOptions{}
queryAsyncJobListResponse, err := client.QueryAsyncJobListWithOptions(queryAsyncJobListRequest, runtime)
if err != nil {
// Get the full error message.
fmt.Println(err.Error())
} else {
// Get the full response.
fmt.Println(queryAsyncJobListResponse)
}
}
// Add the dependency.
// The minimum required SDK version for viapi20230117 is 2.0.1.
// For the latest version, see the repository at: https://www.nuget.org/packages/AlibabaCloud.SDK.Viapi20230117
// dotnet add package AlibabaCloud.SDK.Viapi20230117
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using AlibabaCloud.SDK.Viapi20230117.Models;
using Tea;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* Initializes the client by using an AccessKey pair.
* @param accessKeyId
* @param accessKeySecret
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Viapi20230117.Client CreateClient(string accessKeyId, string accessKeySecret)
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
{
AccessKeyId = accessKeyId,
AccessKeySecret = accessKeySecret,
};
// The API endpoint.
config.Endpoint = "viapi.cn-shanghai.aliyuncs.com";
return new AlibabaCloud.SDK.Viapi20230117.Client(config);
}
public static void Main(string[] args)
{
// 1. To get your AccessKey pair, see https://help.aliyun.com/document_detail/175144.html
// 2. If you are using a RAM user's AccessKey, you must grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html
// 3. Set the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET. You must configure the environment variables before running this sample code.
AlibabaCloud.SDK.Viapi20230117.Client client = CreateClient(System.Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"), System.Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
AlibabaCloud.SDK.Viapi20230117.Models.QueryAsyncJobListRequest queryAsyncJobListRequest = new AlibabaCloud.SDK.Viapi20230117.Models.QueryAsyncJobListRequest
{
StartTime = "2023-02-23 00:00:00",
EndTime = "2023-02-23 23:00:00",
JobId = "1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2",
};
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
try
{
AlibabaCloud.SDK.Viapi20230117.Models.QueryAsyncJobListResponse queryAsyncJobListResponse = client.QueryAsyncJobListWithOptions(queryAsyncJobListRequest, runtime);
// Get the full response.
Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(queryAsyncJobListResponse.Body));
// Get a specific field from the response.
Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(queryAsyncJobListResponse.Body.Data));
}
catch (TeaException error)
{
// Handle API exceptions.
Console.WriteLine(error.Message);
}
catch (Exception _error)
{
// Handle other exceptions.
TeaException error = new TeaException(new Dictionary<string, object>
{
{ "message", _error.Message }
});
Console.WriteLine(error.Message);
}
}
}
}