एपीआई का संदर्भ

इस पेज पर, Metrics Configuration Generator (MCG) API एंडपॉइंट के लिए रेफ़रंस दस्तावेज़ दिया गया है.

एंडपॉइंट की खास जानकारी

यहां दिए गए सेक्शन में, MCG में उपलब्ध एपीआई एंडपॉइंट के बारे में बताया गया है.

मेट्रिक का कॉन्फ़िगरेशन

• POST /api/v1/generate_metrics_config: मेट्रिक कॉन्फ़िगरेशन के अनुरोध की जानकारी से MetricsConfig इंस्टेंस बनाएं.
• POST /api/v1/get_file_descriptor_set: यह रिपोर्ट डिकोड करने के लिए, दिए गए MetricsConfig के लिए फ़ाइल डिस्क्रिप्टर दिखाता है.
• POST /api/v1/validate_metrics_config: पास किए गए MetricsConfig की पुष्टि करता है और पुष्टि करने से जुड़ी गड़बड़ियों की सूची दिखाता है.

वाहन के सिग्नल कैटलॉग

• POST /api/v1/vs/: नया वाहन सिग्नल कैटलॉग बनाएं या मौजूदा कैटलॉग अपडेट करें.
• GET /api/v1/vs/: Vehicle Signal Catalog के सभी मेटाडेटा की सूची बनाएं.
• DELETE /api/v1/vs/{version}: इससे, चुने गए वाहन के सिग्नल कैटलॉग को मिटाया जा सकता है.

सेवा की स्थिति

• GET /health: सेवा की स्थिति देखें.

प्रोटोबफ़ कॉन्टेंट के टाइप

कई एपीआई एंडपॉइंट, प्रोटोकॉल बफ़र (प्रोटोबफ़) फ़ॉर्मैट में डेटा स्वीकार करते हैं या दिखाते हैं. दो तरह के कॉन्टेंट का इस्तेमाल किया जाता है:

• application/x-protobuf: यह बाइनरी वायर फ़ॉर्मैट में, प्रोटोबफ़ डेटा दिखाता है. यह फ़ॉर्मैट, मशीन-टू-मशीन कम्यूनिकेशन के लिए बेहतर है. हालाँकि, इसे इंसान नहीं पढ़ सकते.
• text/x-protobuf: यह टेक्स्ट फ़ॉर्मैट में प्रोटॉबफ़ डेटा दिखाता है. इसे आसानी से पढ़ा जा सकता है. साथ ही, यह डीबग करने या मैन्युअल तरीके से जांच करने के लिए फ़ायदेमंद होता है.

जब कोई एंडपॉइंट, अनुरोध या जवाब के लिए एक से ज़्यादा प्रोटोबफ़ फ़ॉर्मैट इस्तेमाल करता है, तो अनुरोध के डेटा का फ़ॉर्मैट तय करने के लिए Content-Type हेडर का इस्तेमाल करें. साथ ही, जवाब के डेटा का चुना गया फ़ॉर्मैट तय करने के लिए Accept हेडर का इस्तेमाल करें. उदाहरण के लिए:

• -H 'Content-Type: application/x-protobuf'
• -H 'Accept: text/x-protobuf'

एपीआई को कॉल करना

इस पेज पर दिए गए उदाहरणों में, REST API को कॉल करने के लिए curl का इस्तेमाल किया गया है. साथ ही, यह माना गया है कि आपने curl एनवायरमेंट वैरिएबल को उस होस्ट को रेफ़र करने के लिए सेट किया है जहाँ MCG को डिप्लॉय किया गया है.SERVICE_URL स्थानीय तौर पर चलाने पर, यह आम तौर पर http://localhost:8005 होता है.

किसी रिमोट Cloud Run इंस्टेंस को टारगेट करने के लिए, SERVICE_URL को gcloud का इस्तेमाल करके सेट करें. इसके बाद, अपनी curl कमांड में OpenID Connect (OIDC) आइडेंटिटी टोकन के साथ ऑथराइज़ेशन हेडर जोड़ें:

