API Keyサブスクリプションの照会
- 印刷する
- PDF
API Keyサブスクリプションの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
API Keyと関連付けられた Stage(サブスクリプション中の Stage)情報を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api-keys/{api-key-id}/subscription-detail |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
api-key-id | String | Required | サブスクリプション情報照会対象の API Key ID |
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
offset | Long | Optional | 照会対象のデータリストからスタートする位置
|
limit | Long | Optional | 一度に照会するデータ数
|
apiId | String | Optional | Stageが属する API ID |
stageId | String | Optional | API Keyと関連付けられた Stage ID |
productId | String | Required | API Keyと関連付けられた Product ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscription-detail?productId=*****n0bk' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
構文は次の通りです。
{
"apiKeyRelations": {
"content": [
{
"apiId": "apiId",
"apiName": "apiName",
"stageId": "stageId",
"stageName": "stageName",
"apiKeyId": "apiKeyId",
"apiKeyName": "apiKeyName",
"usagePlanId": "usagePlanId",
"usagePlanName": "usagePlanName",
"regTime": "2024-05-07T08:34:37Z",
"modTime": "2024-05-07T08:34:37Z",
"dayCallCount": 0,
"monthCallCount": 0,
"domainCode": "domainCode"
}
],
"total": 0
}
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"apiKeyRelations": {
"content": [
{
"apiId": "*****uwtk",
"apiName": "api-***",
"stageId": "*****7mhdv",
"stageName": "v1",
"apiKeyId": "*****g079",
"apiKeyName": "apiKey-***",
"usagePlanId": "*****w2111",
"usagePlanName": "usagePlan-***",
"regTime": "2024-05-07T08:34:37Z",
"modTime": "2024-05-07T08:34:37Z",
"dayCallCount": 0,
"monthCallCount": 0,
"domainCode": "PUB"
}
],
"total": 1
}
}
この記事は役に立ちましたか?