Query asynchronous task results

更新时间:
复制 MD 格式

This document provides sample code in common programming languages for querying asynchronous task results.

Note
  • 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 a functional overview and detailed parameter descriptions, see Query asynchronous task results.

Install the SDK package

For the required dependencies in common languages, see the Add dependency comments in the sample code.

Configure environment variables

Configure the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.

Important
  • 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

    1. Open a terminal in IntelliJ IDEA.

    2. 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_ID and ALIBABA_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.

    1. Open File Explorer, right-click This PC, and then select Properties.

    2. In the left-side navigation pane, click Advanced system settings.

    3. On the Advanced tab of the System Properties dialog box, click Environment Variables.

    4. In the Environment Variables dialog box, click New.

    5. In the New System Variable dialog box, add the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET, and set them to the AccessKey ID and AccessKey Secret that you have prepared.

    6. 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 or later.
For the latest version, see: 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.GetAsyncJobResultResponse;

public class GetAsyncJobResult {
    public static com.aliyun.viapi20230117.Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
        /*
          Initialize a com.aliyun.teaopenapi.models.Config object.
          Use this object to set configuration parameters, such as your AccessKey ID, AccessKey Secret, and service endpoint.
         */
         com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                .setAccessKeyId(accessKeyId)
                .setAccessKeySecret(accessKeySecret);
        // The service endpoint.
        config.endpoint = "viapi.cn-shanghai.aliyuncs.com";
        return new com.aliyun.viapi20230117.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        // For information about how to create an AccessKey ID and an AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
        // If you use a RAM user's AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
        // Read the AccessKey ID and AccessKey Secret from environment variables. 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 = GetAsyncJobResult.createClient(accessKeyId, accessKeySecret);
        com.aliyun.viapi20230117.models.GetAsyncJobResultRequest getAsyncJobResultRequest = new com.aliyun.viapi20230117.models.GetAsyncJobResultRequest()
                .setJobId("1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2");
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            GetAsyncJobResultResponse getAsyncJobResultResponse = client.getAsyncJobResultWithOptions(getAsyncJobResultRequest, runtime);
            // Get the full response.
            System.out.println(com.aliyun.teautil.Common.toJSONString(TeaModel.buildMap(getAsyncJobResultResponse)));
            // Get a specific field from the response.
            System.out.println(getAsyncJobResultResponse.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 or later.
# For the latest version, see: 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 GetAsyncJobResultRequest

config = Config(
  # For information about how to create an AccessKey ID and an AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
  # If you use a RAM user's AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
  # Read the AccessKey ID and AccessKey Secret from environment variables. 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 service endpoint.
  endpoint='viapi.cn-shanghai.aliyuncs.com',
  # The region ID.
  region_id='cn-shanghai'
)
get_async_job_result_request = GetAsyncJobResultRequest(
    job_id='1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2'
)
runtime = RuntimeOptions()
try:
  # Initialize the client.
  client = Client(config)
  response = client.get_async_job_result_with_options(get_async_job_result_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 or later.
// For the latest version, see: 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\GetAsyncJobResultRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class GetAsyncJobResult {

    /**
     * Initialize the client with AccessKey credentials.
     * @param string $accessKeyId
     * @param string $accessKeySecret
     * @return Viapi Client
     */
    public static function createClient($accessKeyId, $accessKeySecret){
        // Initialize a Darabonba\OpenApi\Models\Config object.
        // Use this object to set configuration parameters, such as your accessKeyId, accessKeySecret, and service endpoint.
        $config = new Config([
            "accessKeyId" => $accessKeyId,
            "accessKeySecret" => $accessKeySecret
        ]);
        // The service endpoint.
        $config->endpoint = "viapi.cn-shanghai.aliyuncs.com";
        return new Viapi($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        // For information about how to create an AccessKey ID and an AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
        // If you use a RAM user's AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
        // Read the AccessKey ID and AccessKey Secret from environment variables. 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);
        $getAsyncJobResultRequest = new GetAsyncJobResultRequest([
            "jobId" => "C9DF3928-0D19-58E1-9C82-C77F1BCFB269"
        ]);
        $runtime = new RuntimeOptions([]);
        try {
            $resp = $client->getAsyncJobResultWithOptions($getAsyncJobResultRequest, $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 command-line arguments. This line is boilerplate and does not require modification.
GetAsyncJobResult::main(array_slice($argv, 1));
// Add the dependency.
// The minimum required SDK version for viapi20230117 is 1.0.0 or later.
// For the latest version, see: 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({
  // For information about how to create an AccessKey ID and an AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
  // If you use a RAM user's AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
  // Read the AccessKey ID and AccessKey Secret from environment variables. 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 service endpoint.
config.endpoint = `viapi.cn-shanghai.aliyuncs.com`;
const client = new ViapiClient.default(config);
let getAsyncJobResultRequest = new ViapiClient.GetAsyncJobResultRequest({
  jobId: "1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2",
});
let runtime = new TeaUtil.RuntimeOptions({ });
client.getAsyncJobResultWithOptions(getAsyncJobResultRequest, runtime)
  .then(function(getAsyncJobResultResponse) {
    // Get the full response.
    console.log(getAsyncJobResultResponse);
    // Get a specific field from the response.
    console.log(getAsyncJobResultResponse.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.
The minimum required SDK version for viapi20230117 is v2.0.1 or later.
Dependency: github.com/alibabacloud-go/viapi-20230117/v2
We recommend that you run `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() {
  // For information about how to create an AccessKey ID and an AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
  // If you use a RAM user's AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
  // Read the AccessKey ID and AccessKey Secret from environment variables. 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")
  // Initialize an &openapi.Config object. 
  // Use this object to set configuration parameters, such as your AccessKey ID, AccessKey Secret, and service endpoint.
	config := &openapi.Config{
		AccessKeyId: tea.String(accessKeyId),
		AccessKeySecret: tea.String(accessKeySecret),
	}
	// The service endpoint.
	config.Endpoint = tea.String("viapi.cn-shanghai.aliyuncs.com")
	client, err := viapi20230117.NewClient(config)
	if err != nil {
		panic(err)
	}
	getAsyncJobResultRequest := &viapi20230117.GetAsyncJobResultRequest{
		JobId: tea.String("1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2"),
	}
	runtime := &util.RuntimeOptions{}
	getAsyncJobResultResponse, err := client.GetAsyncJobResultWithOptions(getAsyncJobResultRequest, runtime)
	if err != nil {
		// Get the full error message.
		fmt.Println(err.Error())
	} else {
		// Get the full response.
		fmt.Println(getAsyncJobResultResponse)
	}
}
// Add the dependency.
// The minimum required SDK version for viapi20230117 is 2.0.1 or later.
// For the latest version, see: 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.Drawing;
using System.IO;
using System.Net;
using System.Threading.Tasks;
using AlibabaCloud.SDK.Viapi20230117.Models;
using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample
    {
        /**
            * Initialize the client with AccessKey credentials.
            * @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 service endpoint.
            config.Endpoint = "viapi.cn-shanghai.aliyuncs.com";
            return new AlibabaCloud.SDK.Viapi20230117.Client(config);
        }
        public static void Main(string[] args)
        {
            // For information about how to create an AccessKey ID and an AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html.
            // If you use a RAM user's AccessKey, grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html.
            // Read the AccessKey ID and AccessKey Secret from environment variables. 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.GetAsyncJobResultRequest getAsyncJobResultRequest = new AlibabaCloud.SDK.Viapi20230117.Models.GetAsyncJobResultRequest
            {
                JobId = "1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2",
            };
            AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
            try
            {
                AlibabaCloud.SDK.Viapi20230117.Models.GetAsyncJobResultResponse getAsyncJobResultResponse = client.GetAsyncJobResultWithOptions(getAsyncJobResultRequest, runtime);
                // Get the full response.
                Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(getAsyncJobResultResponse.Body));
                // Get a specific field from the response.
                Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(getAsyncJobResultResponse.Body.Data));
            }
            catch (TeaException error)
            {
                // Print the error if necessary.
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
            catch (Exception _error)
            {
                TeaException error = new TeaException(new Dictionary<string, object>
                {
                    { "message", _error.Message }
                });
                // Print the error if necessary.
                Console.WriteLine(error.Message);
            }
        }
    }
}