ApiGateway API

• apiGateway
  • getApiGateway機能の設定情報取得します
  • patchApiGateway機能の設定情報更新します
  • postAPI Gatewayを作成します
  • postAPIキーを作成します
  • getAPIキーを取得します
  • postAPI Gatewayを公開します
  • postAPI Gatewayを非公開にします
  • postAPI Gatewayを作成するファイルをアップロードします
  • getAWS CloudFormationのスタック作成リンクを取得
• error
  • getステータスコード500でサーバーエラーを返却

API docs by Redocly

SaaSus ApiGateway API Schema (1.0.0)

SaaSus ApiGateway API Schema

apiGateway

SaaSus API ゲートウェイ管理

ApiGateway機能の設定情報取得します

ApiGateway機能の設定情報取得します

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/apigateway/settings

Response samples

• 200
• 500

Content type

application/json

{

• "generated_file_status": "finished",
• "internal_endpoint_openapi_definition_file_download_url": "https://presigned-url-test.s3.ap-northeast-1.amazonaws.com/test.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxx%2F20230710%2Fap-northeast-1%2Fs3%2Faws4_request",
• "internal_endpoint_mapping_file_download_url": "https://presigned-url-test.s3.ap-northeast-1.amazonaws.com/test.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxx%2F20230710%2Fap-northeast-1%2Fs3%2Faws4_request",
• "status": "published",
• "role_arn": "arn:aws:iam::123456789012:role/role-name",
• "role_external_id": 1234567890,
• "internal_endpoint_health_check_path": "/health",
• "internal_endpoint_health_check_port": 80,
• "internal_endpoint_health_check_protocol": "HTTP or HTTPS",
• "internal_endpoint_health_status_codes": 200,
• "saas_subnet_ids": [

  • "subnet-1234567890abcdef0",
  • "subnet-1234567890abcdef1"

  ],
• "saas_vpc_id": "vpc-12345678",
• "allowed_ips": [

  • "192.168.0.0/24",
  • "172.16.0.0/24"

  ],
• "domain_name": "dev.saasus.io",
• "is_dns_validated": false,
• "certificate_dns_record": {

  • "type": "CNAME",
  • "name": "_k90jaskdfawehro.domain-of-saasus-client.com.",
  • "value": "_cmojwc239j102mosd9.acm-validations.aws."

  },
• "cloud_front_dns_record": {

  • "type": "CNAME",
  • "name": "_k90jaskdfawehro.domain-of-saasus-client.com.",
  • "value": "_cmojwc239j102mosd9.acm-validations.aws."

  },
• "default_domain_name": "d78bh0l3saarv.cloudfront.net",
• "saas_alb_arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
• "endpoint_settings_list": [

  • {

    • "path": "/users/get-by-id",
    • "method": "GET",
    • "throttling": {

      • "target": "tenant",
      • "range": 600,
      • "limit": 100

      }

    }

  ]

}

ApiGateway機能の設定情報更新します

ApiGateway機能の設定情報更新します

Authorizations:

Bearer

Request Body schema: application/json

required

role_arn	string (AssumeRoleするためのロールのARN) SaaSus PlatformがAssumeRoleするためのロールのARN
role_external_id	string (AssumeRoleする時に使用するExternalID) SaaSus PlatformがSaaSを操作するためにAssumeRoleする時に使用するexternal id
internal_endpoint_health_check_path	string (インターナルエンドポイントのヘルスチェックパス) インターナルエンドポイントのヘルスチェックに使用するパス
internal_endpoint_health_check_port	integer (インターナルエンドポイントのヘルスチェックポート) インターナルエンドポイントのヘルスチェックに使用するポート
internal_endpoint_health_check_protocol	string (インターナルエンドポイントのヘルスチェックプロトコル) インターナルエンドポイントのヘルスチェックに使用するプロトコル
internal_endpoint_health_status_codes	string (インターナルエンドポイントのヘルスチェックステータスコード) インターナルエンドポイントのヘルスチェックに使用するステータスコード
saas_subnet_ids	Array of strings (SaaSサブネットID) SaaSのサブネットID
saas_vpc_id	string (SaaS VPC ID) SaaSのVPC ID
allowed_ips	Array of strings (許可されたIPアドレス一覧) 許可されたIPアドレス一覧
domain_name	string ドメイン名
saas_alb_arn	string (SaaS アプリケーションロードバランサーARN) SaaS アプリケーションロードバランサーARN
	Array of objects (エンドポイント設定一覧) エンドポイント毎の設定一覧

Responses

Production API Server

https://api.saasus.io/v1/apigateway/settings

Request samples

• Payload

Content type

application/json

{

• "role_arn": "arn:aws:iam::123456789012:role/role-name",
• "role_external_id": 1234567890,
• "internal_endpoint_health_check_path": "/health",
• "internal_endpoint_health_check_port": 80,
• "internal_endpoint_health_check_protocol": "HTTP or HTTPS",
• "internal_endpoint_health_status_codes": 200,
• "saas_subnet_ids": [

  • "subnet-1234567890abcdef0",
  • "subnet-1234567890abcdef1"

  ],
• "saas_vpc_id": "vpc-12345678",
• "allowed_ips": [

  • "192.168.0.0/24",
  • "172.16.0.0/24"

  ],
• "domain_name": "dev.saasus.io",
• "saas_alb_arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
• "endpoint_settings_list": [

  • {

    • "path": "/users/get-by-id",
    • "method": "GET",
    • "throttling": {

      • "target": "tenant",
      • "range": 600,
      • "limit": 100

      }

    }

  ]

}

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

API Gatewayを作成します

API Gatewayを作成します

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/apigateway/create

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

APIキーを作成します

APIキーを作成します

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Responses

Production API Server

https://api.saasus.io/v1/apigateway/tenants/{tenant_id}/api-key

Response samples

• 201
• 500

Content type

application/json

{

• "api_key": "1234567890abcdef"

}

APIキーを取得します

APIキーを取得します

Authorizations:

Bearer

path Parameters

tenant_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 テナントID

Responses

Production API Server

https://api.saasus.io/v1/apigateway/tenants/{tenant_id}/api-key

Response samples

• 200
• 500

Content type

application/json

{

• "api_key": "1234567890abcdef"

}

API Gatewayを公開します

API Gatewayを公開します

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/apigateway/publish

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

API Gatewayを非公開にします

API Gatewayを非公開にします

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/apigateway/unpublish

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

API Gatewayを作成するファイルをアップロードします

API Gatewayを作成するファイルをアップロードします

Authorizations:

Bearer

Request Body schema: application/json

content required

string <base64> (ApiGateway入力ファイルのコンテンツ) API Gatewayを作成するためにアップロードするファイルのコンテンツ

Responses

Production API Server

https://api.saasus.io/v1/apigateway/upload

Request samples

• Payload

Content type

application/json

{

• "content": "UEsDBBQACAAIAJr6oFQmTAuRfvOGAA=="

}

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

AWS CloudFormationのスタック作成リンクを取得

CloudFormationのクイック作成リンクを取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/apigateway/cloudformation-launch-stack-link

Response samples

• 200
• 500

Content type

application/json

{

• "link": "https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/create?stackName=sample&templateURL=https://s3.us-west-2.amazonaws.com/cloudformation-templates-sample.template"

}

error

テスト用途のエラー

ステータスコード500でサーバーエラーを返却

テスト用途で使用するエンドポイントです。ステータスコード500でサーバーエラーを返却します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/apigateway/errors/internal-server-error

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}