כלי: get_operation
אחזור הסטטוס של פעולה ממושכת. פעולה ממושכת יכולה להימשך כמה דקות. אם פעולה מסוימת נמשכת זמן רב, כדאי להשתמש בכלי של שורת הפקודה כדי להשהות אותה למשך 30 שניות לפני שבודקים שוב את הסטטוס שלה.
בדוגמה הבאה אפשר לראות איך משתמשים ב-curl כדי להפעיל את כלי ה-MCP get_operation.
| בקשת Curl |
|---|
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": "get_operation", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
סכימת הקלט
בקשת קבלת פעולות.
SqlOperationsGetRequest
| ייצוג ב-JSON |
|---|
{ "operation": string, "project": string } |
| שדות | |
|---|---|
operation |
חובה. מזהה פעולה של מופע. |
project |
חובה. מזהה הפרויקט שמכיל את המופע. |
סכימת פלט
משאב Operation. בפעולות מוצלחות שמחזירות משאב Operation, רק השדות שרלוונטיים לפעולה מאוכלסים במשאב.
פעולה
| ייצוג ב-JSON |
|---|
{ "kind": string, "targetLink": string, "status": enum ( |
| שדות | |
|---|---|
kind |
הערך הזה תמיד יהיה |
targetLink |
|
status |
הסטטוס של פעולה. |
user |
כתובת האימייל של המשתמש שהפעיל את הפעולה הזו. |
insertTime |
השעה שבה הפעולה הזו נוספה לתור, לפי שעון UTC, בפורמט RFC 3339. לדוגמה: הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
startTime |
השעה שבה הפעולה הזו התחילה בפועל באזור הזמן UTC בפורמט RFC 3339, לדוגמה הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
endTime |
השעה שבה הפעולה הזו הסתיימה לפי שעון UTC, בפורמט RFC 3339. לדוגמה: הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
error |
אם אירעו שגיאות במהלך עיבוד הפעולה הזו, השדה הזה יאוכלס. |
apiWarning |
הודעת אזהרה של Admin API. |
operationType |
סוג הפעולה. הערכים התקפים הם: * |
importContext |
ההקשר של פעולת הייבוא, אם רלוונטי. |
exportContext |
ההקשר של פעולת הייצוא, אם רלוונטי. |
backupContext |
ההקשר של פעולת הגיבוי, אם רלוונטי. |
preCheckMajorVersionUpgradeContext |
השדה הזה מאוכלס רק כשערך operation_type הוא PRE_CHECK_MAJOR_VERSION_UPGRADE. ההודעה PreCheckMajorVersionUpgradeContext עצמה מכילה את הפרטים של הבדיקה המוקדמת, כמו גרסת מסד הנתונים של היעד לשדרוג והתוצאות של הבדיקה (כולל אזהרות או שגיאות שנמצאו). |
name |
מזהה שמזהה באופן ייחודי את הפעולה. אפשר להשתמש במזהה הזה כדי לאחזר את משאב הפעולות שמכיל מידע על הפעולה. |
targetId |
שם המשאב שבו הפעולה הזו מופעלת. |
selfLink |
ה-URI של מקור המידע הזה. |
targetProject |
מזהה הפרויקט של מופע היעד שקשור לפעולה הזו. |
acquireSsrsLeaseContext |
ההקשר של פעולת השגת חכירה של SSRS, אם רלוונטי. |
subOperationType |
זה שינוי אופציונלי. פעולת המשנה על סמך סוג הפעולה. |
חותמת הזמן
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
מייצג את מספר השניות מאז ראשית זמן יוניקס (Unix epoch) ב-1 בינואר 1970 בשעה 00:00:00 UTC. הערך חייב להיות בין -62135596800 ל-253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z). |
nanos |
שברים לא שליליים של שנייה ברזולוציית ננו-שנייה. השדה הזה מייצג את החלק של הננו-שניות במשך הזמן, ולא מהווה חלופה לשניות. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שסופרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל. |
OperationErrors
| ייצוג ב-JSON |
|---|
{
"kind": string,
"errors": [
{
object ( |
| שדות | |
|---|---|
kind |
הערך הזה תמיד יהיה |
errors[] |
רשימת השגיאות שנתקלו בהן במהלך עיבוד הפעולה הזו. |
OperationError
| ייצוג ב-JSON |
|---|
{ "kind": string, "code": string, "message": string } |
| שדות | |
|---|---|
kind |
הערך הזה תמיד יהיה |
code |
מזהה את השגיאה הספציפית שאירעה. |
message |
מידע נוסף על השגיאה שנתקלתם בה. |
ApiWarning
| ייצוג ב-JSON |
|---|
{
"code": enum ( |
| שדות | |
|---|---|
code |
קוד שמזהה באופן ייחודי את סוג האזהרה. |
message |
הודעת האזהרה. |
region |
שם האזור שמופיע באזהרה REGION_UNREACHABLE. |
ImportContext
| ייצוג ב-JSON |
|---|
{ "uri": string, "database": string, "kind": string, "fileType": enum ( |
| שדות | |
|---|---|
uri |
הנתיב לקובץ הייבוא ב-Cloud Storage, בפורמט |
database |
מסד הנתונים שאליו רוצים לייבא. אם הערך של |
kind |
הערך הזה תמיד יהיה |
fileType |
סוג הקובץ של ה-URI שצוין.`SQL |
csvImportOptions |
אפשרויות לייבוא נתונים כקובץ CSV. |
importUser |
המשתמש ב-PostgreSQL עבור פעולת הייבוא הזו. מכונות PostgreSQL בלבד. |
bakImportOptions |
ייבוא פרמטרים שספציפיים לקובצי .BAK של SQL Server |
sqlImportOptions |
זה שינוי אופציונלי. אפשרויות לייבוא נתונים מהצהרות SQL. |
tdeImportOptions |
זה שינוי אופציונלי. ייבוא פרמטרים שספציפיים לאישורי TDE של SQL Server |
SqlCsvImportOptions
| ייצוג ב-JSON |
|---|
{ "table": string, "columns": [ string ], "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string } |
| שדות | |
|---|---|
table |
הטבלה שאליה מייבאים את נתוני ה-CSV. |
columns[] |
העמודות שאליהן יובאו נתוני ה-CSV. אם לא מציינים עמודות, כל העמודות בטבלת מסד הנתונים נטענות עם נתוני ה-CSV. |
escapeCharacter |
מציין את התו שצריך להופיע לפני תו נתונים שצריך להוסיף לו תו בריחה. |
quoteCharacter |
מציין את תו המירכאות שבו צריך להשתמש כשמצטטים ערך נתונים. |
fieldsTerminatedBy |
מציינת את התו שמפריד בין העמודות בכל שורה בקובץ. |
linesTerminatedBy |
התו הזה משמש להפרדה בין שורות. אם שורה לא מכילה את כל השדות, שאר העמודות מוגדרות לערכי ברירת המחדל שלהן. |
SqlBakImportOptions
| ייצוג ב-JSON |
|---|
{ "encryptionOptions": { object ( |
| שדות | |
|---|---|
encryptionOptions |
|
striped |
האם קבוצת הגיבוי שמשוחזרת היא מסוג striped. ההגדרה חלה רק על Cloud SQL ל-SQL Server. |
noRecovery |
האם ייבוא הגיבוי ישחזר את מסד הנתונים עם האפשרות NORECOVERY. ההגדרה חלה רק על Cloud SQL ל-SQL Server. |
recoveryOnly |
האם בקשת הייבוא של הגיבוי תעביר את מסד הנתונים למצב אונליין בלי להוריד את תוכן ה-Bak. אפשר להגדיר רק אחד מהערכים no_recovery ו-recovery_only כ-true, אחרת תוחזר שגיאה. ההגדרה חלה רק על Cloud SQL ל-SQL Server. |
bakType |
סוג התוכן של קובץ ה-bak, FULL או DIFF |
stopAt |
זה שינוי אופציונלי. חותמת הזמן שבה הייבוא אמור להסתיים. חותמת הזמן הזו היא בפורמט RFC 3339 (לדוגמה, הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
stopAtMark |
זה שינוי אופציונלי. העסקה המסומנת שבה הייבוא אמור להיפסק. השדה הזה מקביל למילת המפתח STOPATMARK והוא חל רק על Cloud SQL ל-SQL Server. |
EncryptionOptions
| ייצוג ב-JSON |
|---|
{ "certPath": string, "pvkPath": string, "pvkPassword": string, "keepEncrypted": boolean } |
| שדות | |
|---|---|
certPath |
הנתיב לאישור (.cer) ב-Cloud Storage, בפורמט |
pvkPath |
הנתיב למפתח הפרטי של האישור (.pvk) ב-Cloud Storage, בפורמט |
pvkPassword |
הסיסמה שמצפינה את המפתח הפרטי |
keepEncrypted |
זה שינוי אופציונלי. האם הקובץ המיובא נשאר מוצפן. |
BoolValue
| ייצוג ב-JSON |
|---|
{ "value": boolean } |
| שדות | |
|---|---|
value |
הערך הבוליאני. |
SqlImportOptions
| ייצוג ב-JSON |
|---|
{
"threads": integer,
"parallel": boolean,
"postgresImportOptions": {
object ( |
| שדות | |
|---|---|
threads |
זה שינוי אופציונלי. מספר השרשורים שבהם יש להשתמש לייבוא מקביל. |
parallel |
זה שינוי אופציונלי. האם הייבוא צריך להתבצע במקביל. |
postgresImportOptions |
זה שינוי אופציונלי. אפשרויות לייבוא ממופע של Cloud SQL ל-PostgreSQL. |
Int32Value
| ייצוג ב-JSON |
|---|
{ "value": integer } |
| שדות | |
|---|---|
value |
הערך int32. |
PostgresImportOptions
| ייצוג ב-JSON |
|---|
{ "clean": boolean, "ifExists": boolean } |
| שדות | |
|---|---|
clean |
זה שינוי אופציונלי. הדגל --clean לכלי השירות pg_restore. הדגל הזה רלוונטי רק אם הפעלתם ב-Cloud SQL ייבוא מקביל של קבצים. |
ifExists |
זה שינוי אופציונלי. הדגל --if-exists לכלי pg_restore. הדגל הזה רלוונטי רק אם הפעלתם ב-Cloud SQL ייבוא מקביל של קבצים. |
SqlTdeImportOptions
| ייצוג ב-JSON |
|---|
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string } |
| שדות | |
|---|---|
certificatePath |
חובה. הנתיב למפתח הציבורי של אישור TDE בפורמט gs://bucketName/fileName. למופע צריכה להיות הרשאת קריאה לקובץ. רלוונטי רק למופעי SQL Server. |
privateKeyPath |
חובה. הנתיב למפתח הפרטי של אישור ה-TDE בפורמט gs://bucketName/fileName. למופע צריכה להיות הרשאת קריאה לקובץ. רלוונטי רק למופעי SQL Server. |
privateKeyPassword |
חובה. הסיסמה שמצפינה את המפתח הפרטי. |
name |
חובה. שם האישור. רלוונטי רק למופעי SQL Server. |
ExportContext
| ייצוג ב-JSON |
|---|
{ "uri": string, "databases": [ string ], "kind": string, "sqlExportOptions": { object ( |
| שדות | |
|---|---|
uri |
הנתיב לקובץ ב-Google Cloud Storage שבו יישמר הייצוא. ה-URI הוא בפורמט |
databases[] |
מסדי הנתונים שרוצים לייצא. |
kind |
הערך הזה תמיד יהיה |
sqlExportOptions |
אפשרויות לייצוא נתונים כהצהרות SQL. |
csvExportOptions |
אפשרויות לייצוא נתונים כקובץ CSV. רק מקרים של |
fileType |
סוג הקובץ של ה-URI שצוין. |
offload |
האם לבצע ייצוא בלי שרת (serverless). |
bakExportOptions |
אפשרויות לייצוא נתונים כקבצי BAK. |
tdeExportOptions |
זה שינוי אופציונלי. פרמטרים של ייצוא שספציפיים לאישורים של SQL Server TDE |
SqlExportOptions
| ייצוג ב-JSON |
|---|
{ "tables": [ string ], "schemaOnly": boolean, "mysqlExportOptions": { object ( |
| שדות | |
|---|---|
tables[] |
טבלאות לייצוא, או טבלאות שיוצאו, ממסד הנתונים שצוין. אם מציינים טבלאות, צריך לציין מסד נתונים אחד בלבד. במקרים של מופעי PostgreSQL, אפשר לציין רק טבלה אחת. |
schemaOnly |
ייצוא של סכימות בלבד. |
mysqlExportOptions |
|
threads |
זה שינוי אופציונלי. מספר השרשורים שבהם יש להשתמש לייצוא מקביל. |
parallel |
זה שינוי אופציונלי. האם הייצוא צריך להתבצע במקביל. |
postgresExportOptions |
זה שינוי אופציונלי. אפשרויות לייצוא ממכונת Cloud SQL ל-PostgreSQL. |
MysqlExportOptions
| ייצוג ב-JSON |
|---|
{ "masterData": integer } |
| שדות | |
|---|---|
masterData |
אפשרות לכלול הצהרת SQL שנדרשת להגדרת השכפול. אם הערך מוגדר ל- |
PostgresExportOptions
| ייצוג ב-JSON |
|---|
{ "clean": boolean, "ifExists": boolean } |
| שדות | |
|---|---|
clean |
זה שינוי אופציונלי. משתמשים באפשרות הזו כדי לכלול DROP
הצהרות SQL. אפשר להשתמש בהצהרות האלה כדי למחוק אובייקטים של מסד נתונים לפני שמריצים את פעולת הייבוא. |
ifExists |
זה שינוי אופציונלי. אפשרות לכלול הצהרת SQL של IF EXISTS בכל הצהרת DROP שנוצרת על ידי clean. |
SqlCsvExportOptions
| ייצוג ב-JSON |
|---|
{ "selectQuery": string, "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string } |
| שדות | |
|---|---|
selectQuery |
שאילתת הבחירה שמשמשת לחילוץ הנתונים. |
escapeCharacter |
מציין את התו שצריך להופיע לפני תו נתונים שצריך להוסיף לו תו בריחה. |
quoteCharacter |
מציין את תו המירכאות שבו צריך להשתמש כשמצטטים ערך נתונים. |
fieldsTerminatedBy |
מציינת את התו שמפריד בין העמודות בכל שורה בקובץ. |
linesTerminatedBy |
התו הזה משמש להפרדה בין שורות. אם שורה לא מכילה את כל השדות, שאר העמודות מוגדרות לערכי ברירת המחדל שלהן. |
SqlBakExportOptions
| ייצוג ב-JSON |
|---|
{
"striped": boolean,
"stripeCount": integer,
"bakType": enum ( |
| שדות | |
|---|---|
striped |
האם הייצוא צריך להיות מפוספס. |
stripeCount |
אפשרות לציין כמה פסים ישמשו לייצוא. אם השדה ריק והערך של השדה המפוספס הוא true, מספר הפסים נבחר באופן אוטומטי. |
bakType |
הסוג של קובץ ה-bak הזה יהיה export, FULL או DIFF, רק ב-SQL Server |
copyOnly |
הוצא משימוש: התכונה copy_only הוצאה משימוש. במקום זאת, אפשר להשתמש ב-differential_base |
differentialBase |
האם אפשר להשתמש בגיבוי כגיבוי דיפרנציאלי של עותק בלבד. אי אפשר להשתמש בגיבוי כגיבוי דיפרנציאלי |
exportLogStartTime |
זה שינוי אופציונלי. חותמת הזמן של תחילת התקופה שיומן העסקאות ייכלל בייצוא. פורמט RFC 3339 (לדוגמה, הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
exportLogEndTime |
זה שינוי אופציונלי. חותמת הזמן של הסיום שבה יומן העסקאות ייכלל בפעולת הייצוא. פורמט RFC 3339 (לדוגמה, הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
SqlTdeExportOptions
| ייצוג ב-JSON |
|---|
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string } |
| שדות | |
|---|---|
certificatePath |
חובה. הנתיב למפתח הציבורי של אישור TDE בפורמט gs://bucketName/fileName. למופע צריכה להיות גישת כתיבה לקטגוריה. רלוונטי רק למופעי SQL Server. |
privateKeyPath |
חובה. הנתיב למפתח הפרטי של אישור ה-TDE בפורמט gs://bucketName/fileName. למכונה צריכה להיות הרשאת כתיבה למיקום. רלוונטי רק למופעי SQL Server. |
privateKeyPassword |
חובה. הסיסמה שמצפינה את המפתח הפרטי. |
name |
חובה. שם האישור. רלוונטי רק למופעי SQL Server. |
BackupContext
| ייצוג ב-JSON |
|---|
{ "backupId": string, "kind": string, "name": string } |
| שדות | |
|---|---|
backupId |
המזהה של הגיבוי. |
kind |
הערך הזה תמיד יהיה |
name |
שם הגיבוי. פורמט: projects/{project}/backups/{backup} |
PreCheckMajorVersionUpgradeContext
| ייצוג ב-JSON |
|---|
{ "targetDatabaseVersion": enum ( |
| שדות | |
|---|---|
targetDatabaseVersion |
חובה. גרסת מסד הנתונים שאליה רוצים לשדרג. |
preCheckResponse[] |
פלט בלבד. התשובות שמתקבלות מהפעולה של בדיקה מוקדמת. |
kind |
זה שינוי אופציונלי. הערך הזה תמיד יהיה |
PreCheckResponse
| ייצוג ב-JSON |
|---|
{ "actionsRequired": [ string ], // Union field |
| שדות | |
|---|---|
actionsRequired[] |
הפעולות שהמשתמש צריך לבצע. אפשר להשתמש בפקודה 'חזרה' לכמה פעולות. |
שדה איחוד הערך |
|
message |
ההודעה שתוצג למשתמש. |
שדה איחוד הערך |
|
messageType |
סוג ההודעה: מידע, אזהרה או שגיאה. |
AcquireSsrsLeaseContext
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד הערך |
|
setupLogin |
שם המשתמש שישמש להתחברות לצורך ההגדרה כדי להתחבר לשרת מסד הנתונים להגדרת SSRS. |
שדה איחוד הערך |
|
serviceLogin |
שם המשתמש שישמש להתחברות לשירות כדי להתחבר למסד הנתונים של הדוחות לצורך הגדרת SSRS. |
שדה איחוד הערך |
|
reportDatabase |
מסד הנתונים של הדוחות שבו יש להשתמש להגדרת SSRS. |
שדה איחוד הערך |
|
duration |
נדרש משך חכירה להגדרת SSRS. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-' |
משך הזמן
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
השניות החתומות של טווח הזמן. הערך חייב להיות בין -315,576,000,000 לבין +315,576,000,000, כולל. הערה: הגבולות האלה מחושבים לפי: 60 שניות/דקה * 60 דקות/שעה * 24 שעות/יום * 365.25 ימים/שנה * 10,000 שנים |
nanos |
שברים חתומים של שנייה ברזולוציית ננו-שנייה של טווח הזמן. משכי זמן של פחות משנייה אחת מיוצגים באמצעות שדה |
SqlSubOperationType
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד sub_operation_details. פרטים של פעולות משנה שמתאימים לסוג הפעולה. הערך sub_operation_details יכול להיות רק אחד מהבאים: |
|
maintenanceType |
סוג התחזוקה שיבוצע במכונה. |
הערות על כלי
רמז הרסני: ❌ | רמז אידמפוטנטי: ❌ | רמז לקריאה בלבד: ✅ | רמז לעולם פתוח: ❌