Alibaba Cloud SDK:Configuration des endpoints

Cette rubrique décrit la configuration des endpoints pour le SDK mis à niveau.

Le SDK Darabonba permet de spécifier l'endpoint vers lequel envoyer les requêtes API selon deux modes. La liste suivante présente ces modes par ordre de priorité décroissante :

1. Endpoint défini par l'utilisateur : dans ce mode, spécifiez un endpoint exact lors de l'initialisation du client SDK. Pour trouver un endpoint, consultez

   la page d'accueil du produit sur le Portail des développeurs OpenAPI. Pour plus d'informations, consultez la fin de cette rubrique. Version 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'
       });
     }
   }

   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'
     });
   }

2. Endpoint concaténé : dans ce mode, spécifiez un ID de région pour que le SDK Darabonba génère un endpoint. Ce mode n'est effectif que si le SDK du service Alibaba Cloud dispose d'un fichier de données d'endpoint. Dans le cas contraire, une exception est levée et le message d'erreur config.endpoint can not be empty s'affiche lors de l'initialisation du client SDK. Vous devez alors spécifier un endpoint exact. Pour consulter un exemple de fichier de données d'endpoint, voir le fichier de données d'endpoint ECS. Si la région cible ne figure pas dans le fichier de données, l'endpoint de la région est généré au format ${Code of the Alibaba Cloud service}.${Region ID}.aliyuncs.com. L'exemple de code suivant montre comment spécifier un endpoint concaténé en 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'
    });
  }
}

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'
  });
}

Le SDK mis à niveau prend en charge deux configurations d'endpoint pour les téléchargements de fichiers :

• L'endpoint d'une plateforme ouverte utilisé pour l'authentification. Vous pouvez configurer un endpoint VPC (Virtual Private Cloud) pour demander des informations d'authentification via un VPC. Ces informations servent aux téléchargements de fichiers. L'exemple de code suivant montre comment configurer l'endpoint d'une plateforme ouverte en 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);
    }
  }

  Version 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 to access.
      regionId: 'RegionId',
      // Set the authentication URL.
      openPlatformEndpoint: 'openplatform-vpc.cn-shanghai.aliyuncs.com',
    });
    const client = new Facebody20191230(config);
    const request = new DetectBodyCountAdvanceRequest({
      imageURLObject: createReadStream("path/to/local/file"),
    });
    // Create a RuntimeObject instance and set runtime parameters.
    const runtime = new RuntimeOptions({});
    const resp = await client.DetectBodyCountAdvance(request, runtime);
    console.log(resp.headers);
    console.log(resp.body);
  }

• L'adresse de téléchargement des fichiers. Dans un VPC ou un réseau interne, utilisez une adresse de réseau interne pour télécharger des fichiers. 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);
    }
  }

  Version 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 to access.
      regionId: 'RegionId',
      // Set the authentication URL.
      openPlatformEndpoint: 'openplatform-vpc.cn-shanghai.aliyuncs.com',
      // Set the OSS upload URL. 'internal' is for VPC and classic network. 'accelerate' is for accelerated domain names outside China.
      endpointType: 'internal'
    });
    const client = new Facebody20191230(config);
    const request = new DetectBodyCountAdvanceRequest({
      imageURLObject: createReadStream("path/to/local/file"),
    });
    // Create a RuntimeObject instance and set runtime parameters.
    const runtime = new RuntimeOptions({});
    const resp = await client.DetectBodyCountAdvance(request, runtime);
    console.log(resp.headers);
    console.log(resp.body);
  }

Vous pouvez trouver les endpoints des produits sur le Portail des développeurs :

1. Sur la page d'accueil du Portail des développeurs, sélectionnez un produit cloud, tel qu'ECS, pour ouvrir la page d'accueil du produit. Cette page propose des accès à la recherche d'API, aux essais de débogage, au diagnostic et aux statistiques d'appels.

2. Localisez la liste des régions de service sur la page d'accueil du produit. La liste affiche l'adresse de l'endpoint de chaque région.

3. Trouvez la région souhaitée et copiez son endpoint.

Vous pouvez également effectuer une recherche comme suit :

Dans l'onglet Débogage d'API d'OpenAPI Explorer, trouvez l'opération d'API à appeler et sélectionnez l'adresse de service (région). Accédez à la section Exemples de code SDK. Dans l'exemple de code généré automatiquement, repérez la ligne où l'endpoint est défini ; il s'agit de l'endpoint requis.