Alibaba Cloud SDK:Configurar um endpoint

Este tópico descreve como configurar um endpoint no Alibaba Cloud Darabonba SDK.

O Darabonba SDK permite especificar o endpoint de destino das requisições de API de duas formas. A lista a seguir descreve os modos por ordem decrescente de prioridade:

1. Endpoint definido pelo usuário: neste modo, especifique um endpoint exato ao inicializar um cliente do SDK. Consulte o endpoint no

   OpenAPI Explorer. Para mais informações sobre como consultar um endpoint no OpenAPI Explorer, veja a seção "Consultar um endpoint" deste tópico. O exemplo a seguir mostra como especificar um endpoint definido pelo usuário em TypeScript:

   import * as $OpenApi from '@alicloud/openapi-client';
   
   export default class Client {
     static async main(): Promise<void> {
       const config = new $OpenApi.Config({
         // Omit the credential configuration.
         // The endpoint that you want to specify.
         endpoint: 'Endpoint'
       });
     }
   }

   O exemplo a seguir mostra como especificar um endpoint definido pelo usuário em JavaScript:

   const { Config } = require('@alicloud/openapi-client');
   
   async function main() {
     const config = new Config({
       // Omit the credential configuration.
       // The endpoint that you want to specify.
       endpoint: 'Endpoint'
     });
   }

1. Endpoint concatenado: neste modo, defina um ID de região para que o Darabonba SDK gere o endpoint automaticamente. Essa opção funciona apenas se o SDK do serviço da Alibaba Cloud possuir um arquivo de dados de endpoints. Caso contrário, o sistema lança uma exceção e retorna a mensagem de erro config.endpoint can not be empty durante a inicialização do cliente do SDK. Nessa situação, especifique um endpoint exato. Para ver um exemplo de arquivo de dados de endpoints, consulte Arquivo de dados de endpoints do ECS. Se a região desejada não constar no arquivo de dados, o endpoint correspondente será gerado no formato ${Code of the Alibaba Cloud service}.${Region ID}.aliyuncs.com. O exemplo a seguir demonstra como especificar um endpoint concatenado em TypeScript:

   import * as $OpenApi from '@alicloud/openapi-client';
   
   export default class Client {
     static async main(): Promise<void> {
       const config = new $OpenApi.Config({
         // Omit the credential configuration.
         // The region that you want to access.
         regionId: 'RegionId'
       });
     }
   }

O exemplo a seguir demonstra como especificar um endpoint concatenado em JavaScript:

const { default: Ecs20140526 } = require('@alicloud/ecs20140526');
const { Config } = require('@alicloud/openapi-client');
async function main() {
  const config = new Config({
    // Omit the credential configuration.
    // The region that you want to access.
    regionId: 'RegionId'
  });
}

É possível definir dois tipos de endpoint para upload de arquivos no Darabonba SDK.

• Endpoint da plataforma aberta usado para autenticação. Configure um endpoint de Virtual Private Cloud (VPC) para solicitar informações de autenticação via VPC. Essas credenciais são necessárias para fazer upload de arquivos. O exemplo a seguir ilustra a configuração do endpoint da plataforma aberta em TypeScript:

  import Facebody20191230, * as $Facebody20191230 from '@alicloud/facebody20191230';
  import * as $OpenApi from '@alicloud/openapi-client';
  import * as $Util from '@alicloud/tea-util';
  import { createReadStream } from 'fs';
  
  export default class Client {
    static async main(): Promise<void> {
      const config = new $OpenApi.Config({
        // Omit the credential configuration.
        // The region that you want to access.
        regionId: 'RegionId',
        // The endpoint of the open platform.
        openPlatformEndpoint: 'openplatform-vpc.cn-shanghai.aliyuncs.com'
      });
      const client = new Facebody20191230(config);
      const request = new $Facebody20191230.DetectBodyCountAdvanceRequest({
        imageURLObject: createReadStream("The directory of the file that you want to upload on your computer"),
      });
      // Create a RuntimeObject instance and configure runtime parameters. 
      const runtime = new $Util.RuntimeOptions({});
      const resp = await client.DetectBodyCountAdvance(request, runtime);
      console.log(resp.headers);
      console.log(resp.body);
    }
  }

  O exemplo a seguir ilustra a configuração do endpoint da plataforma aberta em JavaScript:

  const { default: Facebody20191230, DetectBodyCountAdvanceRequest } = require('@alicloud/facebody20191230');
  const { Config } = require('@alicloud/openapi-client');
  const { RuntimeOptions } = require('@alicloud/tea-util');
  const { createReadStream } = require('fs');
  
  async function main() {
    const config = new Config({
      // Omit the credential configuration.
      // The region that you want to access.
      regionId: 'RegionId',
      // The endpoint of the open platform.
      openPlatformEndpoint: 'openplatform-vpc.cn-shanghai.aliyuncs.com'
    });
    const client = new Facebody20191230(config);
    const request = new DetectBodyCountAdvanceRequest({
      imageURLObject: createReadStream("The directory of the file that you want to upload on your computer"),
    });
    // Create a RuntimeObject instance and configure runtime parameters. 
    const runtime = new RuntimeOptions({});
    const resp = await client.DetectBodyCountAdvance(request, runtime);
    console.log(resp.headers);
    console.log(resp.body);
  }

