API Gateway as a Service X テナント管理API (1.07)

Download OpenAPI specification:Download

Authentication

KeyStoneAuth

KeystoneTokenを設定

Security Scheme Type API Key
Header parameter name: X-Auth-Token

Info for a specific sdpfTenantId

Authorizations:
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
  • "partnerId": "string",
  • "partnerName": "string",
  • "customerName": "string",
  • "contractDate": "2020-01-01T12:00:00.000Z",
  • "axrossTenants":
    [
    ],
  • "axrossOptions":
    [
    ]
}

Create an axrossTenantId

Authorizations:
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

Request Body schema: application/json
partnerId
string

maximum 64 Characters

partnerName
string

maximum 64 Characters

customerName
string

maximum 64 Characters

axrossTenants
Array of objects
axrossOptions
Array of objects

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "partnerId": "string",
  • "partnerName": "string",
  • "customerName": "string",
  • "axrossTenants":
    [
    ],
  • "axrossOptions":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
  • "partnerId": "string",
  • "partnerName": "string",
  • "customerName": "string",
  • "axrossTenants":
    {
    },
  • "axrossOptions":
    {
    }
}

Delete all axrossTenantId in sdpfTenant

Authorizations:
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Info for a specific axrossTenantId

Authorizations:
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "axrossTenantId": "12ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
  • "axrossPlanId": "string",
  • "axrossPlan": "string",
  • "axrossTenantName": "string",
  • "cloud": "string",
  • "region": "string",
  • "subDomain": "string",
  • "contractDate": "2020-01-01T12:00:00.000Z",
  • "cancelDate": "2020-01-01T12:00:00.000Z",
  • "deployStatus": "string",
  • "deployDate": "2020-01-01T12:00:00.000Z",
  • "org": "string",
  • "billingStartDate": "2020-01-01T12:00:00.000Z",
  • "cidr": "string",
  • "axrossOptions":
    [
    ]
}

Update a specific of axrossTenantId

Authorizations:
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
axrossPlan
string
axrossTenantName
string

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

put/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "axrossPlan": "string",
  • "axrossTenantName": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
  • "axrossTenantId": "12ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "axrossPlan": "string",
  • "axrossTenantName": "string"
}

Delete a specific of axrossTenantId

Authorizations:
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Info for all Option