Usage Planリストの照会
- 印刷する
- PDF
Usage Planリストの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
ユーザーが指定した条件を満たす Usage Planリストを照会します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /usage-plans/search |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエスト構文
リクエスト構文は次の通りです。
{
"offset" : 6,
"limit" : 0,
"usagePlanName" : "usagePlanName"
}
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
offset | Long | Optional | レスポンスデータの開始点
|
limit | Long | Optional | レスポンスデータの最大数
|
usagePlanName | String | Optional | 照会対象の Usage Planの名前
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans/search' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"usagePlanName" : "usageplan001"
}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
{
"initialCount" : 0,
"total" : 6,
"usagePlans" : [ {
"domainCode" : "domainCode",
"usagePlanId" : "usagePlanId",
"modifier" : "modifier",
"associatedStagesCount" : 0,
"dayQuotaRequest" : 6,
"permission" : "permission",
"rateRps" : 5,
"usagePlanName" : "usagePlanName",
"monthQuotaRequest" : 1,
"tenantId" : "tenantId",
"disabled" : true,
"usagePlanDescription" : "usagePlanDescription",
"quotaCondition" : "quotaCondition",
"actionName" : "actionName"
} ]
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"usagePlans": [
{
"tenantId": "***e230cebc1402ba89b148896951***",
"usagePlanId": "***xogj***",
"usagePlanName": "usageplan001",
"domainCode": "PUB",
"associatedStagesCount": 0
}
],
"total": 1,
"initialCount": 2
}
この記事は役に立ちましたか?