Skip to content

2-Endpoint.md

Latest commit

 

History

History
89 lines (65 loc) · 2.84 KB

2-Endpoint.md

File metadata and controls

89 lines (65 loc) · 2.84 KB
Raw

← Credentials | Endpoint(中文) | Transport →

Endpoint Configuration

Default

If endpoint is not specified, the SDK uses automatic endpoint resolution.

Custom Endpoint

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = \Volcengine\Common\Configuration::getDefaultConfiguration()
    ->setAk("Your ak")
    ->setSk("Your sk")
    ->setHost('https://open.volcengineapi.com');

Custom RegionId

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = \Volcengine\Common\Configuration::getDefaultConfiguration()
    ->setAk("Your ak")
    ->setSk("Your sk")
    ->setRegion("cn-beijing");

Automatic Endpoint Resolution

Default

Automatic resolution is enabled by default; no manual endpoint configuration required.

The SDK resolves the endpoint from service name and region. Global services use <service>.volcengineapi.com; regional services use <service>.<region>.volcengineapi.com. If the service or region is not covered by the built-in rules, the SDK falls back to open.volcengineapi.com.

To enable DualStack (IPv4 + IPv6), call setUseDualStack(true). The domain suffix changes from volcengineapi.com to volcengine-api.com.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = \Volcengine\Common\Configuration::getDefaultConfiguration()
    ->setAk("Your ak")
    ->setSk("Your sk")
    ->setUseDualStack(true);    // enable dual-stack, default false

Standard Endpoint Resolution

Standard endpoint resolution constructs endpoints according to whether the service is global:

Global service DualStack Format
Yes Yes {Service}.volcengine-api.com
Yes No {Service}.volcengineapi.com
No Yes {Service}.{region}.volcengine-api.com
No No {Service}.{region}.volcengineapi.com

Whether a service is global is determined by the service information list built into the SDK. Unlike default automatic resolution, standard resolution returns an error when the service is unknown or the region is invalid instead of falling back to open.volcengineapi.com.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Volcengine\Common\Configuration;
use Volcengine\Common\Endpoint\Providers\StandardEndpointProvider;

$config = Configuration::getDefaultConfiguration()
    ->setAk("Your ak")
    ->setSk("Your sk")
    ->setEndpointProvider(new StandardEndpointProvider()) // Configure standard resolution
    ->setRegion("cn-beijing")                             // Configure RegionId
    ->setUseDualStack(true);                              // Configure DualStack

← Credentials | Endpoint(中文) | Transport →