ICU API v1.0

The Internal Call Unit (ICU) API enables you to manage your OUTSCALE account and access keys.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

Base URLs:

https://icu.{region}.outscale.com
- Where {region} is:
  - ap-northeast-1
  - cloudgouv-eu-west-1
  - eu-west-2 (default)
  - us-east-2
  - us-west-1

Authentication Schemes

Access Key/Secret Key

The main way to authenticate your requests to this API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in Signature of API Requests.

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.

For example, if you use OSC CLI:

You need to create an ~/.osc/config.json file to specify your access key, secret key, and the Region of your account.

You then specify the --profile option when executing OSC CLI commands.

For more information, see Installing and Configuring OSC CLI.

See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see About Access Keys.

For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.

For example, if you use OSC CLI:

You need to create an ~/.osc/config.json file to specify the Region of your account, but you leave the access key value and secret key value empty ("").

You then specify the --profile, --authentication-method, --login, and --password options when executing OSC CLI commands.

See the code samples in each section of this documentation for specific examples in different programming languages.

No Authentication

A few API actions do not require any authentication. They are indicated as such in this documentation.

Other Security Mechanisms

In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see Managing Your API Accesses.

Access Keys

CreateAccessKey

POST /CreateAccessKey

Creates an access key for your account. The new key is automatically set to ACTIVE.

For more information, see About Access Keys.
This AWS-compliant method corresponds to CreateAccessKey in the OUTSCALE API.

OSC CLI Shell

Code samples

# Example with access key/secret key authentication

osc-cli icu CreateAccessKey --profile "default"

# Example with login/password authentication

osc-cli icu CreateAccessKey --profile "default" --authentication-method "password" --login "$OSC_EMAIL" --password "$OSC_PASSWORD"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

# Example with access key/secret key authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.CreateAccessKey' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AuthenticationMethod": "accesskey"
  }'

# Example with login/password authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --header 'x-amz-target: TinaIcuService.CreateAccessKey' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AuthenticationMethod": "password",
    "Login": "'$OSC_EMAIL'",
    "Password": "'$OSC_PASSWORD'"
  }'

Available Parameters

Name	Type	Required	Description
AuthenticationMethod	string	true	The method you choose for authentication (`accesskey` for authentication by access key and secret key, or `password` for authentication by login and password). When using OSC CLI, you do not need to specify the `accesskey` value as it is the default authentication method.
Login	string	false	The email address for your account. Required when using the login and password authentication method.
Password	string	false	The password for your account. Required when using the login and password authentication method.

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

POST /DeleteAccessKey

Deletes the specified access key of your account.

This AWS-compliant method corresponds to DeleteAccessKey in the OUTSCALE API.

OSC CLI Shell

Code samples

# Example with access key/secret key authentication

osc-cli icu DeleteAccessKey --profile "default" \
  --AccessKeyId "string"

# Example with login/password authentication

osc-cli icu DeleteAccessKey --profile "default" --authentication-method "password" --login "$OSC_EMAIL" --password "$OSC_PASSWORD" \
  --AccessKeyId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

# Example with access key/secret key authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.DeleteAccessKey' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AccessKeyId": "string",
    "AuthenticationMethod": "accesskey"
  }'

# Example with login/password authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --header 'x-amz-target: TinaIcuService.DeleteAccessKey' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AccessKeyId": "string",
    "AuthenticationMethod": "password",
    "Login": "'$OSC_EMAIL'",
    "Password": "'$OSC_PASSWORD'"
  }'

Available Parameters

Name	Type	Required	Description
AccessKeyId	string	true	The ID of the access key you want to delete.
AuthenticationMethod	string	true	The method you choose for authentication (`accesskey` for authentication by access key and secret key, or `password` for authentication by login and password). When using OSC CLI, you do not need to specify the `accesskey` value as it is the default authentication method.
Login	string	false	The email address for your account. Required when using the login and password authentication method.
Password	string	false	The password for your account. Required when using the login and password authentication method.

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	DeleteAccessKeyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

