Halaman ini menjelaskan cara mengelola siklus proses Operasi Berjalan Lama (LRO) Financial Services API.
Operasi yang Berjalan Lama ditampilkan saat panggilan
metode mungkin memerlukan waktu lama untuk diselesaikan. Misalnya, Financial Services API
membuat LRO setiap kali Anda memanggil
projects.locations.instances.create
.
LRO melacak status tugas pemrosesan.
Anda dapat menggunakan metode projects.locations.operations
yang disediakan oleh Financial Services API untuk memeriksa status
LROs. Anda juga dapat mencantumkan, membatalkan,
atau menghapus LRO.
LRO dikelola di level project dan lokasi Google Cloud. Saat membuat permintaan ke API, sertakan project Google Cloud dan lokasi tempat LRO berjalan.
Data LRO disimpan selama sekitar 30 hari setelah LRO selesai. Anda tidak dapat melihat atau mencantumkan LRO setelah titik tersebut.
Mendapatkan detail tentang operasi yang berjalan lama
Misalkan Anda membuat instance.
Nilai name
dalam respons menunjukkan bahwa Financial Services API
membuat LRO bernama projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID
.
Gunakan metode projects.locations.operations.get
untuk memeriksa apakah instance telah dibuat. Jika respons berisi
"done": false
, ulangi perintah hingga respons berisi "done": true
.
Operasi ini dapat memerlukan waktu hingga beberapa menit untuk selesai.
Anda juga dapat mengambil nama LRO dengan mencantumkan operasi yang berjalan lama.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
PROJECT_ID
: project ID Google Cloud Anda yang tercantum di Setelan IAMLOCATION
: lokasi instance; gunakan salah satu region yang didukungMenampilkan lokasius-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
OPERATION_ID
: ID untuk operasi
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID" | Select-Object -Expand Content
Anda akan melihat respons JSON seperti berikut:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": "2023-03-14T15:52:55.358979323Z", "endTime": "2023-03-14T16:52:55.358979323Z", "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": true, "response": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.Instance", "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "state": "ACTIVE", "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID" } }
Membuat daftar operasi yang berjalan lama
Gunakan metode projects.locations.operations.list
untuk mencantumkan semua operasi di lokasi tertentu.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
PROJECT_ID
: project ID Google Cloud Anda yang tercantum di Setelan IAMLOCATION
: lokasi operasi; gunakan salah satu region yang didukungMenampilkan lokasius-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations" | Select-Object -Expand Content
Anda akan melihat respons JSON seperti berikut:
{ "operations": [ { "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": "2023-03-14T15:52:55.358979323Z", "endTime": "2023-03-14T16:52:55.358979323Z", "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineConfigs/ENGINE_CONFIG_ID", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }, { "name": "projects/PROJECT_ID/locations/LOCATION/operations/my-other-operation", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": CREATE_TIME, "endTime": END_TIME, "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": true, "response": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.Instance", "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "state": "ACTIVE", "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID" } } ] }
Membatalkan operasi yang berjalan lama
Gunakan metode projects.locations.operations.cancel
untuk memulai pembatalan asinkron pada operasi yang berjalan lama. Server
berusaha semaksimal mungkin untuk membatalkan operasi, tetapi keberhasilan tidak
dijamin.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
PROJECT_ID
: project ID Google Cloud Anda yang tercantum di Setelan IAMLOCATION
: lokasi operasi; gunakan salah satu region yang didukungMenampilkan lokasius-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
OPERATION_ID
: ID untuk operasi
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d "" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID:cancel"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID:cancel" | Select-Object -Expand Content
Anda akan melihat respons JSON seperti berikut:
{}
Menghapus operasi yang berjalan lama
Gunakan metode
projects.locations.operations.delete
untuk menghapus operasi yang berjalan lama dan telah selesai. Metode ini menunjukkan bahwa
klien tidak lagi tertarik dengan hasil operasi. Metode ini tidak membatalkan
operasi.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
PROJECT_ID
: project ID Google Cloud Anda yang tercantum di Setelan IAMLOCATION
: lokasi operasi; gunakan salah satu region yang didukungMenampilkan lokasius-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
OPERATION_ID
: ID untuk operasi
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID" | Select-Object -Expand Content
Anda akan melihat respons JSON yang mirip seperti berikut:
{}