リクエスト

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

メソッド	URI
PATCH	/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`product-id`	String	Required	APIが属する Product ID 1~10文字 Productリストの照会を通じて確認
`api-id`	String	Required	レスポンスの説明を変更する対象の API ID 1~10文字 APIの照会を通じて確認
`resource-id`	String	Required	API内対象リソースの ID 1~10文字 Resourceリストの照会を通じて確認
`method-name`	String	Required	対象メソッドのタイプ `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD`
`status-code`	Integer	Required	レスポンスステータスコードメソッドレスポンスの照会を通じて確認

リクエスト構文

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

{
  "responseDescription" : "responseDescription"
}

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`responseDescription`	String	Required	レスポンスの説明 0~300文字

リクエスト例

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

curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/GET/responses/400' \
--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 '{
  "responseDescription" : "Wrong request. Check parameters."
}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

{
  "methodResponseDto" : {
    "tenantId" : "tenantId",
    "apiId" : "apiId",
    "resourceId" : "resourceId",
    "methodCode" : "methodCode",
    "statusCode" : 0,
    "responseDescription" : "responseDescription",
    "modifier" : "modifier"
  }
}

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "methodResponseDto": {
        "tenantId": "********65ec41039ce6668c2058b8a9",
        "apiId": "cvcohvd2xj",
        "resourceId": "tf73xuex0v",
        "methodCode": "0001",
        "statusCode": 400,
        "responseDescription": "Wrong request. Check parameters.",
        "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
    }
}

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

リクエスト
レスポンス