> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 生成 Socks 5 代理用户名



## OpenAPI

````yaml cn-openapi-reseller GET /api/{PARTNER_NAME}/socks5_proxies
openapi: 3.0.1
info:
  title: Brightdata API
  description: 将 Bright Data API 集成到您的数据管道中，确保高精度爬取
  version: 1.0.0
servers:
  - url: https://api.brightdata.com
security:
  - bearerAuth: []
paths:
  /api/{PARTNER_NAME}/socks5_proxies:
    get:
      parameters:
        - in: path
          name: PARTNER_NAME
          description: 将处理您请求的代理区域名称。
          required: true
          schema:
            type: string
        - in: query
          name: id
          description: 有效的客户 `id`
          required: true
          schema:
            type: string
        - in: query
          name: zone
          description: 现有的区域名称
          required: false
          schema:
            type: string
            default: hq_static_res
        - in: query
          name: country
          description: 国家名称（例如 `us`）
          required: false
          schema:
            type: string
        - in: query
          name: state
          description: 美国州名（例如 `ca`）
          required: false
          schema:
            type: string
        - in: query
          name: session
          description: 要生成的会话数量
          required: false
          schema:
            type: number
        - in: query
          name: asn
          description: ASN 名称。可通过 `/api/{PARTNER_NAME}/get_asn` API 获取所有可用 ASN
          required: false
          schema:
            type: string
        - in: query
          name: carrier
          description: 运营商名称。可通过 `/api/{PARTNER_NAME}/carriers` API 获取所有可用运营商
          required: false
          schema:
            type: string
        - in: query
          name: const
          description: 使用常量
          required: false
          schema:
            type: number
            default: 1
        - in: query
          name: split
          description: 如果提供，则仅编码用户名中的 `brd-customer-{CUST_ID}-zone-{ZONE}` 部分
          required: false
          schema:
            type: number
            default: 1
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                example:
                  - '{PARTNER_NAME_PROXY_HOST}:{PORT}:{ENCRYPTED}:{ZONE_PASSWORD}'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        在 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`


        **示例:**

        ```

        Authorization: Bearer
        b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

        ```


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

````