Resourceの作成

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

ユーザーが指定した条件に基づいて Resourceを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/products/{product-id}/apis/{api-id}/resources

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`product-id`	String	Required	APIが属する Product ID 0~10文字 Productリストの照会を通じて確認
`api-id`	String	Required	Resource作成対象の API ID 0~10文字 APIの照会を通じて確認

リクエスト構文

リクエスト構文は次の通りです。

{
    "corsMaxAge" : "corsMaxAge",
    "corsAllowMethods" : "corsAllowMethods",
    "corsAllowOrigin" : "corsAllowOrigin",
    "resourcePath" : "resourcePath",
    "corsAllowCredentials" : "corsAllowCredentials",
    "corsExposeHeaders" : "corsExposeHeaders",
    "corsAllowHeaders" : "corsAllowHeaders"
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`corsMaxAge`	String	Optional	クライアントが Preflightリクエスト結果を保存する期間
`corsAllowMethods`	String	Optional	クライアントリクエスト(リソースアクセス)時に許可するメソッド `GET` \| `POST` \| `PUT` \| `PATCH` \| `DELETE` \| `HEAD` \| `OPTIONS`
`corsAllowOrigin`	String	Optional	クライアントリクエスト(リソースアクセス)を許可するドメインを設定すべてのドメインを許可する場合、`*`を入力
`resourcePath`	String	Required	リソースのパス <例> `/resource`
`corsAllowCredentials`	String	Optional	HTTPの Access-Control-Allow-Credentialsヘッダに対応する値
`corsExposeHeaders`	String	Optional	クライアントリクエスト(リソースアクセス)に含めることが可能なユーザー定義ヘッダ
`corsAllowHeaders`	String	Optional	クライアントリクエスト(リソースアクセス)時に許可するヘッダ

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/resources' \
--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" : "*",
    "resourcePath" : "/test01***2233",
    "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のレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "resource": {
        "apiId": "***51hs***",
        "resourceId": "***hoc2***",
        "resourcePath": "/test01***2233",
        "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"
    }
}

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

What's Next

Resourceの削除

リクエスト
レスポンス