取消排队中异步任务常用语言和示例代码_视觉智能开放平台(VIAPI)-阿里云帮助中心

本文档为您介绍取消排队中异步任务常用语言和常见情况的示例代码。

说明

您可以进入在线咨询获取在线人工帮助。
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。

能力介绍

关于取消排队中异步任务的功能介绍以及具体调用参数说明，请参见取消排队中异步任务。

SDK包安装

常见语言的SDK依赖包信息，请参见下文示例代码中的引入依赖包注释部分。

配置环境变量

配置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。

重要

阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维，具体操作，请参见创建RAM用户。
请不要将AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。

Linux和macOS系统配置方法
1. 在IntelliJ IDEA中打开终端Terminal。
2. 执行以下命令，配置环境变量。
  <access_key_id>需替换为您RAM用户的AccessKey ID，<access_key_secret>替换为您RAM用户的AccessKey Secret。如果后续需要进行更多权限相关的配置，具体操作请参见使用RAM Policy控制访问权限。
```
export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> 
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
```
Windows系统配置方法
新建环境变量文件，添加环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET，并写入已准备好的AccessKey ID和AccessKey Secret。然后重启Windows系统。本操作以Windows 10为例进行说明。
1. 打开文件资源管理器，在此电脑上右键单击属性。
2. 在右侧导航栏，单击高级系统配置。
3. 在系统属性对话框的高级页签下，单击环境变量。
4. 在环境变量对话框中，单击新建(W)。
5. 在弹出的新建系统变量对话框中，添加环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET，并写入已准备好的AccessKey ID和AccessKey Secret。
6. 重启Windows系统，使配置生效。

示例代码

Java

/*
引入依赖包
最低SDK版本要求：viapi20230117的SDK版本需大于等于2.0.1。
可以在此仓库地址中引用最新版本SDK：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 {
        /*
          初始化配置对象com.aliyun.teaopenapi.models.Config
          Config对象存放 AccessKeyId、AccessKeySecret、endpoint等配置
         */
         com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                .setAccessKeyId(accessKeyId)
                .setAccessKeySecret(accessKeySecret);
        // 访问的域名
        config.endpoint = "viapi.cn-shanghai.aliyuncs.com";
        return new com.aliyun.viapi20230117.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        // 创建AccessKey ID和AccessKey Secret，请参考https://help.aliyun.com/document_detail/175144.html
        // 如果您使用的是RAM用户的AccessKey，还需要为子账号授予权限AliyunVIAPIFullAccess，请参考https://help.aliyun.com/document_detail/145025.html
        // 从环境变量读取配置的AccessKey ID和AccessKey Secret。运行代码示例前必须先配置环境变量。
        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);
            // 获取整体结果。
            System.out.println(com.aliyun.teautil.Common.toJSONString(TeaModel.buildMap(cancelWaitingAsyncJobResponse)));
            // 获取单个字段。
            System.out.println(cancelWaitingAsyncJobResponse.getBody());
        } catch (com.aliyun.tea.TeaException teaException) {
            // 获取整体报错信息。
            System.out.println(com.aliyun.teautil.Common.toJSONString(teaException));
            // 获取单个字段。
            System.out.println(teaException.getCode());
        }
    }
}

Python

# -*- coding: utf-8 -*-
# 引入依赖包
# 最低SDK版本要求：viapi20230117的SDK版本需大于等于2.0.1。
# 可以在此仓库地址中引用最新版本SDK：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(
  # 创建AccessKey ID和AccessKey Secret，请参考https://help.aliyun.com/document_detail/175144.html
  # 如果您用的是RAM用户的AccessKey，还需要为RAM用户授予权限AliyunVIAPIFullAccess，请参考https://help.aliyun.com/document_detail/145025.html
  # 从环境变量读取配置的AccessKey ID和AccessKey Secret。运行代码示例前必须先配置环境变量。
  access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
  access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
  # 访问的域名
  endpoint='viapi.cn-shanghai.aliyuncs.com',
  # 访问的域名对应的region
  region_id='cn-shanghai'
)
cancel_waiting_async_job_request = CancelWaitingAsyncJobRequest(
   job_id='F575D268-902B-50CF-933C-9FAEE96D78D3'
)
runtime = RuntimeOptions()
try:
  # 初始化Client
  client = Client(config)
  response = client.cancel_waiting_async_job_with_options(cancel_waiting_async_job_request, runtime)
  # 获取整体结果
  print(response.body)
except Exception as error:
  # 获取整体报错信息
  print(error)
  # 获取单个字段
  print(error.code)

PHP

<?php