GetAccessKey

POST /GetAccessKey

Lists information about the specified access key of your account.

This AWS-compliant method corresponds to ReadSecretAccessKey in the OUTSCALE API.

OSC CLI Shell

Code samples

# Example with access key/secret key authentication

osc-cli icu GetAccessKey --profile "default" \
  --AccessKeyId "string"

# Example with login/password authentication

osc-cli icu GetAccessKey --profile "default" --authentication-method "password" --login "$OSC_EMAIL" --password "$OSC_PASSWORD" \
  --AccessKeyId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

# Example with access key/secret key authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.GetAccessKey' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AccessKeyId": "string",
    "AuthenticationMethod": "accesskey"
  }'

# Example with login/password authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --header 'x-amz-target: TinaIcuService.GetAccessKey' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AccessKeyId": "string",
    "AuthenticationMethod": "password",
    "Login": "'$OSC_EMAIL'",
    "Password": "'$OSC_PASSWORD'"
  }'

Available Parameters

Name	Type	Required	Description
AccessKeyId	string	true	The ID of the access key.
AuthenticationMethod	string	true	The method you choose for authentication (`accesskey` for authentication by access key and secret key, or `password` for authentication by login and password). When using OSC CLI, you do not need to specify the `accesskey` value as it is the default authentication method.
Login	string	false	The email address for your account. Required when using the login and password authentication method.
Password	string	false	The password for your account. Required when using the login and password authentication method.

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

POST /ListAccessKeys

Lists the access keys of your account.

This AWS-compliant method corresponds to ReadAccessKeys in the OUTSCALE API.

OSC CLI Shell

Code samples

# Example with access key/secret key authentication

osc-cli icu ListAccessKeys --profile "default" \
  --Marker "string" \
  --MaxItems 0

# Example with login/password authentication

osc-cli icu ListAccessKeys --profile "default" --authentication-method "password" --login "$OSC_EMAIL" --password "$OSC_PASSWORD" \
  --Marker "string" \
  --MaxItems 0

# You need Curl version 7.75 or later to use the --aws-sigv4 option

# Example with access key/secret key authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.ListAccessKeys' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AuthenticationMethod": "accesskey",
    "Marker": "string",
    "MaxItems": 0
  }'

# Example with login/password authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --header 'x-amz-target: TinaIcuService.ListAccessKeys' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AuthenticationMethod": "password",
    "Login": "'$OSC_EMAIL'",
    "Marker": "string",
    "MaxItems": 0,
    "Password": "'$OSC_PASSWORD'"
  }'

Available Parameters

