Tool: create_user
Datenbanknutzer für eine Cloud SQL-Instanz erstellen
- Dieses Tool gibt einen Vorgang mit langer Ausführungszeit zurück. Verwenden Sie das Tool
get_operation, um den Status abzufragen, bis der Vorgang abgeschlossen ist. - Wenn Sie das Tool
create_userverwenden, geben Sie den Nutzertyp an:CLOUD_IAM_USER,CLOUD_IAM_SERVICE_ACCOUNToderBUILT_IN. - Standardmäßig wird dem neu erstellten Nutzer die Rolle
cloudsqlsuperuserzugewiesen, es sei denn, Sie geben in der Anfrage explizit andere Datenbankrollen an. - Sie können einen neu erstellten Nutzer mit dem
execute_sql-Tool verwenden, wenn der Nutzer ein aktuell angemeldeter IAM-Nutzer ist. Das Toolexecute_sqlführt die SQL-Anweisungen mit den Berechtigungen des Datenbanknutzers aus, der sich mit der IAM-Datenbankauthentifizierung angemeldet hat.
Für das Tool create_user gelten die folgenden Einschränkungen:
- Wenn Sie einen integrierten Nutzer mit Passwort erstellen möchten, verwenden Sie das Feld
password_secret_version, um das Passwort über Google Cloud Secret Manager anzugeben. Der Wert vonpassword_secret_versionsollte der Ressourcenname der Secret-Version sein, z. B.projects/12345/locations/us-central1/secrets/my-password-secret/versions/1oderprojects/12345/locations/us-central1/secrets/my-password-secret/versions/latest. Der Aufrufer muss die Berechtigungsecretmanager.secretVersions.accessfür die geheime Version haben. - Mit dem Tool
create_userkann kein Nutzer für SQL Server erstellt werden.
So erstellen Sie einen IAM-Nutzer in PostgreSQL:
- Der Datenbank-Nutzername muss die E-Mail-Adresse des IAM-Nutzers sein und darf nur Kleinbuchstaben enthalten. Wenn Sie beispielsweise einen Nutzer für den PostgreSQL-IAM-Nutzer
example-user@example.comerstellen möchten, können Sie die folgende Anfrage verwenden:
{
"name": "example-user@example.com",
"type": "CLOUD_IAM_USER",
"instance":"test-instance",
"project": "test-project"
}
Der erstellte Datenbank-Nutzername für den IAM-Nutzer ist example-user@example.com.
So erstellen Sie ein IAM-Dienstkonto in PostgreSQL:
- Der Datenbank-Nutzername muss ohne das Suffix
.gserviceaccount.comerstellt werden, obwohl die vollständige E-Mail-Adresse für das Kontoservice-account-name@project-id.iam.gserviceaccount.comlautet. Wenn Sie beispielsweise ein IAM-Dienstkonto für PostgreSQL erstellen möchten, können Sie das folgende Anfrageformat verwenden:
{
"name": "test@test-project.iam",
"type": "CLOUD_IAM_SERVICE_ACCOUNT",
"instance": "test-instance",
"project": "test-project"
}
Der erstellte Datenbanknutzername für das IAM-Dienstkonto ist test@test-project.iam.
So erstellen Sie einen IAM-Nutzer oder ein IAM-Dienstkonto in MySQL:
- Wenn Cloud SQL for MySQL einen Nutzernamen speichert, werden das @ und der Domainname von der E-Mail-Adresse des Nutzers oder Dienstkontos abgeschnitten. Aus
example-user@example.comwird beispielsweiseexample-user. - Aus diesem Grund können Sie derselben Cloud SQL-Instanz nicht zwei IAM-Nutzer oder Dienstkonten mit demselben Nutzernamen, aber unterschiedlichen Domainnamen hinzufügen.
- Verwenden Sie beispielsweise die folgende Anfrage, um einen Nutzer für den MySQL-IAM-Nutzer
example-user@example.comzu erstellen:
{
"name": "example-user@example.com",
"type": "CLOUD_IAM_USER",
"instance": "test-instance",
"project": "test-project"
}
Der erstellte Datenbank-Nutzername für den IAM-Nutzer ist example-user.
- Verwenden Sie beispielsweise die folgende Anfrage, um das MySQL-IAM-Dienstkonto
service-account-name@project-id.iam.gserviceaccount.comzu erstellen:
{
"name": "service-account-name@project-id.iam.gserviceaccount.com",
"type": "CLOUD_IAM_SERVICE_ACCOUNT",
"instance": "test-instance",
"project": "test-project"
}
Der erstellte Datenbanknutzername für das IAM-Dienstkonto lautet service-account-name.
Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool create_user aufrufen.
| Curl-Anfrage |
|---|
curl --location 'https://sqladmin.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "create_user", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
Eingabeschema
Der Nutzer fügt eine Anfrage für das MCP ein.
SqlUsersInsertMcpRequest
| JSON-Darstellung |
|---|
{
"project": string,
"instance": string,
"type": enum ( |
| Felder | |
|---|---|
project |
Erforderlich. Projekt-ID des Projekts mit der Instanz. |
instance |
Erforderlich. ID der Datenbankinstanz. Die Projekt-ID ist darin nicht enthalten. |
type |
Erforderlich. Der Nutzertyp. Sie bestimmt die Methode zur Authentifizierung des Nutzers bei der Anmeldung. Verwenden Sie den Typ |
name |
Erforderlich. Der Nutzername in der Cloud SQL-Instanz. |
databaseRoles[] |
Optional. Rollenmitgliedschaften des Nutzers. Der Standardwert ist [cloudsqlsuperuser]. |
passwordSecretVersion |
Optional. Nur Eingabe. Der Ressourcenname des Secret Manager-Secrets mit dem Passwort für den Nutzer. Nur erforderlich, wenn |
SqlUserType
Der Nutzertyp.
| Enums | |
|---|---|
BUILT_IN |
Der integrierte Nutzertyp der Datenbank. |
CLOUD_IAM_USER |
Cloud IAM-Nutzer. |
CLOUD_IAM_SERVICE_ACCOUNT |
Cloud IAM-Dienstkonto. |
CLOUD_IAM_GROUP |
Cloud IAM-Gruppe. Wird nicht für die Anmeldung verwendet. |
CLOUD_IAM_GROUP_USER |
Nur Lesezugriff. Anmeldung für einen Nutzer, der zur Cloud IAM-Gruppe gehört. |
CLOUD_IAM_GROUP_SERVICE_ACCOUNT |
Nur Lesezugriff. Anmeldung für ein Dienstkonto, das zur Cloud IAM-Gruppe gehört. |
CLOUD_IAM_WORKFORCE_IDENTITY |
Cloud IAM-Mitarbeiteridentität, die von der Workforce Identity-Föderation verwaltet wird. |
ENTRAID_USER |
Microsoft Entra ID-Nutzer. |
Ausgabeschema
Eine Vorgangsressource. Bei erfolgreichen Vorgängen, die eine Vorgangsressource zurückgeben, werden nur die für den Vorgang relevanten Felder in der Ressource ausgefüllt.
Vorgang
| JSON-Darstellung |
|---|
{ "kind": string, "targetLink": string, "status": enum ( |
| Felder | |
|---|---|
kind |
Dies ist immer |
targetLink |
|
status |
Der Status eines Vorgangs. |
user |
Die E-Mail-Adresse des Nutzers, der diesen Vorgang initiiert hat. |
insertTime |
Die Zeit, zu der dieser Vorgang in die Warteschlange gestellt wurde, in der UTC-Zeitzone im RFC 3339-Format, z. B. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
startTime |
Die Zeit, zu der dieser Vorgang tatsächlich in der UTC-Zeitzone im RFC 3339-Format begonnen hat, z. B. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
endTime |
Die Zeit, zu der dieser Vorgang in der UTC-Zeitzone abgeschlossen wurde, im RFC 3339-Format, z. B. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
error |
Wenn bei der Verarbeitung dieses Vorgangs Fehler aufgetreten sind, wird dieses Feld ausgefüllt. |
apiWarning |
Eine Admin API-Warnmeldung. |
operationType |
Der Typ des Vorgangs. Gültige Werte sind: * |
importContext |
Der Kontext für den Importvorgang, falls zutreffend. |
exportContext |
Der Kontext für den Exportvorgang, falls zutreffend. |
backupContext |
Der Kontext für den Sicherungsvorgang, falls zutreffend. |
preCheckMajorVersionUpgradeContext |
Dieses Feld wird nur ausgefüllt, wenn der „operation_type“ PRE_CHECK_MAJOR_VERSION_UPGRADE ist. Die PreCheckMajorVersionUpgradeContext-Nachricht selbst enthält die Details für diese Vorabprüfung, z. B. die Zieldatenbankversion für das Upgrade und die Ergebnisse der Prüfung (einschließlich aller gefundenen Warnungen oder Fehler). |
startWorkloadCaptureContext |
Der Kontext für den |
stopWorkloadCaptureContext |
Der Kontext für den Vorgang |
startWorkloadReplayContext |
Der Kontext für den Vorgang |
stopWorkloadReplayContext |
Der Kontext für den Vorgang |
name |
Eine Kennung, die den Vorgang eindeutig identifiziert. Mit dieser Kennung können Sie die Operations-Ressource mit Informationen zum Vorgang abrufen. |
targetId |
Name der Ressource, auf der dieser Vorgang ausgeführt wird. |
selfLink |
Der URI dieser Ressource. |
targetProject |
Die Projekt-ID der Zielinstanz, die mit diesem Vorgang verknüpft ist. |
acquireSsrsLeaseContext |
Der Kontext für den Vorgang zum Erwerb einer SSRS-Freigabe, falls zutreffend. |
subOperationType |
Optional. Der Untervorgang basierend auf dem Vorgangstyp. |
Zeitstempel
| JSON-Darstellung |
|---|
{ "seconds": string, "nanos": integer } |
| Felder | |
|---|---|
seconds |
Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss zwischen -62135596800 und 253402300799 (einschließlich) liegen, was 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z entspricht. |
nanos |
Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld ist der Nanosekundenanteil der Dauer, keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 (einschließlich) liegen. |
OperationErrors
| JSON-Darstellung |
|---|
{
"kind": string,
"errors": [
{
object ( |
| Felder | |
|---|---|
kind |
Dies ist immer |
errors[] |
Die Liste der Fehler, die bei der Verarbeitung dieses Vorgangs aufgetreten sind. |
OperationError
| JSON-Darstellung |
|---|
{ "kind": string, "code": string, "message": string } |
| Felder | |
|---|---|
kind |
Dies ist immer |
code |
Identifiziert den spezifischen Fehler, der aufgetreten ist. |
message |
Zusätzliche Informationen zum aufgetretenen Fehler. |
ApiWarning
| JSON-Darstellung |
|---|
{
"code": enum ( |
| Felder | |
|---|---|
code |
Code zur eindeutigen Identifizierung des Warnungstyps. |
message |
Warnmeldung. |
region |
Der Name der Region für die Warnung REGION_UNREACHABLE. |
ImportContext
| JSON-Darstellung |
|---|
{ "uri": string, "database": string, "kind": string, "fileType": enum ( |
| Felder | |
|---|---|
uri |
Pfad zur Importdatei in Cloud Storage im Format |
database |
Die Zieldatenbank für den Import. Wenn |
kind |
Dies ist immer |
fileType |
Der Dateityp für den angegebenen URI.`SQL |
csvImportOptions |
Optionen zum Importieren von Daten als CSV-Datei. |
importUser |
Der PostgreSQL-Nutzer für diesen Importvorgang. Nur PostgreSQL-Instanzen. |
bakImportOptions |
Importparameter für SQL Server-BAK-Dateien |
sqlImportOptions |
Optional. Optionen zum Importieren von Daten aus SQL-Anweisungen. |
tdeImportOptions |
Optional. SQL Server-TDE-Zertifikatspezifische Parameter importieren |
SqlCsvImportOptions
| JSON-Darstellung |
|---|
{ "table": string, "columns": [ string ], "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string } |
| Felder | |
|---|---|
table |
Die Tabelle, in die CSV-Daten importiert werden. |
columns[] |
Die Spalten, in die CSV-Daten importiert werden. Wenn nicht angegeben, werden alle Spalten der Datenbanktabelle mit CSV-Daten geladen. |
escapeCharacter |
Gibt das Zeichen an, das vor einem Datenzeichen stehen muss, das maskiert werden soll. |
quoteCharacter |
Gibt das Anführungszeichen an, das verwendet werden soll, wenn ein Datenwert in Anführungszeichen gesetzt wird. |
fieldsTerminatedBy |
Gibt das Zeichen an, das die Spalten in jeder Zeile der Datei trennt. |
linesTerminatedBy |
Dies wird verwendet, um Zeilen zu trennen. Wenn eine Zeile nicht alle Felder enthält, werden die restlichen Spalten auf ihre Standardwerte gesetzt. |
SqlBakImportOptions
| JSON-Darstellung |
|---|
{ "encryptionOptions": { object ( |
| Felder | |
|---|---|
encryptionOptions |
|
striped |
Gibt an, ob der wiederhergestellte Sicherungssatz gestreift ist. Gilt nur für Cloud SQL for SQL Server. |
noRecovery |
Gibt an, ob beim Importieren der Sicherung die Datenbank mit der Option NORECOVERY wiederhergestellt wird. Gilt nur für Cloud SQL for SQL Server. |
recoveryOnly |
Gibt an, ob die Anfrage zum Importieren der Sicherung die Datenbank nur online schaltet, ohne Bak-Inhalte herunterzuladen. Nur eine der Optionen „no_recovery“ und „recovery_only“ kann „true“ sein, andernfalls wird ein Fehler zurückgegeben. Gilt nur für Cloud SQL for SQL Server. |
bakType |
Typ des BAK-Inhalts: FULL oder DIFF |
stopAt |
Optional. Der Zeitstempel, zu dem der Import beendet werden soll. Dieser Zeitstempel hat das RFC 3339-Format (z. B. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
stopAtMark |
Optional. Die markierte Transaktion, an der der Import beendet werden soll. Dieses Feld entspricht dem Keyword STOPATMARK und gilt nur für Cloud SQL for SQL Server. |
EncryptionOptions
| JSON-Darstellung |
|---|
{ "certPath": string, "pvkPath": string, "pvkPassword": string, "keepEncrypted": boolean } |
| Felder | |
|---|---|
certPath |
Pfad zum Zertifikat (.cer) in Cloud Storage im Format |
pvkPath |
Pfad zum privaten Schlüssel des Zertifikats (.pvk) in Cloud Storage im Format |
pvkPassword |
Passwort, mit dem der private Schlüssel verschlüsselt wird |
keepEncrypted |
Optional. Gibt an, ob die importierte Datei verschlüsselt bleibt. |
BoolValue
| JSON-Darstellung |
|---|
{ "value": boolean } |
| Felder | |
|---|---|
value |
Der boolesche Wert. |
SqlImportOptions
| JSON-Darstellung |
|---|
{
"threads": integer,
"parallel": boolean,
"postgresImportOptions": {
object ( |
| Felder | |
|---|---|
threads |
Optional. Die Anzahl der Threads, die für den parallelen Import verwendet werden sollen. |
parallel |
Optional. Gibt an, ob der Import parallel erfolgen soll. |
postgresImportOptions |
Optional. Optionen für den Import aus einer Cloud SQL for PostgreSQL-Instanz. |
Int32Value
| JSON-Darstellung |
|---|
{ "value": integer } |
| Felder | |
|---|---|
value |
Der int32-Wert. |
PostgresImportOptions
| JSON-Darstellung |
|---|
{ "clean": boolean, "ifExists": boolean } |
| Felder | |
|---|---|
clean |
Optional. Das Flag „--clean“ für das Dienstprogramm „pg_restore“. Dieses Flag gilt nur, wenn Sie Cloud SQL für den parallelen Import von Dateien aktiviert haben. |
ifExists |
Optional. Das Flag „--if-exists“ für das Dienstprogramm „pg_restore“. Dieses Flag gilt nur, wenn Sie Cloud SQL für den parallelen Import von Dateien aktiviert haben. |
SqlTdeImportOptions
| JSON-Darstellung |
|---|
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string } |
| Felder | |
|---|---|
certificatePath |
Erforderlich. Pfad zum öffentlichen Schlüssel des TDE-Zertifikats im Format „gs://bucketName/fileName“. Die Instanz muss Lesezugriff auf die Datei haben. Gilt nur für SQL Server-Instanzen. |
privateKeyPath |
Erforderlich. Pfad zum privaten Schlüssel des TDE-Zertifikats im Format gs://bucketName/fileName. Die Instanz muss Lesezugriff auf die Datei haben. Gilt nur für SQL Server-Instanzen. |
privateKeyPassword |
Erforderlich. Passwort, mit dem der private Schlüssel verschlüsselt wird. |
name |
Erforderlich. Name des Zertifikats. Gilt nur für SQL Server-Instanzen. |
ExportContext
| JSON-Darstellung |
|---|
{ "uri": string, "databases": [ string ], "kind": string, "sqlExportOptions": { object ( |
| Felder | |
|---|---|
uri |
Der Pfad zur Datei in Google Cloud Storage, in der der Export gespeichert wird. Der URI hat das Format |
databases[] |
Zu exportierende Datenbanken. |
kind |
Dies ist immer |
sqlExportOptions |
Optionen zum Exportieren von Daten als SQL-Anweisungen. |
csvExportOptions |
Optionen zum Exportieren von Daten als CSV-Datei. Nur für |
fileType |
Der Dateityp für den angegebenen URI. |
offload |
Gibt an, ob ein serverloser Export ausgeführt werden soll. |
bakExportOptions |
Optionen zum Exportieren von Daten als BAK-Dateien. |
tdeExportOptions |
Optional. SQL Server-TDE-Zertifikatspezifische Parameter exportieren |
SqlExportOptions
| JSON-Darstellung |
|---|
{ "tables": [ string ], "schemaOnly": boolean, "mysqlExportOptions": { object ( |
| Felder | |
|---|---|
tables[] |
Tabellen, die aus der angegebenen Datenbank exportiert werden sollen oder wurden. Wenn Sie Tabellen angeben, müssen Sie genau eine Datenbank angeben. Bei PostgreSQL-Instanzen können Sie nur eine Tabelle angeben. |
schemaOnly |
Nur Schemas exportieren |
mysqlExportOptions |
|
threads |
Optional. Die Anzahl der Threads, die für den parallelen Export verwendet werden sollen. |
parallel |
Optional. Gibt an, ob der Export parallel erfolgen soll. |
postgresExportOptions |
Optional. Optionen für den Export aus einer Cloud SQL for PostgreSQL-Instanz. |
MysqlExportOptions
| JSON-Darstellung |
|---|
{ "masterData": integer } |
| Felder | |
|---|---|
masterData |
Option zum Einbeziehen der SQL-Anweisung, die zum Einrichten der Replikation erforderlich ist. Wenn der Wert auf |
PostgresExportOptions
| JSON-Darstellung |
|---|
{ "clean": boolean, "ifExists": boolean } |
| Felder | |
|---|---|
clean |
Optional. Verwenden Sie diese Option, um DROP |
ifExists |
Optional. Option, um eine IF EXISTS-SQL-Anweisung in jede DROP-Anweisung einzufügen, die von „clean“ erzeugt wird. |
SqlCsvExportOptions
| JSON-Darstellung |
|---|
{ "selectQuery": string, "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string } |
| Felder | |
|---|---|
selectQuery |
Die SELECT-Abfrage, die zum Extrahieren der Daten verwendet wird. |
escapeCharacter |
Gibt das Zeichen an, das vor einem Datenzeichen stehen muss, das maskiert werden soll. |
quoteCharacter |
Gibt das Anführungszeichen an, das verwendet werden soll, wenn ein Datenwert in Anführungszeichen gesetzt wird. |
fieldsTerminatedBy |
Gibt das Zeichen an, das die Spalten in jeder Zeile der Datei trennt. |
linesTerminatedBy |
Wird zum Trennen von Zeilen verwendet. Wenn eine Zeile nicht alle Felder enthält, werden die restlichen Spalten auf ihre Standardwerte gesetzt. |
SqlBakExportOptions
| JSON-Darstellung |
|---|
{
"striped": boolean,
"stripeCount": integer,
"bakType": enum ( |
| Felder | |
|---|---|
striped |
Gibt an, ob der Export gestreift werden soll. |
stripeCount |
Option zum Festlegen der Anzahl der Stripes, die für den Export verwendet werden sollen. Wenn leer und der Wert des gestreiften Felds „true“ ist, wird die Anzahl der Streifen automatisch ausgewählt. |
bakType |
Der Typ dieser BAK-Datei ist „export“, „FULL“ oder „DIFF“ (nur SQL Server). |
copyOnly |
Verworfen: „copy_only“ wird nicht mehr unterstützt. Stattdessen „differential_base“ verwenden |
differentialBase |
Gibt an, ob die Sicherung als differenzielle Basis verwendet werden kann. Eine copy_only-Sicherung kann nicht als differenzielle Basis verwendet werden. |
exportLogStartTime |
Optional. Der Zeitstempel für den Beginn, ab dem das Transaktionslog in den Exportvorgang einbezogen wird. RFC 3339-Format (z. B. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
exportLogEndTime |
Optional. Der Endzeitstempel, bis zu dem das Transaktionslog in den Exportvorgang einbezogen wird. RFC 3339-Format (z. B. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
SqlTdeExportOptions
| JSON-Darstellung |
|---|
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string } |
| Felder | |
|---|---|
certificatePath |
Erforderlich. Pfad zum öffentlichen Schlüssel des TDE-Zertifikats im Format „gs://bucketName/fileName“. Die Instanz muss Schreibzugriff auf den Bucket haben. Gilt nur für SQL Server-Instanzen. |
privateKeyPath |
Erforderlich. Pfad zum privaten Schlüssel des TDE-Zertifikats im Format gs://bucketName/fileName. Die Instanz muss Schreibzugriff auf den Speicherort haben. Gilt nur für SQL Server-Instanzen. |
privateKeyPassword |
Erforderlich. Passwort, mit dem der private Schlüssel verschlüsselt wird. |
name |
Erforderlich. Name des Zertifikats. Gilt nur für SQL Server-Instanzen. |
BackupContext
| JSON-Darstellung |
|---|
{ "backupId": string, "kind": string, "name": string } |
| Felder | |
|---|---|
backupId |
Die ID der Sicherung. |
kind |
Dies ist immer |
name |
Der Name der Sicherung. Format: projects/{project}/backups/{backup} |
PreCheckMajorVersionUpgradeContext
| JSON-Darstellung |
|---|
{ "targetDatabaseVersion": enum ( |
| Felder | |
|---|---|
targetDatabaseVersion |
Erforderlich. Die Zieldatenbankversion, auf die ein Upgrade durchgeführt werden soll. |
preCheckResponse[] |
Nur Ausgabe. Die Antworten aus der Vorabprüfung. |
kind |
Optional. Dies ist immer |
Union-Feld Für |
|
maxRuntime |
Optional. Die maximal zulässige Laufzeit für den Vorabcheck. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „ |
PreCheckResponse
| JSON-Darstellung |
|---|
{ "actionsRequired": [ string ], // Union field |
| Felder | |
|---|---|
actionsRequired[] |
Die Aktionen, die der Nutzer ausführen muss. Verwenden Sie „repeated“ für mehrere Aktionen. |
Union-Feld Für |
|
message |
Die Nachricht, die dem Nutzer angezeigt werden soll. |
Union-Feld Für |
|
messageType |
Der Typ der Nachricht, d. h. ob es sich um eine Information, eine Warnung oder einen Fehler handelt. |
Dauer
| JSON-Darstellung |
|---|
{ "seconds": string, "nanos": integer } |
| Felder | |
|---|---|
seconds |
Vorzeichenbehaftete Sekunden der Zeitspanne. Muss zwischen -315.576.000.000 und +315.576.000.000 (einschließlich) liegen. Hinweis: Diese Grenzen werden so berechnet: 60 Sek./Min. × 60 Min./Std. × 24 Std./Tag × 365,25 Tage/Jahr × 10.000 Jahre |
nanos |
Vorzeichenbehaftete Bruchteile einer Sekunde mit Nanosekundenauflösung des Zeitraums. Dauern von weniger als einer Sekunde werden mit dem Feld „0“ |
StartWorkloadCaptureContext
| JSON-Darstellung |
|---|
{ "enableLiveReplay": boolean, // Union field |
| Felder | |
|---|---|
enableLiveReplay |
Optional. Falls wahr, wird die erfasste Arbeitslast gleichzeitig auf einer separaten, kurzlebigen Cloud SQL-Instanz ausgeführt. Diese „Aufgezeichneter Livestream“-Instanz wird automatisch bereitgestellt und von der Quellinstanz geklont. Wenn „false“ (Standardeinstellung) festgelegt ist, wird die Arbeitslast nur gespeichert und es erfolgt keine Aufgezeichneter Livestream. Sie kann später mit einem separaten |
Union-Feld Für |
|
replayInstance |
Optional. Erforderlich, wenn |
StopWorkloadCaptureContext
| JSON-Darstellung |
|---|
{ "abortLiveReplay": boolean } |
| Felder | |
|---|---|
abortLiveReplay |
Optional. Wenn „true“, wird die gleichzeitige Aufgezeichneter Livestream sofort abgebrochen und der nicht wiedergegebene Traffic wird verworfen. Außerdem wird die Erfassung beendet. Wenn „false“ (Standardeinstellung) festgelegt ist, wird die Aufzeichnung von neuem Traffic beendet, aber der aufgezeichnete Livestream wird fortgesetzt, bis der gesamte Backlog des erfassten Traffics wiedergegeben wurde. |
StartWorkloadReplayContext
| JSON-Darstellung |
|---|
{ "replayInstance": string, "workloadId": string } |
| Felder | |
|---|---|
replayInstance |
Erforderlich. Der Name der Cloud SQL-Instanz, in der die erfasste Arbeitslast (SQL-Abfragen) ausgeführt wird, ohne die Projekt-ID (z. B. |
workloadId |
Nur Ausgabe. Die ID der Arbeitslast, die auf der Replay-Instanz ausgeführt werden soll. Für jede Arbeitslasterfassung wird eine eindeutige ID im Format |
AcquireSsrsLeaseContext
| JSON-Darstellung |
|---|
{ // Union field |
| Felder | |
|---|---|
Union-Feld Für |
|
setupLogin |
Der Nutzername, der als Einrichtungsanmeldung für die Verbindung mit dem Datenbankserver für die SSRS-Einrichtung verwendet werden soll. |
Union-Feld Für |
|
serviceLogin |
Der Nutzername, der als Dienstanmeldung für die Verbindung zur Berichtsdatenbank für die SSRS-Einrichtung verwendet werden soll. |
Union-Feld Für |
|
reportDatabase |
Die Berichtsdatenbank, die für die SSRS-Einrichtung verwendet werden soll. |
Union-Feld Für |
|
duration |
Für die SSRS-Einrichtung erforderliche Freigabedauer. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „ |
SqlSubOperationType
| JSON-Darstellung |
|---|
{ // Union field |
| Felder | |
|---|---|
Union-Feld sub_operation_details. Details zum Untervorgang, die dem Vorgangstyp entsprechen. Für sub_operation_details ist nur einer der folgenden Werte zulässig: |
|
maintenanceType |
Die Art der Wartung, die für die Instanz ausgeführt werden soll. |
SqlOperationStatus
Der Status eines Vorgangs.
| Enums | |
|---|---|
SQL_OPERATION_STATUS_UNSPECIFIED |
Der Status des Vorgangs ist unbekannt. |
PENDING |
Der Vorgang wurde in die Warteschlange gestellt, aber noch nicht gestartet. |
RUNNING |
Der Vorgang wird ausgeführt. |
DONE |
Der Vorgang ist abgeschlossen. |
SqlApiWarningCode
| Enums | |
|---|---|
SQL_API_WARNING_CODE_UNSPECIFIED |
Ein unbekannter oder nicht festgelegter Warnungstyp der Cloud SQL API. |
REGION_UNREACHABLE |
Warnung, wenn eine oder mehrere Regionen nicht erreichbar sind. Die zurückgegebene Ergebnismenge ist möglicherweise unvollständig. |
MAX_RESULTS_EXCEEDS_LIMIT |
Warnung, wenn der vom Nutzer angegebene Parameter „maxResults“ das Limit überschreitet. Die zurückgegebene Ergebnismenge ist möglicherweise unvollständig. |
COMPROMISED_CREDENTIALS |
Warnung, wenn ein Nutzer versucht, einen Nutzer mit Anmeldedaten zu erstellen oder zu aktualisieren, die zuvor durch eine öffentliche Datenpanne kompromittiert wurden. |
INTERNAL_STATE_FAILURE |
Warnung, wenn der Vorgang erfolgreich ist, aber ein nicht kritischer Workflowstatus fehlgeschlagen ist. |
SqlOperationType
Der Typ des Cloud SQL-Vorgangs.
| Enums | |
|---|---|
SQL_OPERATION_TYPE_UNSPECIFIED |
Unbekannter Vorgangstyp. |
IMPORT |
Importiert Daten in eine Cloud SQL-Instanz. |
EXPORT |
Exportiert Daten aus einer Cloud SQL-Instanz in einen Cloud Storage-Bucket. |
CREATE |
Erstellt eine neue Cloud SQL-Instanz. |
UPDATE |
Aktualisiert die Einstellungen einer Cloud SQL-Instanz. |
DELETE |
Löscht eine Cloud SQL-Instanz. |
RESTART |
Startet die Cloud SQL-Instanz neu. |
BACKUP |
|
SNAPSHOT |
|
BACKUP_VOLUME |
Führt eine Instanzsicherung durch. |
DELETE_VOLUME |
Löscht eine Instanzsicherung. |
RESTORE_VOLUME |
Stellt eine Instanzsicherung wieder her. |
INJECT_USER |
Fügt einen privilegierten Nutzer in MySQL für MOB-Instanzen ein. |
CLONE |
Klont eine Cloud SQL-Instanz. |
STOP_REPLICA |
Beendet die Replikation auf einer Cloud SQL-Lesereplikatinstanz. |
START_REPLICA |
Startet die Replikation auf einer Cloud SQL-Lesereplikatinstanz. |
PROMOTE_REPLICA |
Stuft eine Cloud SQL-Replikatinstanz hoch. |
CREATE_REPLICA |
Erstellt eine Cloud SQL-Replikatinstanz. |
CREATE_USER |
Erstellt einen neuen Nutzer in einer Cloud SQL-Instanz. |
DELETE_USER |
Löscht einen Nutzer aus einer Cloud SQL-Instanz. |
UPDATE_USER |
Aktualisiert einen vorhandenen Nutzer in einer Cloud SQL-Instanz. Wenn kein Nutzer mit dem angegebenen Nutzernamen vorhanden ist, wird ein neuer Nutzer erstellt. |
CREATE_DATABASE |
Erstellt eine Datenbank in der Cloud SQL-Instanz. |
DELETE_DATABASE |
Löscht eine Datenbank in der Cloud SQL-Instanz. |
UPDATE_DATABASE |
Aktualisiert eine Datenbank in der Cloud SQL-Instanz. |
FAILOVER |
Führt ein Failover eines HA-fähigen Cloud SQL-Failover-Replikats durch. |
DELETE_BACKUP |
Löscht die Sicherung, die von einem Sicherungslauf erstellt wurde. |
RECREATE_REPLICA |
|
TRUNCATE_LOG |
Kürzt eine allgemeine oder langsame Logtabelle in MySQL. |
DEMOTE_MASTER |
Die eigenständige Instanz wird als Cloud SQL-Lesereplikat für einen externen Datenbankserver abgewertet. |
MAINTENANCE |
Gibt an, dass die Instanz derzeit gewartet wird. Normalerweise führt dies dazu, dass die Instanz 1 bis 3 Minuten lang nicht verfügbar ist. |
ENABLE_PRIVATE_IP |
Dieses Feld ist veraltet und wird in einer zukünftigen Version der API entfernt. |
DEFER_MAINTENANCE |
|
CREATE_CLONE |
Erstellt eine Kloninstanz. |
RESCHEDULE_MAINTENANCE |
Verschieben Sie die Wartung auf einen anderen Zeitpunkt. |
START_EXTERNAL_SYNC |
Startet die externe Synchronisierung eines Cloud SQL-EM-Replikats mit einer externen Primärinstanz. |
LOG_CLEANUP |
Stellt Logs vom alten Datenlaufwerk einer Instanz wieder her. |
AUTO_RESTART |
Führt einen automatischen Neustart einer Cloud SQL-Datenbank mit Hochverfügbarkeit zur automatischen Wiederherstellung durch. |
REENCRYPT |
Verschlüsselt CMEK-Instanzen mit der neuesten Schlüsselversion neu. |
SWITCHOVER |
Wechselt die Rollen des primären und des Replikatpaars. Die Zielinstanz sollte das Replikat sein. |
UPDATE_BACKUP |
Eine Sicherung aktualisieren. |
ACQUIRE_SSRS_LEASE |
Erwerben Sie eine Lease für die Einrichtung von SQL Server Reporting Services (SSRS). |
RELEASE_SSRS_LEASE |
Geben Sie eine Lease für die Einrichtung von SQL Server Reporting Services (SSRS) frei. |
RECONFIGURE_OLD_PRIMARY |
Konfiguriert die alte primäre Instanz nach einem Vorgang zum Hochstufen eines Replikats neu. Die Auswirkungen eines Hochstufungsvorgangs auf die alte primäre Instanz werden in diesem Vorgang asynchron zum Hochstufungsvorgang für das Replikat ausgeführt. |
CLUSTER_MAINTENANCE |
Gibt an, dass die Instanz, ihre Lesereplikate und ihre kaskadierenden Replikate gewartet werden. Die Wartung wird in der Regel zuerst für Gruppen von Replikaten und dann für die primäre Instanz initiiert. Normalerweise führt dies dazu, dass die Instanz 1 bis 3 Minuten lang nicht verfügbar ist. |
SELF_SERVICE_MAINTENANCE |
Gibt an, dass die Instanz (und alle ihre Replikate) derzeit gewartet werden. Dies wird als Self-Service-Anfrage über SSM initiiert. Normalerweise führt dies dazu, dass die Instanz 1 bis 3 Minuten lang nicht verfügbar ist. |
SWITCHOVER_TO_REPLICA |
Wechselt eine primäre Instanz zu einem Replikat. Dieser Vorgang wird im Rahmen eines Switchover-Vorgangs zur ursprünglichen primären Instanz ausgeführt. |
MAJOR_VERSION_UPGRADE |
Aktualisiert die Hauptversion einer Cloud SQL-Instanz. |
ADVANCED_BACKUP |
Verworfen: ADVANCED_BACKUP wurde verworfen. Verwenden Sie stattdessen ENHANCED_BACKUP. |
MANAGE_BACKUP |
Ändert die BackupTier einer Cloud SQL-Instanz. |
ENHANCED_BACKUP |
Erstellt eine Sicherung für eine Cloud SQL-Instanz der erweiterten Sicherungsstufe. |
REPAIR_READ_POOL |
Repariert den gesamten Lesepool oder bestimmte Lesepoolknoten im Lesepool. |
CREATE_READ_POOL |
Erstellt eine Cloud SQL-Lesepoolinstanz. |
PRE_CHECK_MAJOR_VERSION_UPGRADE |
Führt eine Vorabprüfung des Upgrades der Hauptversion durch. |
SETUP_MIGRATION |
Dieser Vorgangstyp stellt einzelne Schritte in einem mehrstufigen Migrationsworkflow dar, einschließlich Konfiguration, Replikation, Switchover/Back und Data Reseeding, wie durch die Absicht des Vorgangs definiert. |
CREATE_BLUE_GREEN_DEPLOYMENT |
Erstellt eine neue Blau/Grün-Bereitstellung. |
SWITCHOVER_BLUE_GREEN_DEPLOYMENT |
Führt einen Wechsel bei einer Blau/Grün-Bereitstellung durch. |
DELETE_BLUE_GREEN_DEPLOYMENT |
Löscht eine Blau/Grün-Bereitstellung. |
SqlFileType
| Enums | |
|---|---|
SQL_FILE_TYPE_UNSPECIFIED |
Unbekannter Dateityp. |
SQL |
Datei mit SQL-Anweisungen. |
CSV |
Datei im CSV-Format. |
BAK |
|
TDE |
TDE-Zertifikat. |
BakType
| Enums | |
|---|---|
BAK_TYPE_UNSPECIFIED |
Standardtyp. |
FULL |
Vollsicherung |
DIFF |
Differenzielles Backup |
TLOG |
Sicherung des Transaktionslogs |
SqlDatabaseVersion
Der Typ und die Version der Datenbank-Engine.
| Enums | |
|---|---|
SQL_DATABASE_VERSION_UNSPECIFIED |
Dies ist eine unbekannte Datenbankversion. |
MYSQL_5_1 |
Die Datenbankversion ist MySQL 5.1. |
MYSQL_5_5 |
Die Datenbankversion ist MySQL 5.5. |
MYSQL_5_6 |
Die Datenbankversion ist MySQL 5.6. |
MYSQL_5_7 |
Die Datenbankversion ist MySQL 5.7. |
MYSQL_8_0 |
Die Datenbankversion ist MySQL 8. |
MYSQL_8_0_18 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 18. |
MYSQL_8_0_26 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 26. |
MYSQL_8_0_27 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 27. |
MYSQL_8_0_28 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 28. |
MYSQL_8_0_29 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 29. |
MYSQL_8_0_30 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 30. |
MYSQL_8_0_31 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 31. |
MYSQL_8_0_32 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 32. |
MYSQL_8_0_33 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 33. |
MYSQL_8_0_34 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 34. |
MYSQL_8_0_35 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 35. |
MYSQL_8_0_36 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 36. |
MYSQL_8_0_37 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 37. |
MYSQL_8_0_39 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 39. |
MYSQL_8_0_40 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 40. |
MYSQL_8_0_41 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 41. |
MYSQL_8_0_42 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 42. |
MYSQL_8_0_43 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 43. |
MYSQL_8_0_44 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 44. |
MYSQL_8_0_45 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 45. |
MYSQL_8_0_46 |
Die Hauptversion der Datenbank ist MySQL 8.0 und die Nebenversion ist 46. |
MYSQL_8_4 |
Die Datenbankversion ist MySQL 8.4. |
MYSQL_9_7 |
Die Datenbankversion ist MySQL 9.7. |
SQLSERVER_2017_STANDARD |
Die Datenbankversion ist SQL Server 2017 Standard. |
SQLSERVER_2017_ENTERPRISE |
Die Datenbankversion ist SQL Server 2017 Enterprise. |
SQLSERVER_2017_EXPRESS |
Die Datenbankversion ist SQL Server 2017 Express. |
SQLSERVER_2017_WEB |
Die Datenbankversion ist SQL Server 2017 Web. |
POSTGRES_9_6 |
Die Datenbankversion ist PostgreSQL 9,6. |
POSTGRES_10 |
Die Datenbankversion ist PostgreSQL 10. |
POSTGRES_11 |
Die Datenbankversion ist PostgreSQL 11. |
POSTGRES_12 |
Die Datenbankversion ist PostgreSQL 12. |
POSTGRES_13 |
Die Datenbankversion ist PostgreSQL 13. |
POSTGRES_14 |
Die Datenbankversion ist PostgreSQL 14. |
POSTGRES_15 |
Die Datenbankversion ist PostgreSQL 15. |
POSTGRES_16 |
Die Datenbankversion ist PostgreSQL 16. |
POSTGRES_17 |
Die Datenbankversion ist PostgreSQL 17. |
POSTGRES_18 |
Die Datenbankversion ist PostgreSQL 18. |
POSTGRES_19 |
Die Datenbankversion ist PostgreSQL 19. |
POSTGRES_20 |
Die Datenbankversion ist PostgreSQL 20. |
SQLSERVER_2019_STANDARD |
Die Datenbankversion ist SQL Server 2019 Standard. |
SQLSERVER_2019_ENTERPRISE |
Die Datenbankversion ist SQL Server 2019 Enterprise. |
SQLSERVER_2019_EXPRESS |
Die Datenbankversion ist SQL Server 2019 Express. |
SQLSERVER_2019_WEB |
Die Datenbankversion ist SQL Server 2019 Web. |
SQLSERVER_2022_STANDARD |
Die Datenbankversion ist SQL Server 2022 Standard. |
SQLSERVER_2022_ENTERPRISE |
Die Datenbankversion ist SQL Server 2022 Enterprise. |
SQLSERVER_2022_EXPRESS |
Die Datenbankversion ist SQL Server 2022 Express. |
SQLSERVER_2022_WEB |
Die Datenbankversion ist SQL Server 2022 Web. |
SQLSERVER_2025_STANDARD |
Die Datenbankversion ist SQL Server 2025 Standard. |
SQLSERVER_2025_ENTERPRISE |
Die Datenbankversion ist SQL Server 2025 Enterprise. |
SQLSERVER_2025_EXPRESS |
Die Datenbankversion ist SQL Server 2025 Express. |
MessageType
Der Nachrichtentyp, der eine Information, eine Warnung oder ein Fehler sein kann, der eine Nutzeraktion erfordert.
| Enums | |
|---|---|
MESSAGE_TYPE_UNSPECIFIED |
Standardwert, wenn nichts angegeben ist, um unbeabsichtigte Verhaltensänderungen zu verhindern. |
INFO |
Allgemeine Informationsnachrichten, die keine Aktion erfordern. |
WARNING |
Warnungen, die sich auf das Upgrade auswirken können, es aber nicht blockieren. |
ERROR |
Fehler, die ein Nutzer beheben muss, bevor er mit dem Upgrade fortfahren kann. |
SqlMaintenanceType
Die Art der Wartung, die für die Instanz ausgeführt werden soll.
| Enums | |
|---|---|
SQL_MAINTENANCE_TYPE_UNSPECIFIED |
Der Wartungstyp ist nicht angegeben. |
INSTANCE_MAINTENANCE |
Gibt an, dass eine eigenständige Instanz gewartet wird. Die Instanz kann entweder eine primäre Instanz oder ein Replikat sein. |
REPLICA_INCLUDED_MAINTENANCE |
Gibt an, dass die primäre Instanz und alle ihre Replikate, einschließlich kaskadierender Replikate, gewartet werden. Die Wartung wird zuerst für Gruppen von Replikaten und dann für die primäre Instanz durchgeführt. |
INSTANCE_SELF_SERVICE_MAINTENANCE |
Gibt an, dass die eigenständige Instanz gewartet wird, was über den Self-Service initiiert wurde. Die Instanz kann entweder eine primäre Instanz oder ein Replikat sein. |
REPLICA_INCLUDED_SELF_SERVICE_MAINTENANCE |
Gibt an, dass die primäre Instanz und alle ihre Replikate gewartet werden, was durch Self-Service initiiert wurde. Die Wartung wird zuerst für Gruppen von Replikaten und dann für die primäre Instanz durchgeführt. |
Tool-Annotationen
Tool-Anmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können jedoch verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet werden soll.
Zusammen mit dem Titelstring werden die folgenden booleschen Hinweise so definiert:
readOnlyHint: Wenn „true“, ändert das Tool seine Umgebung nicht. Standardeinstellung: false.destructiveHint: Wenn „true“, kann das Tool destruktive Aktionen ausführen. Wenn „false“, kann das Tool nur additive Aktionen ausführen. Standardeinstellung: true.idempotentHint: Wenn „true“, hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf die Umgebung. Standardeinstellung: false.openWorldHint: Wenn „true“, kann das Tool mit einer „offenen Welt“ externer Entitäten interagieren. Wenn „false“, kann das Tool nur mit internen Entitäten interagieren. Ein Websuchtool wäre beispielsweise ein Open-World-Tool, ein Speichertool dagegen nicht.
Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ❌ | Hinweis „Lesezugriff“: ❌ | Hinweis „Open World“: ❌