@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface MembersRequestBuilder

    Builds and executes requests for operations under /v2/vpcs/{vpc_id}/members

    interface MembersRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                MembersRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | MembersGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                MembersRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): MembersRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • 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 Dropletsin 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

      Returns Promise<undefined | MembersGetResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • 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 Dropletsin 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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns MembersRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods