Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी
एपीआई प्लैटफ़ॉर्म का बेस पाथ:
https://api.enterprise.apigee.com/v1/o/{org_name}
एपीआई रिसॉर्स पाथ: /environments/{env_name}/stats/{dimension_name}
जानकारी: किसी डाइमेंशन के लिए मेट्रिक वापस पाने के लिए, जीईटी तरीके का इस्तेमाल करें
| क्रिया: | GET |
| आधिकारिक: | पुष्टि करने की बुनियादी जानकारी |
| मीडिया के टाइप: |
application/json
|
खास जानकारी: एक रिपोर्ट,
/stats एपीआई संसाधन पर जीईटी अनुरोध का इस्तेमाल करके जनरेट की जाती है. इसमें यह जानकारी भी शामिल होती है:
- एक वैकल्पिक यूआरआई पैरामीटर, जो रिपोर्ट का डाइमेंशन तय करता है. 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 | सेकंड, मिनट, घंटा, दिन, हफ़्ता, महीना, तिमाही, साल, दशक, सदी, हज़ार साल | लागू नहीं | हां |
| क्रम से लगाएं | जब दो या दो से ज़्यादा वैल्यू दी जाती हैं, 'sortby' का इस्तेमाल, नतीजों को क्रम से लगाने के लिए चुने गए विकल्प के बारे में बताने के लिए किया जा सकता है. जैसे: message_count,Error_count, total_response_time, max_response_time, min_response_time, data_एक्सचेंज_साइज़, end_point_response_time | लागू नहीं | नहीं |
| क्रम से लगाएं | इस्तेमाल किए जा सकने वाले क्रम में लगाने के लिए इस्तेमाल किए जा सकने वाले स्कोप TV या ASC हैं | लागू नहीं | नहीं |
| Topk | नतीजों से "टॉप k" नतीजे लें. उदाहरण के लिए, सबसे ऊपर के पांच नतीजे "topk=5" दिखाने के लिए. | लागू नहीं | नहीं |
| फ़िल्टर | खास डाइमेंशन वैल्यू पर ड्रिल-डाउन चालू करता है | लागू नहीं | नहीं |
| सीमा | एपीआई से दिखाई गई एंट्री की संख्या की सीमा सेट करें | लागू नहीं | नहीं |
| ऑफ़सेट | नतीजों के पेज पर नंबर डालने की सुविधा चालू करने के लिए, सीमा के साथ ऑफ़सेट का इस्तेमाल करें. उदाहरण के लिए, नतीजे 11 से 20 दिखाने के लिए, सीमा को '10' पर सेट करें और ऑफ़सेट को '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" : {
}
}
रिस्पॉन्स पेलोड एलिमेंट:
| नाम | ब्यौरा |
|---|---|
| मेटाडेटा | रिपोर्ट से जुड़ा मेटाडेटा |
| एनवायरमेंट | संगठन में ऐसे एनवायरमेंट जहां आंकड़े इकट्ठा किए जाते हैं (इसमें क्रॉस एनवायरमेंट के आंकड़ों को इकट्ठा करने के लिए, वाइल्डकार्ड * का इस्तेमाल किया जा सकता है) |
| metrics | किसी खास डाइमेंशन के लिए लौटाए गए मान |
| आयाम | मेज़रमेंट के लिए तय किया गया डाइमेंशन: इस उदाहरण में api_name. |
| metrics | रिपोर्ट के लिए मेट्रिक |