API Gateway as a Service X テナント管理API (1.07)
Download OpenAPI specification:Download
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
- 200
- 401
- 500
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": [
- {
- "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": [
- {
- "axrossOptionId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
- "optionId": "string",
- "optionContent": "string",
- "contractDate": "2020-01-01T12:00:00.000Z",
- "cancelDate": "2020-01-01T12:00:00.000Z",
- "deployDate": "2020-01-01T12:00:00.000Z",
- "billingStartDate": "2020-01-01T12:00:00.000Z",
- "optionDeployStatus": "string",
- "axrossOptionDeployId": "13ee5389-de3b-4f76-9ba7-13a4b584d384"
}
]
}
], - "axrossOptions": [
- {
- "axrossOptionId": "9aa309b4-cd14-41ed-bedb-952f90577f07",
- "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
- "optionId": "string",
- "contractDate": "2020-01-01T12:00:00.000Z"
}
]
}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
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "partnerId": "string",
- "partnerName": "string",
- "customerName": "string",
- "axrossTenants": [
- {
- "axrossPlan": "string",
- "axrossTenantName": "string",
- "cloud": "string",
- "region": "string",
- "subDomain": "string",
- "cidr": "string"
}
], - "axrossOptions": [
- {
- "optionId": "string"
}
]
}Response samples
- 201
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
- "partnerId": "string",
- "partnerName": "string",
- "customerName": "string",
- "axrossTenants": {
- "status": "succeeded",
- "axrossTenantIds": [
- "12ee5389-de3b-4f76-9ba7-13a4b584d384"
]
}, - "axrossOptions": {
- "status": "succeeded",
- "axrossOptionIds": [
- "9aa309b4-cd14-41ed-bedb-952f90577f07"
]
}
}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
- 400
- 401
- 404
- 500
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
- 200
- 401
- 500
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": [
- {
- "axrossOptionId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
- "optionId": "string",
- "optionContent": "string",
- "contractDate": "2020-01-01T12:00:00.000Z",
- "cancelDate": "2020-01-01T12:00:00.000Z",
- "deployDate": "2020-01-01T12:00:00.000Z",
- "billingStartDate": "2020-01-01T12:00:00.000Z",
- "optionDeployStatus": "string",
- "axrossOptionDeployId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
- "properties": {
- "cloud": "string",
- "gcpBackendProjectId": "string",
- "gcpBackendVpcId": "string",
- "gcpAxProjectId": "string",
- "gcpAxVpcId": "string",
- "awsBackendAccountId": "string",
- "awsBackendVpcId": "string",
- "awsBackendVpcCIDR": "string",
- "awsAxAccountId": "string",
- "awsAxVpcId": "string",
- "awsAxVpcCIDR": "string",
- "awsAsNumber": "string",
- "awsFicConnectionId": "string",
- "awsBackendSdpfTenantId": "string",
- "backendAddress": [
- "172.168.0.1",
- "172.168.0.2",
- "172.168.0.3"
], - "connections": [
- {
- "connectionKind": "string",
- "gcpPairingKey": "string",
- "azureServiceKey": "string",
- "connectStatus": "string"
}
]
}
}
]
}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
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "axrossPlan": "string",
- "axrossTenantName": "string"
}Response samples
- 200
- 400
- 401
- 404
- 500
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
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "errorCode": "E010001",
- "errorMessage": "string"
}