Name	Type	Required	Description
AuthenticationMethod	string	true	The method you choose for authentication (`accesskey` for authentication by access key and secret key, or `password` for authentication by login and password). When using OSC CLI, you do not need to specify the `accesskey` value as it is the default authentication method.
Login	string	false	The email address for your account. Required when using the login and password authentication method.
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`).
Password	string	false	The password for your account. Required when using the login and password authentication method.

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

POST /UpdateAccessKey

Modifies the status of the specified access key of your account.

This AWS-compliant method corresponds to UpdateAccessKey in the OUTSCALE API.

OSC CLI Shell

Code samples

# Example with access key/secret key authentication

osc-cli icu UpdateAccessKey --profile "default" \
  --AccessKeyId "string" \
  --Status "string"

# Example with login/password authentication

osc-cli icu UpdateAccessKey --profile "default" --authentication-method "password" --login "$OSC_EMAIL" --password "$OSC_PASSWORD" \
  --AccessKeyId "string" \
  --Status "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

# Example with access key/secret key authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.UpdateAccessKey' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AccessKeyId": "string",
    "AuthenticationMethod": "accesskey",
    "Status": "string"
  }'

# Example with login/password authentication

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --header 'x-amz-target: TinaIcuService.UpdateAccessKey' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AccessKeyId": "string",
    "AuthenticationMethod": "password",
    "Login": "'$OSC_EMAIL'",
    "Password": "'$OSC_PASSWORD'",
    "Status": "string"
  }'

Available Parameters

Name	Type	Required	Description
AccessKeyId	string	true	The ID of the access key.
AuthenticationMethod	string	true	The method you choose for authentication (`accesskey` for authentication by access key and secret key, or `password` for authentication by login and password). When using OSC CLI, you do not need to specify the `accesskey` value as it is the default authentication method.
Login	string	false	The email address for your account. Required when using the login and password authentication method.
Password	string	false	The password for your account. Required when using the login and password authentication method.
Status	string	true	The new state for the access key (`ACTIVE` \| `INACTIVE`).

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	UpdateAccessKeyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

Accounts

AuthenticateAccount

POST /AuthenticateAccount

Authenticates an account using the provided login information.

This AWS-compliant method corresponds to CheckAuthentication in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu AuthenticateAccount --profile "default"

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --header 'x-amz-target: TinaIcuService.AuthenticateAccount' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
  }'

Available Parameters

Name	Type	Required	Description
Login	string	true	The email address or personal identifier (Pid) for the account.
Password	string	true	The password for the account.

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	AuthenticateAccountResponse

Example responses

200 Response

{
  "return": true
}

CreateAccount

POST /CreateAccount

Creates an OUTSCALE account.

[IMPORTANT]

You need OUTSCALE credentials and the appropriate quotas to create an 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"').

For more information, see About Your Account.
This AWS-compliant method corresponds to CreateAccount in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu CreateAccount --profile "default" \
  --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" \
  --PhoneNumber "string" \
  --Profile "string" \
  --State "string" \
  --VatNumber "string" \
  --ZipCode "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.CreateAccount' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "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",
    "PhoneNumber": "string",
    "Profile": "string",
    "State": "string",
    "VatNumber": "string",
    "ZipCode": "string"
  }'

Available Parameters

Name	Type	Required	Description
AccessKeys	[AccessKeys_1]	false	The access keys of your 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`).
Email	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.

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

POST /GetAccount

Gets information about the account that sent the request.

This AWS-compliant method corresponds to ReadAccounts in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu GetAccount --profile "default"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.GetAccount' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{}'

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

POST /ReadConsumptionAccount

Displays information about the consumption of your account for each billable resource within the specified time period.

This AWS-compliant method corresponds to ReadConsumptionAccount in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu ReadConsumptionAccount --profile "default" \
  --FromDate "string" \
  --ToDate "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.ReadConsumptionAccount' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "FromDate": "string",
    "ToDate": "string"
  }'

Available Parameters

Name	Type	Required	Description
FromDate	string	true	The beginning of the time period, in ISO 8601 format (for example, `2017-06-14`). This value is included in the time period.
ToDate	string	true	The end of the time period, in ISO 8601 format (for example, `2017-06-30`). This value is excluded from the time period, and must be set to a later date than `FromDate`.

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"
  }
}

UpdateAccount

POST /UpdateAccount

Updates the account information for the account that sends the request.

This AWS-compliant method corresponds to UpdateAccount in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu UpdateAccount --profile "default" \
  --City "string" \
  --CompanyName "string" \
  --Country "string" \
  --Email "string" \
  --FirstName "string" \
  --JobTitle "string" \
  --LastName "string" \
  --MobileNumber "string" \
  --PhoneNumber "string" \
  --State "string" \
  --VatNumber "string" \
  --ZipCode "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.UpdateAccount' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "City": "string",
    "CompanyName": "string",
    "Country": "string",
    "Email": "string",
    "FirstName": "string",
    "JobTitle": "string",
    "LastName": "string",
    "MobileNumber": "string",
    "PhoneNumber": "string",
    "State": "string",
    "VatNumber": "string",
    "ZipCode": "string"
  }'

Available Parameters

Name	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.
Email	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.

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	UpdateAccountResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

