REST Resource: projects.locations.servers

Resource: Server

Message describing Server object

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "accessType": enum (AccessType),
  "state": enum (State),
  "googleManagedServerCredential": {
    object (ServerCredential)
  },
  "serviceAgent": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "externalConfig": {
    object (ExternalServerConfig)
  },
  "internalConfig": {
    object (InternalServerConfig)
  }
  // End of mutually exclusive fields.
}
Fields
name

string

Identifier. name of resource
createTime

string (Timestamp format)

Output only. [Output only] Create time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

Optional. Display name of the Server
accessType

enum (AccessType)

Required. The access type of the Server.
state

enum (State)

Output only. The state of the server.
googleManagedServerCredential

object (ServerCredential)

Output only. Credentials of the FTP Server.
serviceAgent

string

Output only. Service agent used to access the customer bucket.
Configuration for server access. If this is set, it must match the value in the access_type field. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
externalConfig

object (ExternalServerConfig)

Configuration for external access.
internalConfig

object (InternalServerConfig)

Configuration for internal access.
End of mutually exclusive fields.

ExternalServerConfig

Configuration for external server.

JSON representation 
{
  "ipAddress": string,
  "allowedCidrBlocks": [
    string
  ]
}
Fields
ipAddress

string

Output only. IP address of the LB via which clients will connect.
allowedCidrBlocks[]

string

Optional. List of CIDR blocks that are allowed to access the Server. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. By default, the prefix length is 32 (i.e. matches a single IP address). For now, only IPV4 addresses are supported. Examples: "203.0.113.0/24" - matches with the IP addresses in the range 203.0.113.0 - 203.0.113.255. "0.0.0.0/0" - matches against any IP address. This field must contain at least one entry if the access type is EXTERNAL. The number of allowed CIDR blocks cannot exceed 500. Example: 192.168.0.0/16

InternalServerConfig

Configuration for private server accessible via PSC.

JSON representation 
{
  "serviceAttachment": string,
  "consumerAcceptList": [
    {
      object (AllowedConsumer)
    }
  ],
  "consumerRejectList": [
    {
      object (DeniedConsumer)
    }
  ],
  "pscEndpoints": [
    {
      object (PscEndpoint)
    }
  ]
}
Fields
serviceAttachment

string

Output only. The resource name of the service attachment. Format: projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
consumerAcceptList[]

object (AllowedConsumer)

Required. A list of projects that are permitted to connect. At least one project is required in the allow list.
consumerRejectList[]

object (DeniedConsumer)

Optional. A list of projects that are denied connection. Format: "projects/sample_project_id" or "projects/1234567890" Projects in this list will be denied access, even if they are included in the allow_list. If this list is empty, no projects are explicitly rejected.
pscEndpoints[]

object (PscEndpoint)

Output only. Details of endpoints created by the customer.

AllowedConsumer

A consumer project or network that is permitted to connect to the server via PSC.

JSON representation 
{
  "connectionLimit": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "project": string
  // End of mutually exclusive fields.
}
Fields
connectionLimit

string (int64 format)

Required. The connection limit for the consumer. Value must be greater than 0.
Required. Specifies the type of consumer. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
project

string

The project ID or number of the consumer project. Must be in the format: projects/{project}.
End of mutually exclusive fields.

DeniedConsumer

A consumer project or network that is denied to connect to the server via PSC.

JSON representation 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "project": string
  // End of mutually exclusive fields.
}
Fields
Required. Specifies the type of consumer. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
project

string

The project ID or number of the consumer project. Must be in the format: projects/{project}.
End of mutually exclusive fields.

PscEndpoint

Details of PSC endpoint created by customer.

JSON representation 
{
  "endpoint": string,
  "network": string,
  "status": string
}
Fields
endpoint

string

Output only. This is a Resource name for Private Service Connect endpoint. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
network

string

Output only. The consumer network. Format: projects/{project}/locations/{location}/networks/{network}
status

string

Output only. The status of the connected endpoint.

AccessType

The access type of the Server.

Enums
ACCESS_TYPE_UNSPECIFIED Default value. This value is unused.
EXTERNAL Server is assigned a public IP.
INTERNAL Server is assigned an internal IP.

State

Tracks Server status.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
CREATING Server is being created.
STARTING Server is starting.
ACTIVE Server is ready to be used.
STOPPING Server is stopping.
STOPPED Server is stopped.
DELETING Server is being deleted.
ERROR Server is in error state.
UPDATING Server is being updated.

ServerCredential

Represents credentials of an FTP Server.

JSON representation 
{
  "fingerprint": string,
  "asymmetricAlgorithm": string
}
Fields
fingerprint

string

Output only. The fingerprint is a hash of the public key, and is displayed when clients access the server for the first time to verify the server's identity.
asymmetricAlgorithm

string

Output only. Asymmetric algorithm used by the public key. Possible values (can be expanded in future): - ssh-ed25519

Methods

create

 Creates a new Server in a given project and location.

delete

 Deletes a single Server.

get

 Gets details of a single Server.

list

 Lists Servers in a given project and location.

patch

 Updates the parameters of a single Server.

start

 Starts a stopping/stopped Server.

stop

 Stops an active Server.