| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="sqladmin_v1.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1.connect.html">connect</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#generateEphemeralCert">generateEphemeralCert(project, instance, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(project, instance, readTime=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Retrieves connect settings about a Cloud SQL instance.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="close">close()</code> |
| 89 | <pre>Close httplib2 connections.</pre> |
| 90 | </div> |
| 91 | |
| 92 | <div class="method"> |
| 93 | <code class="details" id="generateEphemeralCert">generateEphemeralCert(project, instance, body=None, x__xgafv=None)</code> |
| 94 | <pre>Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. |
| 95 | |
| 96 | Args: |
| 97 | project: string, Project ID of the project that contains the instance. (required) |
| 98 | instance: string, Cloud SQL instance ID. This does not include the project ID. (required) |
| 99 | body: object, The request body. |
| 100 | The object takes the form of: |
| 101 | |
| 102 | { # Ephemeral certificate creation request. |
| 103 | "access_token": "A String", # Optional. Access token to include in the signed certificate. |
| 104 | "public_key": "A String", # PEM encoded public key to include in the signed certificate. |
| 105 | "readTime": "A String", # Optional. Optional snapshot read timestamp to trade freshness for performance. |
| 106 | } |
| 107 | |
| 108 | x__xgafv: string, V1 error format. |
| 109 | Allowed values |
| 110 | 1 - v1 error format |
| 111 | 2 - v2 error format |
| 112 | |
| 113 | Returns: |
| 114 | An object of the form: |
| 115 | |
| 116 | { # Ephemeral certificate creation request. |
| 117 | "ephemeralCert": { # SslCerts Resource # Generated cert |
| 118 | "cert": "A String", # PEM representation. |
| 119 | "certSerialNumber": "A String", # Serial number, as extracted from the certificate. |
| 120 | "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. |
| 121 | "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z** |
| 122 | "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| 123 | "instance": "A String", # Name of the database instance. |
| 124 | "kind": "A String", # This is always sql#sslCert. |
| 125 | "selfLink": "A String", # The URI of this resource. |
| 126 | "sha1Fingerprint": "A String", # Sha1 Fingerprint. |
| 127 | }, |
| 128 | }</pre> |
| 129 | </div> |
| 130 | |
| 131 | <div class="method"> |
| 132 | <code class="details" id="get">get(project, instance, readTime=None, x__xgafv=None)</code> |
| 133 | <pre>Retrieves connect settings about a Cloud SQL instance. |
| 134 | |
| 135 | Args: |
| 136 | project: string, Project ID of the project that contains the instance. (required) |
| 137 | instance: string, Cloud SQL instance ID. This does not include the project ID. (required) |
| 138 | readTime: string, Optional. Optional snapshot read timestamp to trade freshness for performance. |
| 139 | x__xgafv: string, V1 error format. |
| 140 | Allowed values |
| 141 | 1 - v1 error format |
| 142 | 2 - v2 error format |
| 143 | |
| 144 | Returns: |
| 145 | An object of the form: |
| 146 | |
| 147 | { # Connect settings retrieval response. |
| 148 | "backendType": "A String", # **SECOND_GEN**: Cloud SQL database instance. **EXTERNAL**: A database server that is not managed by Google. This property is read-only; use the **tier** property in the **settings** object to determine the database type. |
| 149 | "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. MySQL instances: **MYSQL_8_0**, **MYSQL_5_7** (default), or **MYSQL_5_6**. PostgreSQL instances: **POSTGRES_9_6**, **POSTGRES_10**, **POSTGRES_11** or **POSTGRES_12** (default). SQL Server instances: **SQLSERVER_2017_STANDARD** (default), **SQLSERVER_2017_ENTERPRISE**, **SQLSERVER_2017_EXPRESS**, or **SQLSERVER_2017_WEB**. |
| 150 | "ipAddresses": [ # The assigned IP addresses for the instance. |
| 151 | { # Database instance IP Mapping. |
| 152 | "ipAddress": "A String", # The IP address assigned. |
| 153 | "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired. |
| 154 | "type": "A String", # The type of this IP address. A **PRIMARY** address is a public address that can accept incoming connections. A **PRIVATE** address is a private address that can accept incoming connections. An **OUTGOING** address is the source address of connections originating from the instance, if supported. |
| 155 | }, |
| 156 | ], |
| 157 | "kind": "A String", # This is always `sql#connectSettings`. |
| 158 | "serverCaCert": { # SslCerts Resource # SSL configuration. |
| 159 | "cert": "A String", # PEM representation. |
| 160 | "certSerialNumber": "A String", # Serial number, as extracted from the certificate. |
| 161 | "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. |
| 162 | "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z** |
| 163 | "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. |
| 164 | "instance": "A String", # Name of the database instance. |
| 165 | "kind": "A String", # This is always sql#sslCert. |
| 166 | "selfLink": "A String", # The URI of this resource. |
| 167 | "sha1Fingerprint": "A String", # Sha1 Fingerprint. |
| 168 | }, |
| 169 | }</pre> |
| 170 | </div> |
| 171 | |
| 172 | </body></html> |