メインコンテンツまでスキップ

インベントリAPIリファレンス

API docs by Redocly

Chip-in inventory API (1.0.0)

Download OpenAPI specification:Download

E-mail: mitsuru@procube.jp License: Apache 2.0

これはChip-in のインベントリにアクセスするためのAPIである。 アクセス制御は別途OPAで実装される。その仕様は inventory.rego で記述されている。

realm

マイクロサービスをグループ化するための論理的な区分。'/' などパスとして使用できない文字を含むことはできない。

List all realms.

Returns a list of all realms.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an existing realm.

Update an existing realm by realm name.

path Parameters
realm
required
string

realm name to update

Request Body schema: application/json
required

Update an existent realm in the SPN

name
required
string

レルムの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

レルムの日本語名称です。

description
string

レルムの説明文です。

cacert
required
string

realm 配下の SPN hub で mTLSにおけるクライアント証明書を発行したCA局の証明書(PEM形式)の文字列

administrators
Array of strings

レルムの管理者のユーザID。ユーザの管理はインベントリでは行わない。認証サービス内でのみ管理され、ここではそのIDのみを参照する。

expiredAt
string <date-time>

レルムの有効期限。ISO8601形式で指定する。 この日時を過ぎると、レルムの disabled フラグは true となり、関連するリソースへのアクセスが制限される。

disabled
required
boolean

レルムが無効化されているかどうかを示すフラグ。 true の場合、レルムは無効化されており、関連するリソースへのアクセスが制限される。 false の場合、レルムは有効であり、通常の操作が可能である。

Responses

Request samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Add a new realm.

Add a new realm.

path Parameters
realm
required
string

realm name of the realm to add

Request Body schema: application/json
required

Create a new realm

name
required
string

レルムの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

レルムの日本語名称です。

description
string

レルムの説明文です。

cacert
required
string

realm 配下の SPN hub で mTLSにおけるクライアント証明書を発行したCA局の証明書(PEM形式)の文字列

administrators
Array of strings

レルムの管理者のユーザID。ユーザの管理はインベントリでは行わない。認証サービス内でのみ管理され、ここではそのIDのみを参照する。

expiredAt
string <date-time>

レルムの有効期限。ISO8601形式で指定する。 この日時を過ぎると、レルムの disabled フラグは true となり、関連するリソースへのアクセスが制限される。

disabled
required
boolean

レルムが無効化されているかどうかを示すフラグ。 true の場合、レルムは無効化されており、関連するリソースへのアクセスが制限される。 false の場合、レルムは有効であり、通常の操作が可能である。

Responses

Request samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Find realm by name.

Returns a single realm.

path Parameters
realm
required
string

Name of realm to return

Responses

Response samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Deletes a realm.

Delete a realm.

path Parameters
realm
required
string

Realm name to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

zone

API Gateway で外部に露出するDNS上のゾーン

Update an existing zone.

Update an existing zone by zone name.

path Parameters
realm
required
string

relam which zone belogs to

Request Body schema: application/json
required

Update an existent zone in the SPN

zone
required
string

ゾーンの名前。FQDN のサフィックスとして使用される。 文字列は小文字英字、数字、ハイフン、ピリオドのみを含むことができる。

title
required
string

ゾーンの日本語名称です。

description
string

ゾーンの説明文ですです。

realm
required
string

ゾーンが属するレルムの名前。

dnsProvider
string

ゾーンのDNSレコードを管理するためのDNSプロバイダのURN。

acmeCertificateProvider
string

ゾーンのSSL/TLS証明書を自動的に取得するためのACME証明書プロバイダのURL

Responses

Request samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Response samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Add a new zone to the SPN.

Add a new zone to the realm.

path Parameters
realm
required
string

relam which zone belogs to

Request Body schema: application/json
required

Create a new zone in the relam

zone
required
string

