यहां Apigee Edge के दस्तावेज़ देखे जा रहे हैं.
पर जाएं
Apigee X दस्तावेज़. info
एपीआई प्लैटफ़ॉर्म का बेस पाथ:
https://api.enterprise.apigee.com/v1/o/{org_name}
एपीआई रिसॉर्स पाथ: /environments/{env_name}/stats/{dimension_name}
ब्यौरा: किसी डाइमेंशन के लिए मेट्रिक पाने के लिए, GET तरीके का इस्तेमाल करें
| क्रिया: | GET |
| पुष्टि: | बेसिक पुष्टि |
| मीडिया टाइप: |
application/json
|
खास जानकारी:
/stats एपीआई
रिसॉर्स पर GET अनुरोध का इस्तेमाल करके रिपोर्ट जनरेट की जाती है. इसके साथ:
- यूआरआई का एक वैकल्पिक पैरामीटर, जो रिपोर्ट के लिए डाइमेंशन तय करता है. Apigee, डाइमेंशन का एक सेट तय करता है. साथ ही, इन डाइमेंशन के हिसाब से मेट्रिक के एक सेट को पहले से एग्रीगेट करता है. अगर कोई डाइमेंशन तय नहीं किया जाता है (यानी, अगर यूआरआई पैरामीटर खाली है), तो तय किए गए एनवॉयरमेंट में मौजूद सभी एपीआई के लिए रिपोर्ट जनरेट की जाती है.
- क्वेरी पैरामीटर का एक सेट, जो रिपोर्ट के लिए मेट्रिक, समयसीमा, समय अंतराल, और फ़िल्टर/ड्रील-डाउन के पहलू तय करता है.
dimension_name: यूआरआई का एक पैरामीटर, जो उस इकाई को तय करता है जिसके लिए एपीआई
प्लैटफ़ॉर्म की मेट्रिक वापस मिलनी चाहिए. Apigee, डाइमेंशन का एक सेट तय करता है, जिसका इस्तेमाल
रिपोर्ट में किया जा सकता है. इन डाइमेंशन का इस्तेमाल किया जा सकता है:
/stats/apis: एपीआई प्लैटफ़ॉर्म पर किसी संगठन में मौजूद एपीआई प्रॉक्सी/stats/apiproducts: किसी संगठन में तय किए गए एपीआई प्रॉडक्ट/stats/apps: आपके एपीआई को अनुरोध भेजने वाले डेवलपर ऐप्लिकेशन का नाम/stats/client_ip: एपीआई प्लैटफ़ॉर्म पर एपीआई को अनुरोध भेजने वाले ऐप्लिकेशन के आईपी पते/stats/developer_email: एपीआई प्लैटफ़ॉर्म पर किसी संगठन में रजिस्टर किए गए डेवलपर का ईमेल पता/stats/developer_app: आपके एपीआई को अनुरोध भेजने वाले डेवलपर ऐप्लिकेशन का नाम/stats/devs:एपीआई प्लैटफ़ॉर्म पर किसी संगठन में रजिस्टर किया गया, Edge से जनरेट किया गया यूनीक डेवलपर आईडी/stats/access_token: ऐप्लिकेशन के एंड यूज़र का OAuth ऐक्सेस टोकन
कस्टम रिसॉर्स पर फ़िल्टर लागू किए जा सकते हैं. कस्टम रिसॉर्स ये हैं:
| चिह्न | कार्रवाई |
|---|---|
in |
लिस्ट में शामिल करने के लिए |
notin |
लिस्ट से बाहर रखने के लिए |
eq |
= |
ne |
!= या |
gt |
> |
lt |
|
ge |
>= |
le |
| ब्यौरा | क्वेरी फ़िल्टर करने का स्ट्रक्चर |
|---|---|
| api1 या api2 नाम वाली एपीआई प्रॉक्सी के आंकड़े | filter=(apiproxy in 'api1','api2') |
| api1 और api2 को छोड़कर, सभी एपीआई प्रॉक्सी के आंकड़े | filter=(apiproxy notin 'ap1','api2') |
| ऐसे आंकड़े जिनमें कोई गड़बड़ी नहीं है | filter=(iserror eq 0) |
| ऐसे आंकड़े जिनमें गड़बड़ी के मैसेज नहीं हैं या एपीआई प्रॉक्सी का नाम api1 या api2 है | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| ऐसे आंकड़े जिनमें (रिस्पॉन्स कोड 201 या 301 है) और (गड़बड़ियां हैं) या (एपीआई प्रॉक्सी नाम api1 या api2 है) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
अनुरोध का उदाहरण:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
| नाम | ब्यौरा | डिफ़ॉल्ट | ज़रूरी है? |
|---|---|---|---|
| चुनें | इससे रिपोर्ट के लिए, एग्रीगेट की जाने वाली मेट्रिक तय होती है. इन मेट्रिक का इस्तेमाल किया जा सकता है: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | लागू नहीं | हां |
| timeRange | चुने गए अंतराल के लिए, शुरू और खत्म होने का समय. तारीख का फ़ॉर्मैट MM/DD/YYYY HH:MM है. उदाहरण के लिए, 1/1/2013%2000:00~1/2/2013%2000:00. समयसीमा ज़्यादा से ज़्यादा छह महीने की हो सकती है | लागू नहीं | हां |
| timeUnit | second, minute, hour, day, week, month, quarter, year, decade, century, millennium | लागू नहीं | हां |
| sortby | जब दो या उससे ज़्यादा 'select' वैल्यू तय की जाती हैं, तो नतीजों को क्रम से लगाने के लिए, 'sortby' का इस्तेमाल करके, क्रम से लगाने के लिए इस्तेमाल की गई 'select' वैल्यू तय की जा सकती है: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | लागू नहीं | नहीं |
| sort | क्रम से लगाने के लिए, DESC या ASC का इस्तेमाल किया जा सकता है | लागू नहीं | नहीं |
| topk | नतीजों में से "top k" नतीजे लें. उदाहरण के लिए, टॉप पांच नतीजे पाने के लिए "topk=5" का इस्तेमाल करें. | लागू नहीं | नहीं |
| filter | इससे डाइमेंशन की खास वैल्यू के हिसाब से ड्रील-डाउन किया जा सकता है | लागू नहीं | नहीं |
| limit | एपीआई से मिलने वाली एंट्री की संख्या के लिए सीमा सेट करें | लागू नहीं | नहीं |
| offset | नतीजों के पेजों को क्रम से दिखाने के लिए, 'limit' के साथ 'offset' का इस्तेमाल करें. उदाहरण के लिए, नतीजे 11 से 20 तक दिखाने के लिए, 'limit' को '10' और 'offset' को '10' पर सेट करें. | लागू नहीं | नहीं |
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
} ,
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api1"
},
{
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
},
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api2"
}
],
"name" : "test"
}
],
"metaData" : {
}
}| नाम | ब्यौरा |
|---|---|
| मेटाडेटा | रिपोर्ट से जुड़ा मेटाडेटा |
| एनवॉयरमेंट | संगठन में मौजूद एनवॉयरमेंट जहां आंकड़े इकट्ठा किए जाते हैं. अलग-अलग एनवॉयरमेंट के आंकड़े इकट्ठा करने के लिए, वाइल्डकार्ड * का इस्तेमाल किया जा सकता है |
| मेट्रिक | तय किए गए डाइमेंशन के लिए दिखाई गई वैल्यू |
| डाइमेंशन | मेज़रमेंट के लिए तय किया गया डाइमेंशन. इस उदाहरण में api_name. |
| मेट्रिक | रिपोर्ट के लिए मेट्रिक |