ListCustomDomains API を使用したカスタムドメイン名のクエリ - FC - Alibaba Cloud -

カスタムドメイン名のリストを取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

fc:ListCustomDomains

get

*すべてのリソース。

*

なし

リクエスト構文

GET /2021-04-06/custom-domains HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
prefix	string	任意	返されるドメイン名のプレフィックス。	prefix_text
startKey	string	任意	クエリの開始ポイント。結果は、startKey 値とアルファベット順で同じかそれ以降の最初のドメイン名からアルファベット順で返されます。	next_service
nextToken	string	任意	結果の次のページのトークン。クエリ条件に一致するすべての結果が返されない場合、サーバーは nextToken 値を返します。この値を使用して残りの結果を取得できます。このパラメーターは、最初のクエリでは必須ではありません。	fc-thinkphp-demo.functioncompute.com
limit	integer	任意	返されるリソースの最大数。有効な値: 0～100。デフォルト値: 20。返される結果の数は、指定された値以下になります。	20
X-Fc-Account-Id	string	任意	Alibaba Cloud アカウントの ID。	188077086902****
X-Fc-Date	string	任意	API が呼び出される時間。フォーマットは EEE,d MMM yyyy HH:mm:ss GMT です。	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	任意	カスタムリクエスト ID。	asdf*****

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
nextToken	string	結果の次のページのトークン。クエリ条件に一致するすべての結果が返されない場合、サーバーは nextToken 値を返します。この値を使用して残りの結果を取得できます。このパラメーターは、最初のクエリでは必須ではありません。	example.com
customDomains	array<object>	クエリ条件に一致するドメイン名のリスト。
	object	ドメイン名情報のフォーマット。
domainName	string	ドメイン名。	example.com
accountId	string	Alibaba Cloud アカウントの ID。	1986114****4305
protocol	string	ドメイン名でサポートされるプロトコルの種類。 HTTP: HTTP のみがサポートされます。 HTTPS: HTTPS のみがサポートされます。 HTTP,HTTPS: HTTP と HTTPS の両方がサポートされます。	HTTP
apiVersion	string	API バージョン。	2016-08-15
createdTime	string	ドメイン名が作成された時間。フォーマットは協定世界時 (UTC) の YYYY-MM-DDTHH:mm:ssZ です。	2020-07-27T08:02:19Z
lastModifiedTime	string	ドメイン名が最後に変更された時間。フォーマットは協定世界時 (UTC) の YYYY-MM-DDTHH:mm:ssZ です。	2020-07-27T08:02:19Z
certConfig	CertConfig	HTTPS 証明書の構成。
tlsConfig	TLSConfig	TLS の構成。
routeConfig	RouteConfig	ドメイン名にアクセスする際のパスから関数へのマッピングを定義するルートテーブル。
wafConfig	WAFConfig	Web Application Firewall (WAF) の構成。

例

成功レスポンス

JSONJSON

{
  "nextToken": "example.com",
  "customDomains": [
    {
      "domainName": "example.com\t",
      "accountId": "1986114****4305\t",
      "protocol": "HTTP\t",
      "apiVersion": "2016-08-15\t",
      "createdTime": "2020-07-27T08:02:19Z",
      "lastModifiedTime": "2020-07-27T08:02:19Z",
      "certConfig": {
        "certName": "my-cert",
        "certificate": "-----BEGIN CERTIFICATE----- xxxxx -----END CERTIFICATE-----",
        "privateKey": "-----BEGIN RSA PRIVATE KEY----- xxxxx -----END RSA PRIVATE KEY-----"
      },
      "tlsConfig": {
        "minVersion": "TLSv1.2",
        "cipherSuites": [
          "TLS_RSA_WITH_RC4_128_SHA"
        ],
        "maxVersion": "TLSv1.3"
      },
      "routeConfig": {
        "routes": [
          {
            "functionName": "f1",
            "methods": [
              "GET"
            ],
            "path": "/login",
            "qualifier": "prod",
            "serviceName": "s1",
            "rewriteConfig": {
              "equalRules": [
                {
                  "match": "/old",
                  "replacement": "/new"
                }
              ],
              "wildcardRules": [
                {
                  "match": "/api/*",
                  "replacement": "/$1"
                }
              ],
              "regexRules": [
                {
                  "match": "^/js/(.*?)$",
                  "replacement": "/public/javascripts/$1"
                }
              ]
            }
          }
        ]
      },
      "wafConfig": {
        "enableWAF": true
      }
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。