For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.vpcs.list_members(
    vpc_id="4de7ac8b-495b-4884-9a69-1050c6793cd6",
    resource_type=None,
    per_page=20,
    page=1,
)

Description

To list all of the resources that are members of a VPC, send a GET request to /v2/vpcs/{vpc_id}/members.

To only list resources of a specific type that are members of the VPC, included a resource_type query parameter. For example, to only list Droplets in the VPC, send a GET request to /v2/vpcs/$VPC_ID/members?resource_type=droplet.

Only resources that you are authorized to see will be returned (e.g. to see Droplets, you must have droplet:read).

Parameters

vpc_id string required

A unique identifier for a VPC.

Min: 1

resource_type string optional

Used to filter VPC members by a resource type.

per_page integer optional

Number of items returned per page

Min: 1

Max: 200

Default: 20

page integer optional

Which 'page' of paginated results to return.

Min: 1

Default: 1

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.vpcs.list_members(vpc_id="e0fe0f4d")

Pagination

This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page parameter:

from urllib.parse import urlparse, parse_qs

resp = client.vpcs.list_members(vpc_id="4de7ac8b-495b-4884-9a69-1050c6793cd6", )
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.vpcs.list_members(vpc_id="4de7ac8b-495b-4884-9a69-1050c6793cd6", page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

{
  "members": [
    {
      "urn": "do:loadbalancer:fb294d78-d193-4cb2-8737-ea620993591b",
      "name": "nyc1-load-balancer-01",
      "created_at": "2020-03-13T19:30:48Z"
    },
    {
      "urn": "do:dbaas:13f7a2f6-43df-4c4a-8129-8733267ddeea",
      "name": "db-postgresql-nyc1-55986",
      "created_at": "2020-03-13T19:30:18Z"
    },
    {
      "urn": "do:kubernetes:da39d893-96e1-4e4d-971d-1fdda33a46b1",
      "name": "k8s-nyc1-1584127772221",
      "created_at": "2020-03-13T19:30:16Z"
    },
    {
      "urn": "do:droplet:86e29982-03a7-4946-8a07-a0114dff8754",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01",
      "created_at": "2020-03-13T19:29:20Z"
    }
  ],
  "links": {},
  "meta": {
    "total": 4
  }
}

More Information

See /v2/vpcs/{vpc_id}/members in the API reference for additional detail on responses, headers, parameters, and more.