SERVICE_URL=$(gcloud run services describe mcg-service --region=<var label="Google Cloud region">GCP_REGION</var> --format='value(status.url)')

# Authorization header to append to curl command:
-H "Authorization: Bearer $(gcloud auth print-identity-token)"

मेट्रिक का कॉन्फ़िगरेशन

इस सेक्शन में, मेट्रिक कॉन्फ़िगरेशन जनरेट करने और उनकी पुष्टि करने के लिए एंडपॉइंट के बारे में बताया गया है.

POST /api/v1/generate_metrics_config

मेट्रिक कॉन्फ़िगरेशन के अनुरोध की जानकारी से MetricsConfig इंस्टेंस बनाएं. इस प्रोसेस में पुष्टि करना शामिल है. अगर स्कीमा के उल्लंघन, अमान्य रेफ़रंस, साइक्लिक डिपेंडेंसी या अन्य समस्याओं की वजह से जनरेट नहीं हो पाता है, तो एपीआई गड़बड़ी की जानकारी वाली सूची दिखाता है.

curl -H "Content-Type: application/json" \
  -H "Accept: text/x-protobuf" \
  --data-binary @PATH_TO_METRICS_CONFIG_JSON \
  "$SERVICE_URL/api/v1/generate_metrics_config"
      

POST /api/v1/get_file_descriptor_set

रिपोर्ट डिकोड करने के लिए, दिए गए MetricsConfig के लिए फ़ाइल डिस्क्रिप्टर दिखाता है.

curl -H "Content-Type: application/x-protobuf" \
  -H "Accept: application/x-protobuf" \
  --data-binary @PATH_TO_METRICS_CONFIG_PB \
  "$SERVICE_URL/api/v1/get_file_descriptor_set"
      

POST /api/v1/validate_metrics_config

दी गई MetricsConfig की पुष्टि करता है और पुष्टि करने से जुड़ी गड़बड़ियों की सूची दिखाता है.

curl -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data-binary @PATH_TO_METRICS_CONFIG_JSON \
  "$SERVICE_URL/api/v1/validate_metrics_config"
      

वाहन के सिग्नल कैटलॉग

इस सेक्शन में, वाहन के सिग्नल कैटलॉग मैनेज करने के लिए एंडपॉइंट के बारे में बताया गया है.

POST /api/v1/vs/

वाहन के सिग्नल कैटलॉग को नया बनाएं या मौजूदा कैटलॉग को अपडेट करें.

{
  "version": "string",
  "vehicle_signals": "string"
}

{"version": "string"}

curl -H "Content-Type: application/json" \
  --data-binary @- "$SERVICE_URL/api/v1/vs/" << EOF
{
  "version": "v1.0",
  "vehicle_signals": "VEHICLE_SIGNALS_BASE64"
}
EOF
      

GET /api/v1/vs/

वाहन के सिग्नल कैटलॉग के सभी मेटाडेटा की सूची बनाएं.

{"versions": [{"version": "string"}]}

curl "$SERVICE_URL/api/v1/vs/"
      

DELETE /api/v1/vs/{version}

वाहन के सिग्नल के कैटलॉग को मिटाता है.

{"version": "string"}

curl --request DELETE "$SERVICE_URL/api/v1/vs/v1.0"
      

सेवा की स्थिति

इस सेक्शन में, सेवा की स्थिति की जांच करने के लिए एंडपॉइंट के बारे में बताया गया है.

GET /health

सेवा की स्थिति देखें.

curl "$SERVICE_URL/health"
      

गड़बड़ी के रिस्पॉन्स

जब एपीआई कॉल से कोई गड़बड़ी (HTTP status 4xx या 5xx) होती है, तो जवाब के मुख्य भाग में गड़बड़ी वाला ऑब्जेक्ट होता है. इसका स्ट्रक्चर यहां दिया गया है:

{
  "error": {
    "code": 400,
    "status": "INVALID_ARGUMENT",
    "message": "Request validation failed",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.BadRequest",
        "fieldViolations": [
          {
            "field": "fieldName",
            "description": "error description"
          }
        ]
      }
    ]
  }
}