Dashboard API Key

印刷する
共有
PDF

Dashboard API Key

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

アクセルエクスポート

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/api-keys/{api-key-id}/products/{product-id}/apis/{api-id}/stages/{stage-id}/export

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id 長さ（最大/最小）：0 / 10
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10
apiId	path	Y	String	Api Id 長さ（最大/最小）：0 / 10
stageId	path	Y	String	Stage Id 長さ（最大/最小）：0 / 10
regions	query string	N	List<String>	Regions コレクションのアイテムはnullにすることはできません。
offset	query string	N	Long	Offset 最小：0 最大：9,223,372,036,854,775,807
limit	query string	N	Long	Limit 最小：1 最大：9,223,372,036,854,775,807
from	query string	Y	String	From パターン：yyyy-MM-dd
to	query string	Y	String	To パターン：yyyy-MM-dd
timeZone	query string	Y	String	Time Zone パターン：+09：00

リクエストボディ

なし

応答コード

応答ボディ

"Download File"

API照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/api-keys/{api-key-id}/products/{product-id}/api-ids

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id 長さ（最大/最小）：0 / 10
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10
regions	query string	N	List<String>	Regions コレクションのアイテムはnullにすることはできません。
offset	query string	N	Long	Offset 最小：0 最大：9,223,372,036,854,775,807
limit	query string	N	Long	Limit 最小：1 最大：9,223,372,036,854,775,807
from	query string	Y	String	From パターン：yyyy-MM-dd
to	query string	Y	String	To パターン：yyyy-MM-dd
timeZone	query string	Y	String	Time Zone パターン：+09：00

リクエストボディ

なし

応答コード

応答ボディ

{
  "apis" : {
    "total" : 0,
    "content" : [ {
      "apiName" : "apiName",
      "isDeleted" : true,
      "apiId" : "apiId"
    } ]
  }
}

API Key照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/api-keys

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
regions	query string	N	List<String>	Regions コレクションのアイテムはnullにすることはできません。
offset	query string	N	Long	Offset 最小：0 最大：9,223,372,036,854,775,807
limit	query string	N	Long	Limit 最小：1 最大：9,223,372,036,854,775,807
from	query string	Y	String	From パターン：yyyy-MM-dd
to	query string	Y	String	To パターン：yyyy-MM-dd
timeZone	query string	Y	String	Time Zone パターン：+09：00

リクエストボディ

なし

応答コード

応答ボディ

{
  "apiKeyIds" : [ {
    "isDeleted" : true,
    "isEnabled" : true,
    "apiKeyId" : "apiKeyId",
    "apiKeyName" : "apiKeyName",
    "disabled" : true,
    "permission" : "permission",
    "actionName" : "actionName"
  } ]
}

ダッシュボードのデータ照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/api-keys/{api-key-id}/products/{product-id}/charts

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id 長さ（最大/最小）：0 / 10
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10
regions	query string	N	List<String>	Regions コレクションのアイテムはnullにすることはできません。
offset	query string	N	Long	Offset 最小：0 最大：9,223,372,036,854,775,807
limit	query string	N	Long	Limit 最小：1 最大：9,223,372,036,854,775,807
from	query string	Y	String	From パターン：yyyy-MM-dd
to	query string	Y	String	To パターン：yyyy-MM-dd
timeZone	query string	Y	String	Time Zone パターン：+09：00
apiId	query string	N	String	Api Id

リクエストボディ

なし

応答コード

応答ボディ

{
  "apis" : {
    "total" : 6,
    "content" : [ {
      "apiName" : "apiName",
      "isDeleted" : true,
      "stages" : [ {
        "stageName" : "stageName",
        "isDeleted" : true,
        "series" : [ {
          "data" : [ {
            "time" : "time",
            "value" : 0.8008282
          } ],
          "name" : "name",
          "region" : "region"
        } ],
        "stageId" : "stageId"
      } ],
      "apiId" : "apiId"
    } ]
  }
}

Product照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/api-keys/{api-key-id}/product-ids

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id 長さ（最大/最小）：0 / 10
regions	query string	N	List<String>	Regions コレクションのアイテムはnullにすることはできません。
offset	query string	N	Long	Offset 最小：0 最大：9,223,372,036,854,775,807
limit	query string	N	Long	Limit 最小：1 最大：9,223,372,036,854,775,807
from	query string	Y	String	From パターン：yyyy-MM-dd
to	query string	Y	String	To パターン：yyyy-MM-dd
timeZone	query string	Y	String	Time Zone パターン：+09：00

リクエストボディ

なし

応答コード

応答ボディ

{
  "products" : [ {
    "isDeleted" : true,
    "productId" : "productId",
    "disabled" : true,
    "permission" : "permission",
    "productName" : "productName",
    "actionName" : "actionName"
  } ]
}

この記事は役に立ちましたか?

What's Next

Dashboard Event

アクセルエクスポート
API照会
API Key照会
ダッシュボードのデータ照会
Product照会

タグ

API Gateway