ICU API v1.0
The Internal Call Unit (ICU) API enables you to manage your OUTSCALE account and access keys.
Authentication: About Signatures of API Requests
Throttling: If you exceed the number of identical requests allowed for a configured time period, a RequestLimitExceeded
error message is returned.
Base URLs:
- https://icu.{region}.outscale.com
- region
- ap-northeast-1
- cloudgouv-eu-west-1
- cloudgouv-eu-west-2
- eu-west-2 (default)
- us-east-2
- us-west-1
- region
Terms of service Email: Support License: BSD 3 Clause
Authentication
- API Key (ApiKeyAuth)
- Parameter Name: Authorization, in: header. Signatures of API Requests based on the Hash-based Message Authentication Code (HMAC) protocol, more information.
Access Keys
CreateAccessKey
GET /CreateAccessKey
Creates a new secret access key and the corresponding access key ID for the account that sends the request.
The created access key is automatically set to ACTIVE
.
[NOTE]
To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.
Body parameter
{}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | CreateAccessKeyResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"accessKey": {
"accessKeyId": "string",
"createDate": "string",
"expirationDate": "string",
"ownerId": "string",
"secretAccessKey": "string",
"status": "string",
"touchDate": "string"
}
}
DeleteAccessKey
GET /DeleteAccessKey
Deletes the specified access key associated with the account that sends the request.
[NOTE]
To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
AccessKeyId | string | true | The ID of the access key you want to delete. |
Body parameter
{
"AccessKeyId": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | DeleteAccessKeyResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
GetAccessKey
GET /GetAccessKey
Gets information about the access key associated with the account that sends the request.
[NOTE]
To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
AccessKeyId | string | true | The ID of the access key. |
Body parameter
{
"AccessKeyId": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | GetAccessKeyResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"accessKey": {
"accessKeyId": "string",
"createDate": "string",
"expirationDate": "string",
"ownerId": "string",
"secretAccessKey": "string",
"status": "string",
"touchDate": "string"
}
}
ListAccessKeys
GET /ListAccessKeys
Lists the access keys associated with the account that sends the request.
[NOTE]
To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Marker | string | false | The marker to request the next results page. |
MaxItems | integer | false | The maximum number of items that can be returned in a single page (by default, 100 ). |
Body parameter
{
"Marker": "string",
"MaxItems": 0
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | ListAccessKeysResponse |
Example responses
200 Response
{
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
},
"accessKeys": [
{
"accessKeyId": "string",
"createDate": "string",
"expirationDate": "string",
"ownerId": "string",
"secretAccessKey": "string",
"status": "string",
"touchDate": "string"
}
]
}
UpdateAccessKey
GET /UpdateAccessKey
Modifies the status of the specified access key associated with the account that sends the request.
When set to ACTIVE
, the access key is enabled and can be used to send requests. When set to INACTIVE
, the access key is disabled.
[NOTE]
To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
AccessKeyId | string | true | The ID of the access key. |
Status | string | true | The new state for the access key (ACTIVE | INACTIVE ). |
Body parameter
{
"AccessKeyId": "string",
"Status": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | UpdateAccessKeyResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
Accounts
AuthenticateAccount
GET /AuthenticateAccount
Authenticates an account using the provided login information.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Login | string | true | The email address or personal identifier (Pid) for the account. |
Password | string | true | The password for the account. |
Body parameter
{
"Login": "string",
"Password": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | AuthenticateAccountResponse |
Example responses
200 Response
{
"return": true
}
CreateAccount
GET /CreateAccount
Creates a new OUTSCALE account.
[NOTE]
- You need OUTSCALE credentials and the appropriate quotas to create a new account via API. To get quotas, you can send an email to sales@outscale.com.
- If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example,
'"92000"'
).
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
AccessKeys | [AccessKeys_1] | false | The access keys for the account. |
» AccessKeyId | string | false | The ID of the access key. |
» SecretAccessKey | string | false | The secret access key that enables you to send requests. |
AccountPid | string | false | The PID of the account. |
City | string | true | The city of the account owner. |
CompanyName | string | true | The name of the company for the account. |
Country | string | true | The country of the account owner. |
CustomerId | string | false | The ID of the customer. It must be 8 digits (by default, 12345678 ). |
string | true | The email address for the account. | |
FirstName | string | true | The first name of the account owner. |
JobTitle | string | false | The job title of the account owner. |
LastName | string | true | The last name of the account owner. |
MobileNumber | string | false | The mobile phone number of the account owner. |
Password | string | true | The password for the account. |
PhoneNumber | string | false | The landline phone number of the account owner. |
Profile | string | false | The profile for the account you want to create (always default ). |
State | string | false | The state of the account. |
VatNumber | string | false | The value added tax (VAT) number for the account. |
ZipCode | string | true | The ZIP code of the city. |
Body parameter
{
"AccessKeys": [
{
"AccessKeyId": "string",
"SecretAccessKey": "string"
}
],
"AccountPid": "string",
"City": "string",
"CompanyName": "string",
"Country": "string",
"CustomerId": "string",
"Email": "string",
"FirstName": "string",
"JobTitle": "string",
"LastName": "string",
"MobileNumber": "string",
"Password": "string",
"PhoneNumber": "string",
"Profile": "string",
"State": "string",
"VatNumber": "string",
"ZipCode": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | CreateAccountResponse |
Example responses
200 Response
{
"Account": {
"AccountPid": "string",
"City": "string",
"CompanyName": "string",
"Country": "string",
"CustomerId": "string",
"Email": "string",
"FirstName": "string",
"JobTitle": "string",
"LastName": "string",
"MobileNumber": "string",
"PhoneNumber": "string",
"State": "string",
"VatNumber": "string",
"ZipCode": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
GetAccount
GET /GetAccount
Gets information about the account that sent the request.
Body parameter
{}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | GetAccountResponse |
Example responses
200 Response
{
"Account": {
"AccountPid": "string",
"City": "string",
"CompanyName": "string",
"Country": "string",
"CustomerId": "string",
"Email": "string",
"FirstName": "string",
"JobTitle": "string",
"LastName": "string",
"MobileNumber": "string",
"PhoneNumber": "string",
"State": "string",
"VatNumber": "string",
"ZipCode": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
ReadConsumptionAccount
GET /ReadConsumptionAccount
Displays information about the consumption of your account for each billable resource within the specified time period.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
FromDate | string | true | The beginning of the time period, in ISO 8601 format (for example, 2017-06-14 ). |
ToDate | string | true | The end of the time period, in ISO 8601 format (for example, 2017-06-30 ). |
Body parameter
{
"FromDate": "string",
"ToDate": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | ReadConsumptionAccountResponse |
Example responses
200 Response
{
"Entries": [
{
"Category": "string",
"FromDate": "string",
"Operation": "string",
"Service": "string",
"Title": "string",
"ToDate": "string",
"Type": "string",
"Value": 0,
"Zone": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
ResetAccountPassword
GET /ResetAccountPassword
Replaces the account password with the new one you provide.
You must also provide the token you received by email when asking for a password reset using the SendResetPasswordEmail method.
Password strength is tested through heuristic algorithms. For more information, see the zxcvbn GitHub.
[NOTE]
To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Password | string | true | The new password for the account. |
Token | string | true | The token you received at the email address provided for the account. |
Detailed descriptions
Password: The new password for the account.
The password can contain between 1 and 200 characters. Allowed characters are a-z, A-Z, 0-9, and !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~.
Body parameter
{
"Password": "string",
"Token": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | ResetAccountPasswordResponse |
Example responses
200 Response
{
"Email": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
SendResetPasswordEmail
GET /SendResetPasswordEmail
Sends an email to the email address provided for the account with a token to reset your password.
You need to provide this token when updating the account password using the ResetAccountPassword method.
[NOTE]
To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
string | true | The email address provided for the account. |
Body parameter
{
"Email": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | SendResetPasswordEmailResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
UpdateAccount
GET /UpdateAccount
Updates the account information for the account that sends the request.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
City | string | false | The new city of the account owner. |
CompanyName | string | false | The new name of the company for the account. |
Country | string | false | The new country of the account owner. |
string | false | The new email address for the account. | |
FirstName | string | false | The new first name of the account owner. |
JobTitle | string | false | The new job title of the account owner. |
LastName | string | false | The new last name of the account owner. |
MobileNumber | string | false | The new mobile phone number of the account owner. |
Password | string | false | The new password for the account. Password strength is tested through heuristic algorithms. For more information, see the zxcvbn GitHub. |
PhoneNumber | string | false | The new landline phone number of the account owner. |
State | string | false | The new state of the account owner. |
VatNumber | string | false | The new value added tax (VAT) number for the account. |
ZipCode | string | false | The new ZIP code of the city. |
Body parameter
{
"City": "string",
"CompanyName": "string",
"Country": "string",
"Email": "string",
"FirstName": "string",
"JobTitle": "string",
"LastName": "string",
"MobileNumber": "string",
"Password": "string",
"PhoneNumber": "string",
"State": "string",
"VatNumber": "string",
"ZipCode": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | UpdateAccountResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
Catalogs
ReadCatalog
GET /ReadCatalog
Returns the price list of OUTSCALE products and services for the current Region.
Body parameter
{}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | ReadCatalogResponse |
Example responses
200 Response
{
"Catalog": {
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Entries": [
{
"Attributes": {
"Key": "string",
"Value": "string"
},
"Key": "string",
"Title": "string",
"Value": "string"
}
]
},
"ResponseMetadata": {
"RequestId": "string"
}
}
ReadPublicCatalog
GET /ReadPublicCatalog
Returns the price list of OUTSCALE products and services for the Region specified in the endpoint of the request. For more information, see Regions, Endpoints and Availability Zones Reference.
Body parameter
{}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | ReadPublicCatalogResponse |
Example responses
200 Response
{
"Catalog": {
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Entries": [
{
"Attributes": {
"Key": "string",
"Value": "string"
},
"Key": "string",
"Title": "string",
"Value": "string"
}
]
},
"ResponseMetadata": {
"RequestId": "string"
}
}
ListenerRules
CreateListenerRule
GET /CreateListenerRule
Creates a rule for traffic redirection for the specified listener.
Each rule must have either the HostPattern
or PathPattern
parameter specified. Rules are treated in priority order, from the highest value to the lowest value.
Once the rule is created, you need to register backend instances with it. For more information, see the RegisterInstancesWithListenerRule method.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Instances | [Instances] | true | The list of backend instances to register to this rule. |
» InstanceId | string | true | The ID of the backend instance. |
ListenerDescription | ListenerDescription | true | The description of the listener. |
» LoadBalancerName | string | false | The name of the load balancer to which the listener is attached. |
» LoadBalancerPort | integer | false | The port of load balancer on which the listener is listening. |
ListenerRuleDescription | ListenerRuleDescription | true | The description of the listener rule. |
» Action (result only) | string | false | The type of action for the rule (always forward ). |
» HostPattern | string | false | A host-name pattern for the rule, with a maximum length of 128 characters. |
» PathPattern | string | false | A path pattern for the rule, with a maximum length of 128 characters. |
» Priority | integer | false | The priority level of the listener rule, between 1 and 19999 both included. |
» RuleId (result only) | integer | false | A unique identifier for the listener rule. |
» RuleName | string | false | A human-readable name for the listener rule. |
Detailed descriptions
» HostPattern: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except [-.?].
» PathPattern: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except [_-.$/~"'@:+?].
» Priority: The priority level of the listener rule, between 1
and 19999
both included.
Each rule must have a unique priority level. Otherwise, an error is returned.
Body parameter
{
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerDescription": {
"LoadBalancerName": "string",
"LoadBalancerPort": 0
},
"ListenerRuleDescription": {
"Action (result only)": "string",
"HostPattern": "string",
"PathPattern": "string",
"Priority": 0,
"RuleId (result only)": 0,
"RuleName": "string"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | CreateListenerRuleResponse |
Example responses
200 Response
{
"ListenerRule": {
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerId": 0,
"ListenerRuleDescription": {
"Action (result only)": "string",
"HostPattern": "string",
"PathPattern": "string",
"Priority": 0,
"RuleId (result only)": 0,
"RuleName": "string"
}
},
"ResponseMetadata": {
"RequestId": "string"
}
}
DeleteListenerRule
GET /DeleteListenerRule
Deletes a listener rule.
The previously active rule is disabled after deletion.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
RuleName | string | true | The name of the rule you want to delete. |
Body parameter
{
"RuleName": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | DeleteListenerRuleResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
DeregisterInstancesFromListenerRule
GET /DeregisterInstancesFromListenerRule
Removes the specified instances from the list of target backends on which the listener rule redirects traffic.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Instances | [Instances] | true | The list of backend instances to deregister from this rule. |
» InstanceId | string | true | The ID of the backend instance. |
RuleName | string | true | The name of the listener rule. |
Body parameter
{
"Instances": [
{
"InstanceId": "string"
}
],
"RuleName": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | DeregisterInstancesFromListenerRuleResponse |
Example responses
200 Response
{
"Instances": [
{
"InstanceId": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
ReadListenerRules
GET /ReadListenerRules
Describes one or more listener rules.
By default, this action returns the full list of listener rules for the account.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
RuleNames | [string] | false | The list of names of the rules to describe. |
Body parameter
{
"RuleNames": [
"string"
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | ReadListenerRulesResponse |
Example responses
200 Response
{
"ListenerRules": {
"ListenerRule": {
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerId": 0,
"ListenerRuleDescription": {
"Action (result only)": "string",
"HostPattern": "string",
"PathPattern": "string",
"Priority": 0,
"RuleId (result only)": 0,
"RuleName": "string"
}
}
},
"ResponseMetadata": {
"RequestId": "string"
}
}
RegisterInstancesWithListenerRule
GET /RegisterInstancesWithListenerRule
Adds the specified instances to the list of target backends on which the listener rule redirects traffic.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Instances | [Instances] | true | The list of backend instances to register to this rule. |
» InstanceId | string | true | The ID of the backend instance. |
RuleName | string | true | The name of the listener rule. |
Body parameter
{
"Instances": [
{
"InstanceId": "string"
}
],
"RuleName": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | RegisterInstancesWithListenerRuleResponse |
Example responses
200 Response
{
"Instances": [
{
"InstanceId": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
UpdateListenerRule
GET /UpdateListenerRule
Updates the pattern of the listener rule.
This call updates the pattern matching algorithm for incoming traffic.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Attribute | string | true | The attribute of rule that needs to be modified (HostPattern | PathPattern ). |
RuleName | string | true | The name of the listener rule. |
Value | string | true | The new value for the attribute. |
Body parameter
{
"Attribute": "string",
"RuleName": "string",
"Value": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | UpdateListenerRuleResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
Quotas
ReadQuotas
GET /ReadQuotas
Describes one or more of your quotas.
You can use the QuotaName.N
parameter to filter the name of one or more quotas.
You can also use the Filter.N
parameter to filter the described quotas on the following properties:
reference
: The reference of the quota.quota.display-name
: The display name of the quota.quota.group-name
: The group name of the quota.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Filters | [Filters] | false | One or more filters. |
» Name | string | false | The name of the filter. |
» Value | [string] | false | One or more filter values. |
MaxResults | integer | false | The maximum number of items that can be returned in a single page (by default, 100 ). |
NextToken | string | false | The token to request the next results page. |
QuotaNames | [string] | false | One or more names of quotas. |
Body parameter
{
"Filters": [
{
"Name": "string",
"Value": [
"string"
]
}
],
"MaxResults": 0,
"NextToken": "string",
"QuotaNames": [
"string"
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | ReadQuotasResponse |
Example responses
200 Response
{
"NextToken": "string",
"ReferenceQuotaSet": [
{
"QuotaSet": [
{
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"MaxQuotaValue": 0,
"Name": "string",
"OwnerId": "string",
"UsedQuotaValue": 0
}
],
"Reference": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
Signatures
CheckSignature
GET /CheckSignature
Validates the authenticity of the signature used in a request.
3DS OUTSCALE automatically generates a unique signature for every request sent by users. This signature is generated using the SecretKey
, Region
, ServiceName
, StringToSign
and AmzDate
parameters, and is unique for the user's access key and for the request.
[NOTE]
To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
AccessKeyId | string | true | The ID of the access key used in the request, corresponding to the secret key used to generate the signature. |
AmzDate | string | true | The date of the request, in ISO 8601 format (for example, 20170630 ). |
Region | string | true | The Region to which the user sent the request. |
ServiceName | string | true | The API service name for which the user sent the request. |
Signature | string | true | The signature to validate. |
StringToSign | string | true | The string to sign, generated from the request body and headers. |
Body parameter
{
"AccessKeyId": "string",
"AmzDate": "string",
"Region": "string",
"ServiceName": "string",
"Signature": "string",
"StringToSign": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | CheckSignatureResponse |
Example responses
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
Schemas
AccessKeys_1
The access keys for the account.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
AccessKeyId | string | false | none | The ID of the access key. |
SecretAccessKey | string | false | none | The secret access key that enables you to send requests. |
Schema
{
"AccessKeyId": "string",
"SecretAccessKey": "string"
}
Account
Information about the account.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
AccountPid | string | false | none | The personal identifier (PID) of the account. |
City | string | false | none | The city of the account owner. |
CompanyName | string | false | none | The name of the company for the account. |
Country | string | false | none | The country of the account owner. |
CustomerId | string | false | none | The ID of the customer. |
string | false | none | The email address for the account. | |
FirstName | string | false | none | The first name of the account owner. |
JobTitle | string | false | none | The job title of the account owner. |
LastName | string | false | none | The last name of the account owner. |
MobileNumber | string | false | none | The mobile phone number of the account owner. |
PhoneNumber | string | false | none | The landline phone number of the account owner. |
State | string | false | none | The state of the account owner. |
VatNumber | string | false | none | The VAT number of the account. |
ZipCode | string | false | none | The ZIP code of the city. |
Schema
{
"AccountPid": "string",
"City": "string",
"CompanyName": "string",
"Country": "string",
"CustomerId": "string",
"Email": "string",
"FirstName": "string",
"JobTitle": "string",
"LastName": "string",
"MobileNumber": "string",
"PhoneNumber": "string",
"State": "string",
"VatNumber": "string",
"ZipCode": "string"
}
Attributes
One or more catalog attributes (for example, currency
).
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Key | string | false | none | The key of the catalog attribute. |
Value | string | false | none | The value of the catalog attribute. |
Schema
{
"Key": "string",
"Value": "string"
}
AuthenticateAccountResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
return | boolean | false | none | If true, the login information is validated. Otherwise, you receive an error. |
Schema
{
"return": true
}
Catalog
Information about one or more catalogs of prices.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Attributes | [Attributes] | false | none | One or more catalog attributes (for example, currency ). |
Entries | [Entries_0] | false | none | One or more catalog entries. |
Schema
{
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Entries": [
{
"Attributes": {
"Key": "string",
"Value": "string"
},
"Key": "string",
"Title": "string",
"Value": "string"
}
]
}
CheckSignatureResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Return | boolean | false | none | If true, the signature is validated. Otherwise, you receive an error. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
CreateAccessKeyResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
accessKey | accessKey | false | none | Information about an access key. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"accessKey": {
"accessKeyId": "string",
"createDate": "string",
"expirationDate": "string",
"ownerId": "string",
"secretAccessKey": "string",
"status": "string",
"touchDate": "string"
}
}
CreateAccountResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Account | Account | false | none | Information about the account. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"Account": {
"AccountPid": "string",
"City": "string",
"CompanyName": "string",
"Country": "string",
"CustomerId": "string",
"Email": "string",
"FirstName": "string",
"JobTitle": "string",
"LastName": "string",
"MobileNumber": "string",
"PhoneNumber": "string",
"State": "string",
"VatNumber": "string",
"ZipCode": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
CreateListenerRuleResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ListenerRule | ListenerRule | false | none | The description of the listener rule. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"ListenerRule": {
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerId": 0,
"ListenerRuleDescription": {
"Action (result only)": "string",
"HostPattern": "string",
"PathPattern": "string",
"Priority": 0,
"RuleId (result only)": 0,
"RuleName": "string"
}
},
"ResponseMetadata": {
"RequestId": "string"
}
}
DeleteAccessKeyResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Return | boolean | false | none | If true, the specified access key is deleted. Otherwise, you receive an error. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
DeleteListenerRuleResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Return | boolean | false | none | If true, the listener rule is deleted. Otherwise, you receive an error. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
DeregisterInstancesFromListenerRuleResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Instances | [Instances] | false | none | The list of backend instances registered to this rule. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"Instances": [
{
"InstanceId": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
Entries_0
One or more catalog entries.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Attributes | Attributes | false | none | One or more catalog attributes (for example, currency ). |
Key | string | false | none | The identifier of the catalog entry. |
Title | string | false | none | The description of the catalog entry. |
Value | string | false | none | The price of the catalog entry. |
Schema
{
"Attributes": {
"Key": "string",
"Value": "string"
},
"Key": "string",
"Title": "string",
"Value": "string"
}
Entries_1
Information about the resources consumed during the specified time period.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Category | string | false | none | The category of resource (for example, network ). |
FromDate | string | false | none | The beginning of the time period. |
Operation | string | false | none | The API call that triggered the resource consumption (for example, RunInstances or CreateVolume ). |
Service | string | false | none | The service of the API call (TinaOS-FCU , TinaOS-LBU , TinaOS-DirectLink, TinaOS-OOS, or TinaOS-OSU`). |
Title | string | false | none | A description of the consumed resource. |
ToDate | string | false | none | The end of the time period. |
Type | string | false | none | The type of resource, depending on the API call. |
Value | number(double) | false | none | The consumed amount for the resource. The unit depends on the resource type. For more information, see the Title element. |
Zone | string | false | none | The Availability Zone (AZ) in which the resources were consumed. For cross-AZs resources, this may also be the Region name. |
Schema
{
"Category": "string",
"FromDate": "string",
"Operation": "string",
"Service": "string",
"Title": "string",
"ToDate": "string",
"Type": "string",
"Value": 0,
"Zone": "string"
}
Filters
One or more filters.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Name | string | false | none | The name of the filter. |
Value | [string] | false | none | One or more filter values. |
Schema
{
"Name": "string",
"Value": [
"string"
]
}
GetAccessKeyResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
accessKey | accessKey | false | none | Information about an access key. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"accessKey": {
"accessKeyId": "string",
"createDate": "string",
"expirationDate": "string",
"ownerId": "string",
"secretAccessKey": "string",
"status": "string",
"touchDate": "string"
}
}
GetAccountResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Account | Account | false | none | Information about the account. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"Account": {
"AccountPid": "string",
"City": "string",
"CompanyName": "string",
"Country": "string",
"CustomerId": "string",
"Email": "string",
"FirstName": "string",
"JobTitle": "string",
"LastName": "string",
"MobileNumber": "string",
"PhoneNumber": "string",
"State": "string",
"VatNumber": "string",
"ZipCode": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
Instances
The list of backend instances to register to this rule.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
InstanceId | string | true | none | The ID of the backend instance. |
Schema
{
"InstanceId": "string"
}
ListAccessKeysResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
IsTruncated | boolean | false | none | If true, there are more items to return using the marker in a new request. |
Marker | string | false | none | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
accessKeys | [accessKeys_0] | false | none | A list of access keys. |
Schema
{
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
},
"accessKeys": [
{
"accessKeyId": "string",
"createDate": "string",
"expirationDate": "string",
"ownerId": "string",
"secretAccessKey": "string",
"status": "string",
"touchDate": "string"
}
]
}
ListenerDescription
The description of the listener.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
LoadBalancerName | string | false | none | The name of the load balancer to which the listener is attached. |
LoadBalancerPort | integer | false | none | The port of load balancer on which the listener is listening. |
Schema
{
"LoadBalancerName": "string",
"LoadBalancerPort": 0
}
ListenerRule
The description of the listener rule.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Instances | [Instances] | false | none | The list of backend instances to register to this rule. |
ListenerId | integer | false | none | The ID of the listener. |
ListenerRuleDescription | ListenerRuleDescription | false | none | The description of the listener rule. |
Schema
{
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerId": 0,
"ListenerRuleDescription": {
"Action (result only)": "string",
"HostPattern": "string",
"PathPattern": "string",
"Priority": 0,
"RuleId (result only)": 0,
"RuleName": "string"
}
}
ListenerRuleDescription
The description of the listener rule.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Action (result only) | string | false | none | The type of action for the rule (always forward ). |
HostPattern | string | false | none | A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except [-.?]. |
PathPattern | string | false | none | A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except [_-.$/~"'@:+?]. |
Priority | integer | false | none | The priority level of the listener rule, between 1 and 19999 both included.Each rule must have a unique priority level. Otherwise, an error is returned. |
RuleId (result only) | integer | false | none | A unique identifier for the listener rule. |
RuleName | string | false | none | A human-readable name for the listener rule. |
Schema
{
"Action (result only)": "string",
"HostPattern": "string",
"PathPattern": "string",
"Priority": 0,
"RuleId (result only)": 0,
"RuleName": "string"
}
ListenerRules
The list of listener rules.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ListenerRule | ListenerRule | false | none | The description of the listener rule. |
Schema
{
"ListenerRule": {
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerId": 0,
"ListenerRuleDescription": {
"Action (result only)": "string",
"HostPattern": "string",
"PathPattern": "string",
"Priority": 0,
"RuleId (result only)": 0,
"RuleName": "string"
}
}
}
QuotaSet
One or more quotas associated with the user.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Description | string | false | none | The description of the quota. |
DisplayName | string | false | none | The display name of the quota. |
GroupName | string | false | none | The group name the quota belongs to. |
MaxQuotaValue | integer | false | none | The maximum value of the quota for the OUTSCALE user account (if there is no limit, 0 ). |
Name | string | false | none | The unique name of the quota. |
OwnerId | string | false | none | The account ID of owner of the quota. |
UsedQuotaValue | integer | false | none | The limit value currently used by the OUTSCALE user account. |
Schema
{
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"MaxQuotaValue": 0,
"Name": "string",
"OwnerId": "string",
"UsedQuotaValue": 0
}
ReadCatalogResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Catalog | Catalog | false | none | Information about one or more catalogs of prices. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"Catalog": {
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Entries": [
{
"Attributes": {
"Key": "string",
"Value": "string"
},
"Key": "string",
"Title": "string",
"Value": "string"
}
]
},
"ResponseMetadata": {
"RequestId": "string"
}
}
ReadConsumptionAccountResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Entries | [Entries_1] | false | none | Information about the resources consumed during the specified time period. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"Entries": [
{
"Category": "string",
"FromDate": "string",
"Operation": "string",
"Service": "string",
"Title": "string",
"ToDate": "string",
"Type": "string",
"Value": 0,
"Zone": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
ReadListenerRulesResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ListenerRules | ListenerRules | false | none | The list of listener rules. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"ListenerRules": {
"ListenerRule": {
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerId": 0,
"ListenerRuleDescription": {
"Action (result only)": "string",
"HostPattern": "string",
"PathPattern": "string",
"Priority": 0,
"RuleId (result only)": 0,
"RuleName": "string"
}
}
},
"ResponseMetadata": {
"RequestId": "string"
}
}
ReadPublicCatalogResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Catalog | Catalog | false | none | Information about one or more catalogs of prices. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"Catalog": {
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Entries": [
{
"Attributes": {
"Key": "string",
"Value": "string"
},
"Key": "string",
"Title": "string",
"Value": "string"
}
]
},
"ResponseMetadata": {
"RequestId": "string"
}
}
ReadQuotasResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
NextToken | string | false | none | The token to request the next results page. If the value is null , there are no results left to be returned. |
ReferenceQuotaSet | [ReferenceQuotaSet] | false | none | One or more reference quotas. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"NextToken": "string",
"ReferenceQuotaSet": [
{
"QuotaSet": [
{
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"MaxQuotaValue": 0,
"Name": "string",
"OwnerId": "string",
"UsedQuotaValue": 0
}
],
"Reference": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
ReferenceQuotaSet
One or more reference quotas.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
QuotaSet | [QuotaSet] | false | none | One or more quotas associated with the user. |
Reference | string | false | none | The resource ID if it is a resource-specific quota, global if it is not. |
Schema
{
"QuotaSet": [
{
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"MaxQuotaValue": 0,
"Name": "string",
"OwnerId": "string",
"UsedQuotaValue": 0
}
],
"Reference": "string"
}
RegisterInstancesWithListenerRuleResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
Instances | [Instances] | false | none | The list of backend instances registered to this rule. |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"Instances": [
{
"InstanceId": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
ResetAccountPasswordResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
string | false | none | The email address of the account. | |
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Schema
{
"Email": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
ResponseMetadata
Information about the response.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
RequestId | string | false | none | The ID of the request. |
Schema
{
"RequestId": "string"
}
SendResetPasswordEmailResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Return | boolean | false | none | If true, the email has been sent. Otherwise, you receive an error. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
UpdateAccessKeyResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Return | boolean | false | none | If true, the specified access key is updated. Otherwise, an error is returned. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
UpdateAccountResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Return | boolean | false | none | If true, the account information is updated. Otherwise, you receive an error. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
UpdateListenerRuleResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ResponseMetadata | ResponseMetadata | false | none | Information about the response. |
Return | boolean | false | none | If true, the specified listener rule is updated. Otherwise, you receive an error. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"Return": true
}
accessKey
Information about an access key.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accessKeyId | string | false | none | The ID of the access key. |
createDate | string | false | none | The date and time of creation of the access key. |
expirationDate | string | false | none | The expiration date of the access key. |
ownerId | string | false | none | The account ID of the owner of the access key. |
secretAccessKey | string | false | none | The secret access key that enables you to send requests. |
status | string | false | none | The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not). |
touchDate | string | false | none | The date and time of the last modification of the access key. |
Schema
{
"accessKeyId": "string",
"createDate": "string",
"expirationDate": "string",
"ownerId": "string",
"secretAccessKey": "string",
"status": "string",
"touchDate": "string"
}
accessKeys_0
A list of access keys.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accessKeyId | string | false | none | The ID of the access key. |
createDate | string | false | none | The date and time of creation of the access key. |
expirationDate | string | false | none | The expiration date of the access key. |
ownerId | string | false | none | The account ID of the owner of the access key. |
secretAccessKey | string | false | none | The secret access key that enables you to send requests. |
status | string | false | none | The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not). |
touchDate | string | false | none | The date and time of the last modification of the access key. |
Schema
{
"accessKeyId": "string",
"createDate": "string",
"expirationDate": "string",
"ownerId": "string",
"secretAccessKey": "string",
"status": "string",
"touchDate": "string"
}
Copyright ©2020 Outscale SAS. All rights reserved