Cancel a queued asynchronous task
This document provides sample code in several common programming languages to show how to cancel a queued asynchronous task.
-
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 Cancel a Queued Asynchronous Task.
Install the SDK package
For information about the SDK dependencies for common programming languages, see the dependency import comments in the following sample code.
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
/*
Import the SDK package
The minimum required SDK version for viapi20230117 is 2.0.1.
You can find the latest SDK version in the Maven repository: 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.CancelWaitingAsyncJobResponse;
public class CancelWaitingAsyncJob {
public static com.aliyun.viapi20230117.Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
/*
Initialize the com.aliyun.teaopenapi.models.Config object.
This object stores configuration details, including your AccessKey ID, AccessKey Secret, and 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 on how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html
// The AccessKey ID and AccessKey Secret are retrieved from environment variables. Before running the sample code, make sure that you have configured the environment variables.
String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
com.aliyun.viapi20230117.Client client = CancelWaitingAsyncJob.createClient(accessKeyId, accessKeySecret);
com.aliyun.viapi20230117.models.CancelWaitingAsyncJobRequest cancelWaitingAsyncJobRequest = new com.aliyun.viapi20230117.models.CancelWaitingAsyncJobRequest()
.setJobId("F575D268-902B-50CF-933C-9FAEE96D78D3");
com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
try {
CancelWaitingAsyncJobResponse cancelWaitingAsyncJobResponse = client.cancelWaitingAsyncJobWithOptions(cancelWaitingAsyncJobRequest, runtime);
// Get the full response.
System.out.println(com.aliyun.teautil.Common.toJSONString(TeaModel.buildMap(cancelWaitingAsyncJobResponse)));
// Get a specific field from the response.
System.out.println(cancelWaitingAsyncJobResponse.getBody());
} catch (com.aliyun.tea.TeaException teaException) {
// Get the full error details.
System.out.println(com.aliyun.teautil.Common.toJSONString(teaException));
// Get a specific field from the error.
System.out.println(teaException.getCode());
}
}
}
# -*- coding: utf-8 -*-
# Import the SDK package
# The minimum required SDK version for viapi20230117 is 2.0.1.
# You can find the latest SDK version in the PyPI repository: 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 CancelWaitingAsyncJobRequest
config = Config(
# For information on how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html
# If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html
# The AccessKey ID and AccessKey Secret are retrieved from environment variables. Before running the sample code, make sure that you have configured the environment variables.
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 that corresponds to the endpoint.
region_id='cn-shanghai'
)
cancel_waiting_async_job_request = CancelWaitingAsyncJobRequest(
job_id='F575D268-902B-50CF-933C-9FAEE96D78D3'
)
runtime = RuntimeOptions()
try:
# Initialize the client.
client = Client(config)
response = client.cancel_waiting_async_job_with_options(cancel_waiting_async_job_request, runtime)
# Get the full response.
print(response.body)
except Exception as error:
# Get the full error details.
print(error)
# Get a specific field from the error.
print(error.code)
<?php
// Install the SDK package
// The minimum required SDK version for viapi20230117 is 1.0.0.
// You can find the latest SDK version in the Packagist repository: 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\CancelWaitingAsyncJobRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class CancelWaitingAsyncJob {
/**
* Initialize the client with the AccessKey ID and AccessKey Secret.
* @param string $accessKeyId
* @param string $accessKeySecret
* @return Viapi Client
*/
public static function createClient($accessKeyId, $accessKeySecret){
// Initialize the Darabonba\OpenApi\Models\Config object.
// This object stores configuration details, including your accessKeyId, accessKeySecret, and 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 on how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html
// The AccessKey ID and AccessKey Secret are retrieved from environment variables. Before running the sample code, make sure that you have configured the environment variables.
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
$accessKeySecret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
$client = self::createClient($accessKeyId, $accessKeySecret);
$cancelWaitingAsyncJobRequest = new CancelWaitingAsyncJobRequest([
"jobId" => "C9DF3928-0D19-58E1-9C82-C77F1BCFB269"
]);
$runtime = new RuntimeOptions([]);
try {
$resp = $client->cancelWaitingAsyncJobWithOptions($cancelWaitingAsyncJobRequest, $runtime);
# Print the full response.
echo Utils::toJSONString($resp->body);
} catch (Exception $exception) {
# Get the full error details.
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;
}
// The $argv array is a placeholder for command-line arguments and does not require modification in this example.
CancelWaitingAsyncJob::main(array_slice($argv, 1));
// Install the SDK package
// The minimum required SDK version for viapi20230117 is 1.0.0.
// You can find the latest SDK version in the npm repository: 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 on how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html
// The AccessKey ID and AccessKey Secret are retrieved from environment variables. Before running the sample code, make sure that you have configured the environment variables.
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 cancelWaitingAsyncJobRequest = new ViapiClient.CancelWaitingAsyncJobRequest({
jobId: "1299348D-DFF2-5FDA-8C9C-C2D14EBF63F2",
});
let runtime = new TeaUtil.RuntimeOptions({ });
client.cancelWaitingAsyncJobWithOptions(cancelWaitingAsyncJobRequest, runtime)
.then(function(response) {
// Log the full response.
console.log(response);
// Get a specific field from the response.
console.log(response.body);
}, function(error) {
// Get the full error details.
console.log(error);
// Get a specific field from the error.
console.log(error.data.Code);
})
/**
The minimum required SDK version for viapi20230117 is v2.0.1.
Depends on github.com/alibabacloud-go/viapi-20230117/v2.
We recommend running `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 on how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html
// The AccessKey ID and AccessKey Secret are retrieved from environment variables. Before running the sample code, make sure that you have configured the environment variables.
accessKeyId := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
accessKeySecret := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
// Initialize the &openapi.Config object. This object stores configuration details, including your AccessKey ID, AccessKey Secret, and 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)
}
cancelWaitingAsyncJobRequest := &viapi20230117.CancelWaitingAsyncJobRequest{
JobId: tea.String("F575D268-902B-50CF-933C-9FAEE96D78D3"),
}
runtime := &util.RuntimeOptions{}
cancelWaitingAsyncJobResponse, err := client.CancelWaitingAsyncJobWithOptions(cancelWaitingAsyncJobRequest, runtime)
if err != nil {
// Get the full error details.
fmt.Println(err.Error())
} else {
// Print the full response.
fmt.Println(cancelWaitingAsyncJobResponse)
}
}
// Install the SDK package
// The minimum required SDK version for viapi20230117 is 2.0.1.
// You can find the latest SDK version in the NuGet repository: 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 the AccessKey ID and AccessKey Secret.
* @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 on how to create an AccessKey ID and AccessKey Secret, see https://help.aliyun.com/document_detail/175144.html
// If you use a RAM user's AccessKey, you must grant the AliyunVIAPIFullAccess permission to the RAM user. For more information, see https://help.aliyun.com/document_detail/145025.html
// The AccessKey ID and AccessKey Secret are retrieved from environment variables. Before running the sample code, make sure that you have configured the environment variables.
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.CancelWaitingAsyncJobRequest cancelWaitingAsyncJobRequest = new AlibabaCloud.SDK.Viapi20230117.Models.CancelWaitingAsyncJobRequest
{
JobId = "F575D268-902B-50CF-933C-9FAEE96D78D3",
};
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
try
{
AlibabaCloud.SDK.Viapi20230117.Models.CancelWaitingAsyncJobResponse cancelWaitingAsyncJobResponse = client.CancelWaitingAsyncJobWithOptions(cancelWaitingAsyncJobRequest, runtime);
// Print the full response.
Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(cancelWaitingAsyncJobResponse.Body));
}
catch (TeaException error)
{
// Print the error details if needed.
AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
}
catch (Exception _error)
{
TeaException error = new TeaException(new Dictionary<string, object>
{
{ "message", _error.Message }
});
// Print the error details if needed.
Console.WriteLine(error.Message);
}
}
}
}