create(parent, body=None, dnsZoneId=None, x__xgafv=None)

Creates a new DNS zone.

Args:
  parent: string, Required. Organization where the DNS zone will be created. (required)
  body: object, The request body.
    The object takes the form of:

{ # A DNS zone is a resource under an Apigee organization that is used to create a DNS peering with Apigee's network. DNS peering will let Apigee instances resolve the hostnames created in a peered network.
  "createTime": "A String", # Output only. The time that this resource was created on the server.
  "description": "A String", # Required. Description of the resource. String of at most 1024 characters associated with this resource for the user's convenience.
  "domain": "A String", # Required. The domain name for hosts in this private zone, for instance "example.com.".
  "name": "A String", # Identifier. Unique name for the resource. Defined by the server Format: "organizations/{organization}/dnsZones/{dns_zone}".
  "peeringConfig": { # Fields for DNS PEERING zone. # DNS PEERING zone configuration.
    "targetNetworkId": "A String", # Required. The VPC network where the records for that private DNS zone's namespace are available. Apigee will be performing DNS peering with this VPC network.
    "targetProjectId": "A String", # Required. The ID of the project that contains the producer VPC network.
  },
  "state": "A String", # Output only. State of the DNS Peering. Values other than `ACTIVE` mean the resource is not ready to use.
  "updateTime": "A String", # Output only. The time that this resource was updated on the server.
}

  dnsZoneId: string, Required. User assigned ID for this resource. Must be unique within the organization. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

delete(name, x__xgafv=None)

Deletes a previously created DNS zone.

Args:
name: string, Required. Name of the DNS zone to delete. Use the following structure in your request: `organizations/{org}/dnsZones/{dns_zone}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Fetches the representation of an existing DNS zone.

Args:
  name: string, Required. Name of the DNS zone to fetch. Use the following structure in your request: `organizations/{org}/dnsZones/{dns_zone}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A DNS zone is a resource under an Apigee organization that is used to create a DNS peering with Apigee's network. DNS peering will let Apigee instances resolve the hostnames created in a peered network.
  "createTime": "A String", # Output only. The time that this resource was created on the server.
  "description": "A String", # Required. Description of the resource. String of at most 1024 characters associated with this resource for the user's convenience.
  "domain": "A String", # Required. The domain name for hosts in this private zone, for instance "example.com.".
  "name": "A String", # Identifier. Unique name for the resource. Defined by the server Format: "organizations/{organization}/dnsZones/{dns_zone}".
  "peeringConfig": { # Fields for DNS PEERING zone. # DNS PEERING zone configuration.
    "targetNetworkId": "A String", # Required. The VPC network where the records for that private DNS zone's namespace are available. Apigee will be performing DNS peering with this VPC network.
    "targetProjectId": "A String", # Required. The ID of the project that contains the producer VPC network.
  },
  "state": "A String", # Output only. State of the DNS Peering. Values other than `ACTIVE` mean the resource is not ready to use.
  "updateTime": "A String", # Output only. The time that this resource was updated on the server.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Enumerates DNS zones that have been created but not yet deleted.

Args:
  parent: string, Required. Name of the organization for which to list the DNS zones. Use the following structure in your request: `organizations/{org}` (required)
  pageSize: integer, Optional. Maximum number of DNS zones to return. If unspecified, at most 25 DNS zones will be returned.
  pageToken: string, Optional. Page token, returned from a previous `ListDnsZones` call, that you can use to retrieve the next page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for list DNS zones.
  "dnsZones": [ # DNS zones in a given organization.
    { # A DNS zone is a resource under an Apigee organization that is used to create a DNS peering with Apigee's network. DNS peering will let Apigee instances resolve the hostnames created in a peered network.
      "createTime": "A String", # Output only. The time that this resource was created on the server.
      "description": "A String", # Required. Description of the resource. String of at most 1024 characters associated with this resource for the user's convenience.
      "domain": "A String", # Required. The domain name for hosts in this private zone, for instance "example.com.".
      "name": "A String", # Identifier. Unique name for the resource. Defined by the server Format: "organizations/{organization}/dnsZones/{dns_zone}".
      "peeringConfig": { # Fields for DNS PEERING zone. # DNS PEERING zone configuration.
        "targetNetworkId": "A String", # Required. The VPC network where the records for that private DNS zone's namespace are available. Apigee will be performing DNS peering with this VPC network.
        "targetProjectId": "A String", # Required. The ID of the project that contains the producer VPC network.
      },
      "state": "A String", # Output only. State of the DNS Peering. Values other than `ACTIVE` mean the resource is not ready to use.
      "updateTime": "A String", # Output only. The time that this resource was updated on the server.
    },
  ],
  "nextPageToken": "A String", # Page token that you can include in an `ListDnsZones` request to retrieve the next page. If omitted, no subsequent pages exist.
}

Apigee API . organizations . dnsZones

Instance Methods

Method Details