//安装依赖包
//最低SDK版本要求：viapi20230117的SDK版本需大于等于1.0.0。
//可以在此仓库地址中引用最新版本SDK：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 {

    /**
     * 使用AK&SK初始化账号Client
     * @param string $accessKeyId
     * @param string $accessKeySecret
     * @return Viapi Client
     */
    public static function createClient($accessKeyId, $accessKeySecret){
        //初始化配置对象Darabonba\OpenApi\Models\Config。
        //Config对象存放accessKeyId、accessKeySecret、endpoint等配置
        $config = new Config([
            "accessKeyId" => $accessKeyId,
            "accessKeySecret" => $accessKeySecret
        ]);
        // 访问的域名
        $config->endpoint = "viapi.cn-shanghai.aliyuncs.com";
        return new Viapi($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        // 创建AccessKey ID和AccessKey Secret，请参考https://help.aliyun.com/document_detail/175144.html
        // 如果您使用的是RAM用户的AccessKey，还需要为子账号授予权限AliyunVIAPIFullAccess，请参考https://help.aliyun.com/document_detail/145025.html
        // 从环境变量读取配置的AccessKey ID和AccessKey Secret。运行代码示例前必须先配置环境变量。
        $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);
            # 获取整体结果
            echo Utils::toJSONString($resp->body);
        } catch (Exception $exception) {
            # 获取整体报错信息
            echo Utils::toJSONString($exception);
            # 获取单个字段
            echo $exception->getCode();
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
//$argv是预留的数组入参参数，无实际意义，无需进行修改
CancelWaitingAsyncJob::main(array_slice($argv, 1));

Node.js

// 安装依赖包
// 最低SDK版本要求：viapi20230117的SDK版本需大于等于1.0.0。
// 可以在此仓库地址中引用最新版本SDK：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({
  // 创建AccessKey ID和AccessKey Secret，请参考https://help.aliyun.com/document_detail/175144.html。
  // 如果您用的是RAM用户AccessKey，还需要为RAM用户授予权限AliyunVIAPIFullAccess，请参考https://help.aliyun.com/document_detail/145025.html。
  // 从环境变量读取配置的AccessKey ID和AccessKey Secret。运行示例前必须先配置环境变量。 
  accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,   
  accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET
});
// 访问的域名
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) {
    // 获取整体结果
    console.log(getAsyncJobResultResponse);
    // 获取单个字段
    console.log(getAsyncJobResultResponse.body.data);
  }, function(error) {
    // 获取整体报错信息
    console.log(error);
    // 获取单个字段
    console.log(error.data.Code);
  })

/**
最低SDK版本要求：viapi20230117的SDK版本需大于等于v2.0.1。
依赖github.com/alibabacloud-go/viapi-20230117/v2
建议使用go mod tidy安装依赖
*/

package main

import (
	"fmt"
	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() {
  // 从环境变量读取配置的AccessKey ID
  // 运行示例前必须先配置环境变量  
  // 创建AccessKey ID和AccessKey Secret，请参考https://help.aliyun.com/document_detail/175144.html。
  // 如果您用的是RAM用户的AccessKey，还需要为RAM用户授予权限AliyunVIAPIFullAccess，请参考https://help.aliyun.com/document_detail/145025.html。
  // 从环境变量读取配置的AccessKey ID和AccessKey Secret。运行示例前必须先配置环境变量。  
  accessKeyId := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")  
  accessKeySecret := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
  // 初始化配置对象 &openapi.Config。Config对象存放AccessKeyId、AccessKeySecret、Endpoint等配置。
  config := &openapi.Config{
    AccessKeyId: tea.String(accessKeyId),
    AccessKeySecret: tea.String(accessKeySecret)
	}
	// 访问的域名
	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 {
		// 获取整体报错信息
		fmt.Println(err.Error())
	} else {
		// 获取整体结果
		fmt.Println(cancelWaitingAsyncJobResponse)
	}
}

// 安装依赖包
// 最低SDK版本要求：viapi20230117的SDK版本需大于等于2.0.1。
// 可以在此仓库地址中引用最新版本SDK：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
    {
        /**
            * 使用AK&SK初始化账号Client
            * @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,
            };
            // 访问的域名
            config.Endpoint = "viapi.cn-shanghai.aliyuncs.com";
            return new AlibabaCloud.SDK.Viapi20230117.Client(config);
        }
        public static void Main(string[] args)
        {
            // 创建AccessKey ID和AccessKey Secret，请参考https://help.aliyun.com/document_detail/175144.html
            // 如果您使用的是RAM用户的AccessKey，还需要为子账号授予权限AliyunVIAPIFullAccess，请参考https://help.aliyun.com/document_detail/145025.html
            // 从环境变量读取配置的AccessKey ID和AccessKey Secret。运行代码示例前必须先配置环境变量。
            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);
                // 获取整体结果
                Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(cancelWaitingAsyncJobResponse.Body));
            }
            catch (TeaException error)
            {
                // 如有需要，请打印 error
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
            catch (Exception _error)
            {
                TeaException error = new TeaException(new Dictionary<string, object>
                {
                    { "message", _error.Message }
                });
                // 如有需要，请打印 error
                Console.WriteLine(error.Message);
            }
        }
    }
}