Method list

Статья создана

HTTP request
Query parameters
Response

Retrieves the list of Address resources in the specified folder.

HTTP request

GET https://vpc.api.cloud.yandex.net/vpc/v1/addresses

Query parameters

Parameter	Description
folderId	Required. ID of the folder to list addresses in. To get the folder ID use a list request. The maximum string length in characters is 50.
pageSize	The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
pageToken	Page token. To get the next page of results, set `page_token` to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter	A filter expression that filters Address listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on Address.name field. 2. An operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values. 3. The value. Must be 3-63 characters long and match the regular expression `^[a-z][-a-z0-9]{1,61}[a-z0-9]`. Example of a filter: `name=my-address`.

Response

HTTP Code: 200 - OK

{
  "addresses": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "reserved": true,
      "used": true,
      "type": "string",
      "ipVersion": "string",
      "externalIpv4Address": {
        "address": "string",
        "zoneId": "string",
        "requirements": {
          "ddosProtectionProvider": "string",
          "outgoingSmtpCapability": "string"
        }
      }
    }
  ],
  "nextPageToken": "string"
}

Field	Description
addresses[]	object An Address resource. For more information, see Address.
addresses[]. id	string ID of the address. Generated at creation time.
addresses[]. folderId	string ID of the folder that the address belongs to.
addresses[]. createdAt	string (date-time) Creation timestamp. String in RFC3339 text format.
addresses[]. name	string Name of the address. The name is unique within the folder.
addresses[]. description	string Description of the address.
addresses[]. labels	object Resource labels as `key:value` pairs.
addresses[]. reserved	boolean (boolean) Specifies if address is reserved or not.
addresses[]. used	boolean (boolean) Specifies if address is used or not.
addresses[]. type	string Type of the IP address. INTERNAL: Internal IP address. EXTERNAL: Public IP address.
addresses[]. ipVersion	string Vervion of the IP address. IPV4: IPv4 address. IPV6: IPv6 address.
addresses[]. externalIpv4Address	object
addresses[]. externalIpv4Address. address	string Value of address.
addresses[]. externalIpv4Address. zoneId	string Availability zone from which the address will be allocated.
addresses[]. externalIpv4Address. requirements	object Parameters of the allocated address, for example DDoS Protection.
addresses[]. externalIpv4Address. requirements. ddosProtectionProvider	string DDoS protection provider ID.
addresses[]. externalIpv4Address. requirements. outgoingSmtpCapability	string Capability to send SMTP traffic.
nextPageToken	string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use `next_page_token` as the value for the pageToken parameter in the next list request. Each subsequent page will have its own `next_page_token` to continue paging through the results.