ゾーンの名前。FQDN のサフィックスとして使用される。 文字列は小文字英字、数字、ハイフン、ピリオドのみを含むことができる。

title
required
string

ゾーンの日本語名称です。

description
string

ゾーンの説明文ですです。

realm
required
string

ゾーンが属するレルムの名前。

dnsProvider
string

ゾーンのDNSレコードを管理するためのDNSプロバイダのURN。

acmeCertificateProvider
string

ゾーンのSSL/TLS証明書を自動的に取得するためのACME証明書プロバイダのURL

Responses

Request samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Response samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Finds Zones

get list of zones.

path Parameters
realm
required
string

relam which zone belogs to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find zone.

Returns a single zone.

path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

zone to return

Responses

Response samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Deletes a zone.

Delete a zone.

path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

zone to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

virtual-host

ゾーンに紐づく仮想ホスト。

Update an existing virtual host.

Update an existing virtual host by virtual host name.

path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which virtual host belogs to

Request Body schema: application/json
required

Update an existent virtual host in the SPN

name
required
string

仮想ホストの名前。所属するゾーンの名前と結合して FQDN を得ることができる。また、ピリオドを含めてサブドメイン化することもできる。 たとえば、 www.stg という仮想ホスト名でゾーンの名前が example.com の場合、FQDN は www.stg.example.com となる。

title
required
string
description
string
routingChain
required
string

この仮想ホストに紐づくルーティングチェーンのURN。 ルーティングチェーンは、リクエストの処理を行うためのルールの集合であり、リクエストを適切なマイクロサービスに転送するためのロジックを定義する。

certificate
Array of strings
key
string

この仮想ホストのサーバ証明書の秘密鍵。PEM形式の秘密鍵を指定する。 秘密鍵は、HTTPS通信を行うために必要であり、仮想ホストが提供するサービスのセキュリティを確保する。

disabled
boolean

仮想ホストが無効化されているかどうかを示すフラグ。 true の場合、仮想ホストは無効化されており、仮想ホストは削除され、アクセスは拒否される（TLSの場合、SSL_ERROR_HANDSHAKE_FAILURE を返し、平文の場合、400 Bad Request が返す）。 false の場合、仮想ホストは有効であり、アクセスが可能である。

Responses

Request samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

addVirtualHost

Add a new virtual host to the zone.

path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which virtual host belogs to

Request Body schema: application/json
required

Create a new virtual host in the zone

name
required
string

仮想ホストの名前。所属するゾーンの名前と結合して FQDN を得ることができる。また、ピリオドを含めてサブドメイン化することもできる。 たとえば、 www.stg という仮想ホスト名でゾーンの名前が example.com の場合、FQDN は www.stg.example.com となる。

title
required
string
description
string
routingChain
required
string

この仮想ホストに紐づくルーティングチェーンのURN。 ルーティングチェーンは、リクエストの処理を行うためのルールの集合であり、リクエストを適切なマイクロサービスに転送するためのロジックを定義する。

certificate
Array of strings
key
string

この仮想ホストのサーバ証明書の秘密鍵。PEM形式の秘密鍵を指定する。 秘密鍵は、HTTPS通信を行うために必要であり、仮想ホストが提供するサービスのセキュリティを確保する。

disabled
boolean

仮想ホストが無効化されているかどうかを示すフラグ。 true の場合、仮想ホストは無効化されており、仮想ホストは削除され、アクセスは拒否される（TLSの場合、SSL_ERROR_HANDSHAKE_FAILURE を返し、平文の場合、400 Bad Request が返す）。 false の場合、仮想ホストは有効であり、アクセスが可能である。

Responses

Request samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

listVirtualHosts

Finds Virtual Hosts

path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which virtual host belogs to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find virtual host by name.

Returns a single virtual host.

path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which virtual host belogs to

virtualHost
required
string

Name of virtual host to return

Responses

Response samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

Deletes a virtual host.

Delete a virtual host.

