Method
    • PDF

    Method

    • PDF

    Article Summary

    メソッドの追加

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    {
      "methodDescription" : "methodDescription",
      "mockEndPoint" : {
        "headers" : {
          "key" : "headers"
        },
        "response" : "response",
        "httpStatus" : 0
      },
      "methodName" : "ANY",
      "ncpEndPoint" : {
        "method" : "ANY",
        "stream" : true,
        "service" : "service",
        "actionId" : "actionId",
        "region" : "KR",
        "url" : "url",
        "actionName" : "actionName"
      },
      "requiredApiKey" : {
        "required" : true
      },
      "validation" : {
        "headers" : [ "headers" ],
        "queryStrings" : [ "queryStrings" ],
        "type" : "NONE"
      },
      "httpEndPoint" : {
        "method" : "ANY",
        "stream" : true,
        "url" : "url"
      },
      "authentication" : {
        "authorizerId" : "authorizerId",
        "platform" : "NONE"
      }
    }
    

    応答コード

    • 201

    応答ボディ

    {
      "methods" : [ {
        "methodDescription" : "methodDescription",
        "resourceId" : "resourceId",
        "useBodyWhenFormData" : true,
        "modifier" : "modifier",
        "resourcePath" : "resourcePath",
        "methodName" : "ANY",
        "ncpEndPoint" : {
          "method" : "ANY",
          "stream" : true,
          "service" : "service",
          "actionId" : "actionId",
          "region" : "KR",
          "url" : "url",
          "actionName" : "actionName"
        },
        "requiredApiKey" : {
          "required" : true
        },
        "mockEndPoint" : {
          "headers" : {
            "key" : "headers"
          },
          "response" : "response",
          "httpStatus" : 0
        },
        "produces" : "produces",
        "tenantId" : "tenantId",
        "consumers" : "consumers",
        "apiId" : "apiId",
        "validation" : {
          "headers" : [ "headers" ],
          "queryStrings" : [ "queryStrings" ],
          "type" : "NONE"
        },
        "authentication" : {
          "authorizerId" : "authorizerId",
          "platform" : "NONE"
        },
        "httpEndPoint" : {
          "method" : "ANY",
          "stream" : true,
          "url" : "url"
        }
      } ]
    }
    

    メソッドの削除

    URL

    DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10
    methodNamepathYStringMethod Name
    許容値:ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD

    リクエストボディ

    • なし

    応答コード

    • 204

    応答ボディ

    • なし

    メソッドconsumers照会

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/consumers
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10
    methodNamepathYStringMethod Name
    許容値:ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "consumers" : "consumers"
    }
    

    メソッドproduces照会

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/produces
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10
    methodNamepathYStringMethod Name
    許容値:ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "produces" : "produces"
    }
    

    メソッド照会

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "methods" : [ {
        "methodDescription" : "methodDescription",
        "resourceId" : "resourceId",
        "useBodyWhenFormData" : true,
        "endpointCode" : "endpointCode",
        "modifier" : "modifier",
        "resourcePath" : "resourcePath",
        "methodName" : "ANY",
        "ncpEndPoint" : {
          "method" : "ANY",
          "stream" : true,
          "service" : "service",
          "actionId" : "actionId",
          "region" : "KR",
          "url" : "url",
          "actionName" : "actionName"
        },
        "requiredApiKey" : {
          "required" : true
        },
        "mockEndPoint" : {
          "headers" : {
            "key" : "headers"
          },
          "response" : "response",
          "httpStatus" : 0
        },
        "endpointActionId" : "endpointActionId",
        "produces" : "produces",
        "tenantId" : "tenantId",
        "consumers" : "consumers",
        "methodFilters" : [ {
          "configJson" : "configJson",
          "resourceId" : "resourceId",
          "filterName" : "AUTH",
          "apiId" : "apiId",
          "methodCode" : "methodCode"
        } ],
        "apiId" : "apiId",
        "validation" : {
          "headers" : [ "headers" ],
          "queryStrings" : [ "queryStrings" ],
          "type" : "NONE"
        },
        "authentication" : {
          "authorizerId" : "authorizerId",
          "platform" : "NONE"
        },
        "endpointConfigJson" : "endpointConfigJson",
        "httpEndPoint" : {
          "method" : "ANY",
          "stream" : true,
          "url" : "url"
        }
      } ]
    }
    

    メソッドconsumers修正

    URL

    PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/consumers
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10
    methodNamepathYStringMethod Name
    許容値:ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD

    リクエストボディ

    {
      "consumers" : "consumers"
    }
    

    応答コード

    • 200

    応答ボディ

    {
      "consumers" : "consumers"
    }
    

    メソッドproduces修正

    URL

    PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/produces
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10
    methodNamepathYStringMethod Name
    許容値:ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD

    リクエストボディ

    {
      "produces" : "produces"
    }
    

    応答コード

    • 200

    応答ボディ

    {
      "produces" : "produces"
    }
    

    メソッドの変更

    URL

    PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    resourceIdpathYStringResource Id
    長さ(最大/最小):0 / 10
    methodNamepathYStringMethod Name
    許容値:ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD

    リクエストボディ

    {
      "methodDescription" : "methodDescription",
      "mockEndPoint" : {
        "headers" : {
          "key" : "headers"
        },
        "response" : "response",
        "httpStatus" : 0
      },
      "ncpEndPoint" : {
        "method" : "ANY",
        "stream" : true,
        "service" : "service",
        "actionId" : "actionId",
        "region" : "KR",
        "url" : "url",
        "actionName" : "actionName"
      },
      "requiredApiKey" : {
        "required" : true
      },
      "validation" : {
        "headers" : [ "headers" ],
        "queryStrings" : [ "queryStrings" ],
        "type" : "NONE"
      },
      "httpEndPoint" : {
        "method" : "ANY",
        "stream" : true,
        "url" : "url"
      },
      "authentication" : {
        "authorizerId" : "authorizerId",
        "platform" : "NONE"
      }
    }
    

    応答コード

    • 200

    応答ボディ

    {
      "method" : {
        "methodDescription" : "methodDescription",
        "resourceId" : "resourceId",
        "useBodyWhenFormData" : true,
        "modifier" : "modifier",
        "resourcePath" : "resourcePath",
        "methodName" : "ANY",
        "ncpEndPoint" : {
          "method" : "ANY",
          "stream" : true,
          "service" : "service",
          "actionId" : "actionId",
          "region" : "KR",
          "url" : "url",
          "actionName" : "actionName"
        },
        "requiredApiKey" : {
          "required" : true
        },
        "mockEndPoint" : {
          "headers" : {
            "key" : "headers"
          },
          "response" : "response",
          "httpStatus" : 0
        },
        "produces" : "produces",
        "tenantId" : "tenantId",
        "consumers" : "consumers",
        "apiId" : "apiId",
        "validation" : {
          "headers" : [ "headers" ],
          "queryStrings" : [ "queryStrings" ],
          "type" : "NONE"
        },
        "authentication" : {
          "authorizerId" : "authorizerId",
          "platform" : "NONE"
        },
        "httpEndPoint" : {
          "method" : "ANY",
          "stream" : true,
          "url" : "url"
        }
      }
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.