向 SoftLayer API 认证

“username”(包含门户网站/API 用户名)和“apiKey”(包含 API 访问密钥)。如果未提供认证头,那么该 API 将返回 异常“找不到有
效认证头。”如果您提供了无效的 username 和 apiKey 组合,那么该 API 将返回异常“API 令牌无效”。

“authenticate”头的 SOAP 表示形式与以下内容类似:

<authenticate xsi:type="slt:authenticate" xmlns:slt="http://api.service.softlayer.com/soap/v3/SLTypes/">
    <username xsi:type="xsd:string">MY_USERNAME</username>
    <apiKey xsi:type="xsd:string">MY_API_ACCESS_KEY</apiKey>
</authenticate>

而它的 XML-RPC 副本与以下内容类似:

<struct>
    <member>
        <name>authenticate</name>
        <value>
            <struct>
                <member>
                    <name>username</name>
                    <value>
                        <string>MY_USERNAME</string>
                    </value>
                </member>
                <member>
                    <name>apiKey</name>
                    <value>
                        <string>MY_API_ACCESS_KEY</string>
                    </value>
                </member>
            </struct>
        </value>
    </member>
</struct>

生成 API 密钥

可使用两种方式来生成 API 访问密钥:通过门户网站或通过直接 API 调用。要在客户门户网站中生成您自己的 API 访问密钥:

  1. 使用客户帐户主用户的用户名和门户网站密码登录到 [https://manage.softlayer.com/ SoftLayer 客户门户网站]。
  2. 单击“管理”,然后单击“API 访问”链接。
  3. 选择您要为其生成密钥的用户,然后单击“生成 API 访问密钥”。

要通过 API 调用来生成 API 访问密钥,请调用 SoftLayer_User_Customer 服务中的 addApiAuthenticationKey方法。要移除用户的 API 访问密钥,请执行同一服务中 removeApiAuthenticationKey 方法。移除 API 访问密钥时,请保持谨慎。移除这些密钥将取消用户使用 SoftLayer API 的能力。

临时 API 密钥

使用与 SoftLayer_User_Customer::getPortalLoginToken 结合在一起的用户名/密码,有可能获得一个短期存在的 API 密钥。该令牌可在调用期间代替 API 密钥使用,并将在 48 小时后失效。

相关方法

另请参阅

另请参阅

  • [[SoftLayer_User_Customer_ApiAuthentication

外部链接