Skip to main content
GET
cURL

授权

Authorization
string
header
必填

在 Authorization 头中使用您的 Bright Data API Key 作为 Bearer token。

认证方法:

  1. 从 Bright Data 账户设置获取您的 API Key: https://brightdata.com/cp/setting/users
  2. 在请求的 Authorization 头中包含 API Key
  3. 格式: Authorization: Bearer YOUR_API_KEY

示例:

了解如何获取 Bright Data API Key: https://docs.brightdata.com/cn/api-reference/authentication#如何生成新的-api-key?

路径参数

PARTNER_NAME
string
必填

将处理您请求的代理区域名称。

查询参数

id
string
必填

有效的客户 id

zone
string
默认值:hq_static_res

现有的区域名称

country
string

国家名称(例如 us

state
string

美国州名(例如 ca

session
number

要生成的会话数量

asn
string

ASN 名称。可通过 /api/{PARTNER_NAME}/get_asn API 获取所有可用 ASN

carrier
string

运营商名称。可通过 /api/{PARTNER_NAME}/carriers API 获取所有可用运营商

const
number
默认值:1

使用常量

split
number
默认值:1

如果提供,则仅编码用户名中的 brd-customer-{CUST_ID}-zone-{ZONE} 部分

响应

200 - application/json

成功

示例: