Resourceの変更
- 印刷する
- PDF
Resourceの変更
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
ユーザーが指定した条件に基づいて Resourceの情報を変更します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PATCH | /products/{product-id}/apis/{api-id}/resources/{resource-id} |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
product-id | String | Required | Resourceが属する Product ID
|
api-id | String | Required | Resourceが属する API ID
|
resource-id | String | Required | 変更対象の Resource ID
|
リクエスト構文
リクエスト構文は次の通りです。
{
"corsMaxAge" : "corsMaxAge",
"corsAllowMethods" : "corsAllowMethods",
"corsAllowOrigin" : "corsAllowOrigin",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"corsAllowHeaders" : "corsAllowHeaders"
}
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
corsMaxAge | String | Optional | クライアントが Preflightリクエスト結果を保存する期間 |
corsAllowMethods | String | Optional | クライアントリクエスト(リソースアクセス)時に許可するメソッド
|
corsAllowOrigin | String | Optional | クライアントリクエスト(リソースアクセス)を許可するドメインを設定
|
corsAllowCredentials | String | Optional | HTTPの Access-Control-Allow-Credentialsヘッダに対応する値 |
corsExposeHeaders | String | Optional | クライアントリクエスト(リソースアクセス)に含めることが可能なユーザー定義ヘッダ |
corsAllowHeaders | String | Optional | クライアントリクエスト(リソースアクセス)時に許可するヘッダ |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/resources/***lvof***' \
--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 '{
"corsAllowMethods" : "DELETE",
"corsAllowOrigin" : "*",
"corsAllowHeaders" : "content-type,x-ncp-apigw-api-key,x-ncp-apigw-timestamp,x-ncp-iam-access-key,x-ncp-apigw-signature-v1,x-ncp-apigw-signature-v2"
}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
{
"resource" : {
"corsMaxAge" : "corsMaxAge",
"resourceId" : "resourceId",
"corsAllowMethods" : "corsAllowMethods",
"methods" : [ {
"methodName" : "ANY",
"methodCode" : "methodCode"
} ],
"corsAllowOrigin" : "corsAllowOrigin",
"resourcePath" : "resourcePath",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"apiId" : "apiId",
"corsAllowHeaders" : "corsAllowHeaders"
}
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gateway APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"resource": {
"methods": [
{
"methodCode": "0006",
"methodName": "OPTIONS"
}
],
"apiId": "***51hs***",
"resourceId": "***lvof***",
"resourcePath": "/test001***3",
"corsAllowOrigin": "*",
"corsAllowMethods": "DELETE",
"corsAllowHeaders": "content-type,x-ncp-apigw-api-key,x-ncp-apigw-timestamp,x-ncp-iam-access-key,x-ncp-apigw-signature-v1,x-ncp-apigw-signature-v2"
}
}
この記事は役に立ちましたか?