Catalogs

ReadCatalog

POST /ReadCatalog

Returns the price list of OUTSCALE services for the current Region.

This AWS-compliant method corresponds to ReadCatalog in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu ReadCatalog --profile "default"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.ReadCatalog' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{}'

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

POST /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 Subregions Reference.
This AWS-compliant method corresponds to ReadPublicCatalog in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu ReadPublicCatalog --profile "default"

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --header 'x-amz-target: TinaIcuService.ReadPublicCatalog' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{}'

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

POST /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.

For more information, see About Load Balancers.
This AWS-compliant method corresponds to CreateListenerRule in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu CreateListenerRule --profile "default" \
  --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",
    }'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.CreateListenerRule' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "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"
    }
  }'

Available Parameters

Name	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. This host-name pattern supports maximum three wildcards, and must not contain any special characters except [-.?].
» PathPattern	string	false	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	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	A unique identifier for the listener rule.
» RuleName	string	false	A human-readable name for the listener rule.

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

POST /DeleteListenerRule

Deletes a listener rule.
The previously active rule is disabled after deletion.

This AWS-compliant method corresponds to DeleteListenerRule in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu DeleteListenerRule --profile "default" \
  --RuleName "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.DeleteListenerRule' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "RuleName": "string"
  }'

Available Parameters

Name	Type	Required	Description
RuleName	string	true	The name of the rule you want to delete.

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	DeleteListenerRuleResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

DeregisterInstancesFromListenerRule

POST /DeregisterInstancesFromListenerRule

Removes the specified instances from the list of target backends on which the listener rule redirects traffic.

OSC CLI Shell

Code samples

osc-cli icu DeregisterInstancesFromListenerRule --profile "default" \
  --Instances '[
      {
        "InstanceId": "string",
      },
    ]' \
  --RuleName "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.DeregisterInstancesFromListenerRule' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "Instances": [
      {
        "InstanceId": "string"
      }
    ],
    "RuleName": "string"
  }'

Available Parameters

Name	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.

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	DeregisterInstancesFromListenerRuleResponse

Example responses

200 Response

{
  "Instances": [
    {
      "InstanceId": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ReadListenerRules

POST /ReadListenerRules

Describes one or more listener rules.
By default, this action returns the full list of listener rules for the account.

This AWS-compliant method corresponds to ReadListenerRules in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu ReadListenerRules --profile "default" \
  --RuleNames '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.ReadListenerRules' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "RuleNames": ["string"]
  }'

Available Parameters

Name	Type	Required	Description
RuleNames	[string]	false	The list of names of the rules to describe.

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

POST /RegisterInstancesWithListenerRule

Adds the specified instances to the list of target backends on which the listener rule redirects traffic.

OSC CLI Shell

Code samples

osc-cli icu RegisterInstancesWithListenerRule --profile "default" \
  --Instances '[
      {
        "InstanceId": "string",
      },
    ]' \
  --RuleName "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.RegisterInstancesWithListenerRule' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "Instances": [
      {
        "InstanceId": "string"
      }
    ],
    "RuleName": "string"
  }'

Available Parameters

Name	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.

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	RegisterInstancesWithListenerRuleResponse

Example responses

200 Response