path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which virtual host belogs to

virtualHost
required
string

Virtual Host URN to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

routing-chain

API Gateway でのルーティングチェーン。

Update an existing routing chain.

Update an existing routing chain by routing chain name.

path Parameters
realm
required
string

relam which routing chain belogs to

Request Body schema: application/json
required

Update an existent routing chain in the Realm.

name
required
string

ルーティングチェーンの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

ルーティングチェーンの日本語名称です。

description
string

ルーティングチェーンの説明文です。

Array of objects

ルーティングチェーンのルールのリスト。各ルールは、リクエストを処理するための条件とアクションを定義する。 ルールは、リクエストのパスやヘッダなどを照合し、適切なアクションを実行するために使用される。

Responses

Request samples

Content type
application/json
{
  • "name": "cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "cms-chain",
  • "urn": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Add a new routing chain to the Realm.

Add a new routing chain to the realm.

path Parameters
realm
required
string

relam which routing chain belogs to

Request Body schema: application/json
required

Create a new routing chain in the realm.

name
required
string

ルーティングチェーンの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

ルーティングチェーンの日本語名称です。

description
string

ルーティングチェーンの説明文です。

Array of objects

ルーティングチェーンのルールのリスト。各ルールは、リクエストを処理するための条件とアクションを定義する。 ルールは、リクエストのパスやヘッダなどを照合し、適切なアクションを実行するために使用される。

Responses

Request samples

Content type
application/json
{
  • "name": "cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "cms-chain",
  • "urn": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Finds Routing Chains

get list of routing chains.

path Parameters
realm
any

rel

Find routing chain by name.

Returns a single routing chain.

path Parameters
realm
required
string

relam which routing chain belogs to

routingChainName
required
string

Name of routing chain to return

Responses

Response samples

Content type
application/json
{
  • "name": "cms-chain",
  • "urn": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Deletes a routing chain.

Delete a routing chain.

path Parameters
realm
required
string

relam which routing chain belogs to

routingChainName
required
string

Routing Chain URN to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

hub

SPNのハブ。

Update an existing hub.

Update an existing hub by hub name.

path Parameters
realm
required
string

relam which hub belogs to

Request Body schema: application/json
required

Update an existent hub in the SPN

name
required
string

SPN Hub の名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

realm
required
string

SPN Hub が属する realm の名前。URN の一部として使用される。

title
required
string

SPN Hub の日本語名称です。

description
string

SPN Hub の説明文です。

fqdn
required
string

SPN Hub のサーバのFQDN

serverPort
integer

SPN Hub のサーバのポート番号。デフォルトは 443

serverCert
required
string

mTLSにおけるサーバ証明書(PEM形式)の文字列。 SPN Hub のサーバは、この証明書を使用してクライアントとの通信を暗号化する。

serverCertKey
required
string

mTLSにおけるサーバ証明書の秘密鍵(PEM形式)の文字列。 SPN Hub のサーバは、この秘密鍵を使用してクライアントとの通信を暗号化する。

Responses

Request samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "example-realm",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----"
}

Response samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "example-realm",
  • "urn": "urn:chip-in:network:example-realm:hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----"
}

Add a new hub to the SPN.

Add a new hub to the realm.

path Parameters
realm
required
string

relam which hub belogs to

Request Body schema: application/json
required

Create a new hub in the realm

name
required
string

SPN Hub の名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

realm
required
string

SPN Hub が属する realm の名前。URN の一部として使用される。

title
required
string

SPN Hub の日本語名称です。

description
string

SPN Hub の説明文です。

fqdn
required
string

SPN Hub のサーバのFQDN

serverPort
integer

SPN Hub のサーバのポート番号。デフォルトは 443

serverCert
required
string

mTLSにおけるサーバ証明書(PEM形式)の文字列。 SPN Hub のサーバは、この証明書を使用してクライアントとの通信を暗号化する。

serverCertKey
required
string

mTLSにおけるサーバ証明書の秘密鍵(PEM形式)の文字列。 SPN Hub のサーバは、この秘密鍵を使用してクライアントとの通信を暗号化する。

Responses

Request samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "example-realm",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----"
}