• Endpoint utilizado para o upload do arquivo. Defina um endpoint interno para transferir o arquivo por uma rede interna ou VPC. O exemplo a seguir demonstra essa configuração em TypeScript:

  import Facebody20191230, * as $Facebody20191230 from '@alicloud/facebody20191230';
  import * as $OpenApi from '@alicloud/openapi-client';
  import * as $Util from '@alicloud/tea-util';
  import { createReadStream } from 'fs';
  
  export default class Client {
    static async main(): Promise<void> {
      const config = new $OpenApi.Config({
        // Omit the credential configuration.
        // The region that you want to access.
        regionId: 'RegionId',
        // The endpoint of the open platform.
        openPlatformEndpoint: 'openplatform-vpc.cn-shanghai.aliyuncs.com',
        // The OSS endpoint that you want to use to upload the file. If you set the endpoint type to internal, you can use an internal endpoint to upload the file to OSS over a VPC or the classic network. If you set the endpoint type to accelerate, you can use an accelerated endpoint outside China to upload the file to OSS.
        endpointType: 'internal'
      });
      const client = new Facebody20191230(config);
      const request = new $Facebody20191230.DetectBodyCountAdvanceRequest({
        imageURLObject: createReadStream("The directory of the file that you want to upload on your computer"),
      });
      // Create a RuntimeObject instance and configure runtime parameters. 
      const runtime = new $Util.RuntimeOptions({});
      const resp = await client.DetectBodyCountAdvance(request, runtime);
      console.log(resp.headers);
      console.log(resp.body);
    }
  }

  O exemplo a seguir demonstra essa configuração em JavaScript:

  const { default: Facebody20191230, DetectBodyCountAdvanceRequest } = require('@alicloud/facebody20191230');
  const { Config } = require('@alicloud/openapi-client');
  const { RuntimeOptions } = require('@alicloud/tea-util');
  const { createReadStream } = require('fs');
  async function main() {
    const config = new Config({
      // Omit the credential configuration.
      // The region that you want to access.
      regionId: 'RegionId',
      // The endpoint of the open platform.
      openPlatformEndpoint: 'openplatform-vpc.cn-shanghai.aliyuncs.com',
      // The OSS endpoint that you want to use to upload the file. If you set the endpoint type to internal, you can use an internal endpoint to upload the file to OSS over a VPC or the classic network. If you set the endpoint type to accelerate, you can use an accelerated endpoint outside China to upload the file to OSS.
      endpointType: 'internal'
    });
    const client = new Facebody20191230(config);
    const request = new DetectBodyCountAdvanceRequest({
      imageURLObject: createReadStream("The directory of the file that you want to upload on your computer"),
    });
    // Create a RuntimeObject instance and configure runtime parameters. 
    const runtime = new RuntimeOptions({});
    const resp = await client.DetectBodyCountAdvance(request, runtime);
    console.log(resp.headers);
    console.log(resp.body);
  }

Para consultar um endpoint, acesse o OpenAPI Explorer.

1. Selecione um serviço da Alibaba Cloud na página inicial do OpenAPI Explorer. Por exemplo, selecione ECS.

1. Clique em na aba Regions.

1. Localize a região desejada e copie o endpoint correspondente.

Também é possível consultar um endpoint da seguinte maneira:

Na aba API Debugging do OpenAPI Explorer, localize a operação de API que deseja chamar e configure o parâmetro RegionId. O OpenAPI Explorer gera automaticamente um código de exemplo do SDK, onde você pode obter o endpoint.