Lewati ke isi

Pengembangan Skrip / Objek Konektor DFF.CONN / Guance Cloud

Objek operasi Konektor Guance Cloud terutama menyediakan objek DataWay untuk penulisan data serta wrapper OpenAPI.

API Key Konektor ini memerlukan peran Administrator

Karena Konektor ini secara otomatis mengambil informasi sensitif seperti Token ruang kerja, untuk keperluan operasi seperti pelaporan data selanjutnya.

Oleh karena itu, API Key perlu diberi peran Administrator

Parameter DFF.CONN(...) adalah sebagai berikut:

Parameter Tipe Wajib / Nilai Default Deskripsi
connector_id str Wajib ID Konektor
timeout int/float 10 Waktu tunggu HTTP default untuk objek operasi saat ini, dalam detik

Silakan lihat dokumentasi OpenAPI:

.dataway

Properti dataway adalah objek operasi DataWay yang bersesuaian dengan Guance Cloud saat ini, dan cara penggunaannya sama dengan objek operasi Konektor DataWay yang dibuat secara langsung.

Contoh
1
status_code, result = guance.dataway.write_by_category(category='metric', measurement='Pemantauan Host', tags={'host': 'web-01'}, fields={'cpu': 10})

Silakan lihat konten lengkap:

.is_api_key_valid / .is_api_key_match

Properti is_api_key_valid mengembalikan apakah API Key Konektor saat ini valid; is_api_key_match adalah alias kompatibel untuk nama lama:

Contoh
1
print(guance.is_api_key_valid)
Contoh Output
1
True

.workspace

Properti workspace mengembalikan informasi ruang kerja saat ini:

Contoh
1
2
import json
print(json.dumps(guance.workspace, indent=2))
Contoh Output
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "uuid"        : "wksp_xxxxx",
  "name"        : "xxxxx",
  "rpName"      : "rp1",
  "language"    : "zh",
  "timezone"    : "",
  "bossStation" : "CN",
  "billingState": "normal",
  "versionType" : "pay",
  "token"       : "tkn_xxxxx",
  "cliToken"    : "wkcli_xxxxx",
  "<Bidang lain dihilangkan>": "..."
}

.workspace_uuid

Properti workspace_uuid mengembalikan UUID ruang kerja saat ini:

Contoh
1
print(guance.workspace_uuid)
Contoh Output
1
wksp_xxxxx

.workspace_token

Properti workspace_token mengembalikan Token ruang kerja saat ini:

Contoh
1
print(guance.workspace_token)
Contoh Output
1
tkn_xxxxx

.workspace_language

Properti workspace_language mengembalikan bahasa ruang kerja saat ini:

Contoh
1
print(guance.workspace_language)
Contoh Output
1
zh

.do_get(...)

Digunakan untuk mengirim permintaan GET ke OpenAPI Guance Cloud, parameter adalah sebagai berikut:

Parameter Tipe Wajib / Nilai Default Deskripsi
path str Wajib Jalur OpenAPI
query dict None Parameter query URL
timeout int/float None Waktu tunggu permintaan ini; jika dihilangkan, gunakan nilai default objek operasi
Contoh
1
2
3
4
import json

result = guance.do_get('/api/v1/workspace/get')
print(json.dumps(result, indent=2))
Contoh Output
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "content": {
    "uuid"        : "wksp_xxxxx",
    "name"        : "xxxxx",
    "rpName"      : "rp1",
    "language"    : "zh",
    "timezone"    : "",
    "bossStation" : "CN",
    "billingState": "normal",
    "versionType" : "pay",
    "token"       : "tkn_xxxxx",
    "cliToken"    : "wkcli_xxxxx",
    "<Bidang lain dihilangkan>": "..."
  }
}

Metode ini mengembalikan objek respons lengkap OpenAPI dan tidak mengekstrak content secara otomatis. Metode ini akan melempar pengecualian jika kode status HTTP lebih dari atau sama dengan 400.

.do_post(...)

Digunakan untuk mengirim permintaan POST ke OpenAPI Guance Cloud, parameter adalah sebagai berikut:

Parameter Tipe Wajib / Nilai Default Deskripsi
path str Wajib Jalur OpenAPI
query dict None Parameter query URL
body dict None Badan permintaan JSON
timeout int/float None Waktu tunggu permintaan ini; jika dihilangkan, gunakan nilai default objek operasi
Contoh
1
2
3
4
body = {
    'desc': 'deskripsi baru'
}
result = guance.do_post('/api/v1/workspace/modify', body=body)

Metode ini mengembalikan objek respons lengkap OpenAPI. Metode ini akan melempar pengecualian jika kode status HTTP lebih dari atau sama dengan 400.

Node

Guance Cloud memiliki beberapa node yang dapat digunakan. Saat membuat Konektor Guance Cloud, Anda perlu menentukan node Guance Cloud yang sesuai.

Untuk memastikan dukungan penggunaan sepenuhnya offline, DataFlux Func sendiri akan menyimpan salinan daftar node Guance Cloud terkini pada saat setiap versi dirilis.

Oleh karena itu, mungkin ada kasus di mana node baru yang ditambahkan oleh Guance Cloud tidak dapat segera tercermin di DataFlux Func.


Jika menghadapi situasi seperti ini, Anda dapat melihat konfigurasi terkait node baru Guance Cloud di alamat berikut, lalu pilih 'Private Deployment' dan isi secara manual.

Daftar node yang tersedia saat ini adalah sebagai berikut:

Node Nama Alamat
Sedang mengambil daftar node terbaru...