Response samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "example-realm",
  • "urn": "urn:chip-in:network:example-realm:hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----"
}

Finds Hubs

get list of hubs.

path Parameters
realm
required
string

relam which hub belogs to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find hub by name.

Returns a single hub.

path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub to return

Responses

Response samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "example-realm",
  • "urn": "urn:chip-in:network:example-realm:hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----"
}

Deletes a hub.

Delete a hub.

path Parameters
hubName
required
string

Hub URN to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

service

SPN経由で提供されるマイクロサービス

Update an existing service.

Update an existing service by service Name.

path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub which service belogs to

Request Body schema: application/json
required

Update an existent service in the SPN

name
required
string

サービスの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

サービスの日本語名称です。URN の一部として使用される。 文字列は日本語を含むことができる。

description
string

サービスの説明文です。URN の一部として使用される。 文字列は日本語を含むことができる。

realm
required
string

サービスが属するレルムの名前。

hubName
required
string

サービスが接続される SPN Hub の名前。 SPN Hub は、サービスの提供を行うためのネットワークハブであり、サービスへのアクセスを管理する。

object

コンテナクラスタ内でマイクロサービスのスケジュール起動、オンデマンド起動を行うためのパラメータ

providers
required
Array of strings

当該サービスの提供が許可されるエンドポイント クライアント証明書の Subject の値と照合される

consumers
required
Array of strings

当該サービスの利用が許可されるエンドポイント クライアント証明書の Subject の値と照合される

Responses

Request samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "hubName": "hub1",
  • "availabilityManagement": {
    },
  • "providers": [
    ],
  • "consumers": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "urn": "urn:chip-in:service:example-realm:hub1:authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "hubName": "hub1",
  • "availabilityManagement": {
    },
  • "providers": [
    ],
  • "consumers": [
    ]
}

Add a new service to the SPN.

Add a new service to the realm.

path Parameters
realm
required
string

relam which service belogs to

Request Body schema: application/json
required

Create a new service in the realm

name
required
string

サービスの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

サービスの日本語名称です。URN の一部として使用される。 文字列は日本語を含むことができる。

description
string

サービスの説明文です。URN の一部として使用される。 文字列は日本語を含むことができる。

realm
required
string

サービスが属するレルムの名前。

hubName
required
string

サービスが接続される SPN Hub の名前。 SPN Hub は、サービスの提供を行うためのネットワークハブであり、サービスへのアクセスを管理する。

object

コンテナクラスタ内でマイクロサービスのスケジュール起動、オンデマンド起動を行うためのパラメータ

providers
required
Array of strings

当該サービスの提供が許可されるエンドポイント クライアント証明書の Subject の値と照合される

consumers
required
Array of strings

当該サービスの利用が許可されるエンドポイント クライアント証明書の Subject の値と照合される

Responses

Request samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "hubName": "hub1",
  • "availabilityManagement": {
    },
  • "providers": [
    ],
  • "consumers": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "urn": "urn:chip-in:service:example-realm:hub1:authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "hubName": "hub1",
  • "availabilityManagement": {
    },
  • "providers": [
    ],
  • "consumers": [
    ]
}

Finds Services

get list of services.

path Parameters
realm
required
string

relam which service belogs to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find service by urn.

Returns a single service.

path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub which service belogs to

serviceName
required
string

URN of service to return

Responses

Response samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "urn": "urn:chip-in:service:example-realm:hub1:authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "hubName": "hub1",
  • "availabilityManagement": {
    },
  • "providers": [
    ],
  • "consumers": [
    ]
}

Deletes a service.

Delete a service.

path Parameters
serviceName
required
string

Service URN to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}