{
  "Instances": [
    {
      "InstanceId": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UpdateListenerRule

POST /UpdateListenerRule

Updates the pattern of the listener rule.
This call updates the pattern matching algorithm for incoming traffic.

This AWS-compliant method corresponds to UpdateListenerRule in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu UpdateListenerRule --profile "default" \
  --Attribute "string" \
  --RuleName "string" \
  --Value "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.UpdateListenerRule' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "Attribute": "string",
    "RuleName": "string",
    "Value": "string"
  }'

Available Parameters

Name	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.

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	UpdateListenerRuleResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

Quotas

ReadQuotas

POST /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.

For more information, see About Your Account.
This AWS-compliant method corresponds to ReadQuotas in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli icu ReadQuotas --profile "default" \
  --Filters '[
      {
        "Name": "string",
        "Value": ["string"],
      },
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --QuotaNames '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: TinaIcuService.ReadQuotas' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "Filters": [
      {
        "Name": "string",
        "Value": ["string"]
      }
    ],
    "MaxResults": 0,
    "NextToken": "string",
    "QuotaNames": ["string"]
  }'

Available Parameters

Name	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.

Responses

Status	Meaning	Description	Schema
200	OK	The HTTP 200 response (OK).	ReadQuotasResponse

Example responses

200 Response

{
  "NextToken": "string",
  "ReferenceQuota": [
    {
      "Quotas": [
        {
          "Description": "string",
          "DisplayName": "string",
          "GroupName": "string",
          "MaxQuotaValue": 0,
          "Name": "string",
          "OwnerId": "string",
          "UsedQuotaValue": 0
        }
      ],
      "Reference": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Signatures

CheckSignature

POST /CheckSignature

Validates the authenticity of the signature used in a request.
3DS OUTSCALE automatically generates a unique signature for every request you send. This signature is generated using the SecretKey, Region, ServiceName, StringToSign and AmzDate parameters, and is unique for the access key and for the request.

OSC CLI Shell

Code samples

osc-cli icu CheckSignature --profile "default" \
  --AccessKeyId "string" \
  --AmzDate "string" \
  --Region "string" \
  --ServiceName "string" \
  --Signature "string" \
  --StringToSign "string"

curl -X POST https://icu.$OSC_REGION.outscale.com \
  --header 'x-amz-target: TinaIcuService.CheckSignature' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "AccessKeyId": "string",
    "AmzDate": "string",
    "Region": "string",
    "ServiceName": "string",
    "Signature": "string",
    "StringToSign": "string"
  }'

Available Parameters

Name	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 you sent the request.
ServiceName	string	true	The API service name for which you sent the request.
Signature	string	true	The signature to validate.
StringToSign	string	true	The string to sign, generated from the request body and headers.

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	Description
AccessKeyId	string	The ID of the access key.
SecretAccessKey	string	The secret access key that enables you to send requests.

Schema

{
  "AccessKeyId": "string",
  "SecretAccessKey": "string"
}

Account

Information about the account.

Properties

Name	Type	Description
AccountPid	string	The personal identifier (PID) of the account.
City	string	The city of the account owner.
CompanyName	string	The name of the company for the account.
Country	string	The country of the account owner.
CustomerId	string	The ID of the customer.
Email	string	The email address for the account.
FirstName	string	The first name of the account owner.
JobTitle	string	The job title of the account owner.
LastName	string	The last name of the account owner.
MobileNumber	string	The mobile phone number of the account owner.
PhoneNumber	string	The landline phone number of the account owner.
State	string	The state of the account owner.
VatNumber	string	The VAT number of the account.
ZipCode	string	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	Description
Key	string	The key of the catalog attribute.
Value	string	The value of the catalog attribute.

Schema

{
  "Key": "string",
  "Value": "string"
}

AuthenticateAccountResponse

Properties

Name	Type	Description
return	boolean	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	Description
Attributes	[Attributes]	One or more catalog attributes (for example, `currency`).
Entries	[Entries_0]	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	Description
ResponseMetadata	ResponseMetadata	Information about the response.
Return	boolean	If true, the signature is validated. Otherwise, you receive an error.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

CreateAccessKeyResponse

Properties

Name	Type	Description
ResponseMetadata	ResponseMetadata	Information about the response.
accessKey	accessKey	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	Description
Account	Account	Information about the account.
ResponseMetadata	ResponseMetadata	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	Description
ListenerRule	ListenerRule	The description of the listener rule.
ResponseMetadata	ResponseMetadata	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	Description
ResponseMetadata	ResponseMetadata	Information about the response.
Return	boolean	If true, the specified access key is deleted. Otherwise, you receive an error.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

DeleteListenerRuleResponse

Properties

Name	Type	Description
ResponseMetadata	ResponseMetadata	Information about the response.
Return	boolean	If true, the listener rule is deleted. Otherwise, you receive an error.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

DeregisterInstancesFromListenerRuleResponse

Properties

Name	Type	Description
Instances	[Instances]	The list of backend instances registered to this rule.
ResponseMetadata	ResponseMetadata	Information about the response.

Schema

{
  "Instances": [
    {
      "InstanceId": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Entries_0

One or more catalog entries.

Properties

Name	Type	Description
Attributes	Attributes	One or more catalog attributes (for example, `currency`).
Key	string	The identifier of the catalog entry.
Title	string	The description of the catalog entry.
Value	string	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	Description
Category	string	The category of resource (for example, `network`).
FromDate	string	The beginning of the time period.
Operation	string	The API call that triggered the resource consumption (for example, `RunInstances` or `CreateVolume`).
Service	string	The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, or `TinaOS-OSU`).
Title	string	A description of the consumed resource.
ToDate	string	The end of the time period.
Type	string	The type of resource, depending on the API call.
Value	number (double)	The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element.
Zone	string	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	Description
Name	string	The name of the filter.
Value	[string]	One or more filter values.

Schema

{
  "Name": "string",
  "Value": [
    "string"
  ]
}

GetAccessKeyResponse

Properties

Name	Type	Description
ResponseMetadata	ResponseMetadata	Information about the response.
accessKey	accessKey	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	Description
Account	Account	Information about the account.
ResponseMetadata	ResponseMetadata	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	Description
InstanceId	string	The ID of the backend instance.

Schema

{
  "InstanceId": "string"
}

ListAccessKeysResponse

Properties

Name	Type	Description
IsTruncated	boolean	If true, there are more items to return using the marker in a new request.
Marker	string	The marker to request the next results page.
ResponseMetadata	ResponseMetadata	Information about the response.
accessKeys	[accessKeys_0]	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	Description
LoadBalancerName	string	The name of the load balancer to which the listener is attached.
LoadBalancerPort	integer	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	Description
Instances	[Instances]	The list of backend instances to register to this rule.
ListenerId	integer	The ID of the listener.
ListenerRuleDescription	ListenerRuleDescription	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	Description
Action (result only)	string	The type of action for the rule (always `forward`).
HostPattern	string	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	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	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	A unique identifier for the listener rule.
RuleName	string	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	Description
ListenerRule	ListenerRule	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"
    }
  }
}

Quotas

One or more quotas associated with the account.

Properties

Name	Type	Description
Description	string	The description of the quota.
DisplayName	string	The display name of the quota.
GroupName	string	The group name the quota belongs to.
MaxQuotaValue	integer	The maximum value of the quota for the account (if there is no limit, `0`).
Name	string	The unique name of the quota.
OwnerId	string	The account ID of owner of the quota.
UsedQuotaValue	integer	The limit value currently used by the account.

Schema

{
  "Description": "string",
  "DisplayName": "string",
  "GroupName": "string",
  "MaxQuotaValue": 0,
  "Name": "string",
  "OwnerId": "string",
  "UsedQuotaValue": 0
}

ReadCatalogResponse

Properties

Name	Type	Description
Catalog	Catalog	Information about one or more catalogs of prices.
ResponseMetadata	ResponseMetadata	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	Description
Entries	[Entries_1]	Information about the resources consumed during the specified time period.
ResponseMetadata	ResponseMetadata	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	Description
ListenerRules	ListenerRules	The list of listener rules.
ResponseMetadata	ResponseMetadata	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	Description
Catalog	Catalog	Information about one or more catalogs of prices.
ResponseMetadata	ResponseMetadata	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	Description
NextToken	string	The token to request the next results page. If the value is `null`, there are no results left to be returned.
ReferenceQuota	[ReferenceQuota]	One or more reference quotas.
ResponseMetadata	ResponseMetadata	Information about the response.

Schema

{
  "NextToken": "string",
  "ReferenceQuota": [
    {
      "Quotas": [
        {
          "Description": "string",
          "DisplayName": "string",
          "GroupName": "string",
          "MaxQuotaValue": 0,
          "Name": "string",
          "OwnerId": "string",
          "UsedQuotaValue": 0
        }
      ],
      "Reference": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ReferenceQuota

One or more reference quotas.

Properties

Name	Type	Description
Quotas	[Quotas]	One or more quotas associated with the account.
Reference	string	The resource ID if it is a resource-specific quota, `global` if it is not.

Schema

{
  "Quotas": [
    {
      "Description": "string",
      "DisplayName": "string",
      "GroupName": "string",
      "MaxQuotaValue": 0,
      "Name": "string",
      "OwnerId": "string",
      "UsedQuotaValue": 0
    }
  ],
  "Reference": "string"
}

RegisterInstancesWithListenerRuleResponse

Properties

Name	Type	Description
Instances	[Instances]	The list of backend instances registered to this rule.
ResponseMetadata	ResponseMetadata	Information about the response.

Schema

{
  "Instances": [
    {
      "InstanceId": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ResponseMetadata

Information about the response.

Properties

Name	Type	Description
RequestId	string	The ID of the request.

Schema

{
  "RequestId": "string"
}

UpdateAccessKeyResponse

Properties

Name	Type	Description
ResponseMetadata	ResponseMetadata	Information about the response.
Return	boolean	If true, the specified access key is updated. Otherwise, an error is returned.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

UpdateAccountResponse

Properties

Name	Type	Description
ResponseMetadata	ResponseMetadata	Information about the response.
Return	boolean	If true, the account information is updated. Otherwise, you receive an error.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Return": true
}

UpdateListenerRuleResponse

Properties

Name	Type	Description
ResponseMetadata	ResponseMetadata	Information about the response.
Return	boolean	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	Description
accessKeyId	string	The ID of the access key.
createDate	string	The date and time of creation of the access key.
expirationDate	string	The expiration date of the access key.
ownerId	string	The account ID of the owner of the access key.
secretAccessKey	string	The secret access key that enables you to send requests.
status	string	The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not).
touchDate	string	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	Description
accessKeyId	string	The ID of the access key.
createDate	string	The date and time of creation of the access key.
expirationDate	string	The expiration date of the access key.
ownerId	string	The account ID of the owner of the access key.
secretAccessKey	string	The secret access key that enables you to send requests.
status	string	The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not).
touchDate	string	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"
}

ICU API v1.0

Authentication Schemes

Access Key/Secret Key

Login/Password

No Authentication

Other Security Mechanisms

Access Keys

CreateAccessKey

Available Parameters

Responses

DeleteAccessKey

Available Parameters

Responses

GetAccessKey

Available Parameters

Responses

ListAccessKeys

Available Parameters

Responses

UpdateAccessKey

Available Parameters

Responses

Accounts

AuthenticateAccount

Available Parameters

Responses

CreateAccount

Available Parameters

Responses

GetAccount

Responses

ReadConsumptionAccount

Available Parameters

Responses

UpdateAccount

Available Parameters

Responses

Catalogs

ReadCatalog

Responses

ReadPublicCatalog

Responses

ListenerRules

CreateListenerRule

Available Parameters

Responses

DeleteListenerRule

Available Parameters

Responses

DeregisterInstancesFromListenerRule

Available Parameters

Responses

ReadListenerRules

Available Parameters

Responses

RegisterInstancesWithListenerRule

Available Parameters

Responses

UpdateListenerRule

Available Parameters

Responses

Quotas

ReadQuotas

Available Parameters

Responses

Signatures

CheckSignature

Available Parameters

Responses

Schemas

AccessKeys_1

Properties

Account

Properties

Attributes

Properties

AuthenticateAccountResponse

Properties

Catalog

Properties