ListCname は、バケットにマッピングされているすべてのカスタムドメイン名 (CNAME) を照会します。 Agentic Bucket の場合、レスポンスには完全一致 CNAME エントリとワイルドカード CNAME エントリの両方が含まれる場合があり、IsWildCard 要素によってワイルドカード CNAME エントリが識別されます。
注意事項
レスポンスでは、以前のバージョンの OSS SDK との互換性を維持するために、完全一致 CNAME エントリには
IsWildCard要素が含まれません。ワイルドカード CNAME エントリには、true に設定されたIsWildCard要素が含まれ、そのDomainの値は*.プレフィックスのないベースドメイン名です。Agentic Bucket のレスポンスには、完全一致 CNAME とワイルドカード CNAME の両方のエントリが含まれる場合があります。標準バケットのレスポンス形式は変更されません。
リクエスト構文
GET /?cname HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Content-Type: application/xml
Content-Length: 186
Date: Thu, 17 Apr 2025 15:39:12 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=content-length,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218eリクエストヘッダー
この API は、共通リクエストヘッダーのみを使用します。詳細については、「共通 HTTP ヘッダー」をご参照ください。
レスポンスヘッダー
この API は、共通レスポンスヘッダーのみを返します。詳細については、「共通 HTTP ヘッダー」をご参照ください。
レスポンス要素
要素 | タイプ | 例 | 説明 |
ListCnameResult | コンテナー | N/A | CNAME の照会結果を格納するコンテナーです。 親ノード:なし 子ノード: Bucket、Owner、Cname |
Bucket | String | examplebucket | 照会対象のバケットの名前です。 親ノード: ListCnameResult 子ノード:なし |
Owner | String | testowner | バケット所有者の名前です。 親ノード: ListCnameResult 子ノード:なし |
Cname | コンテナー | N/A | CNAME 情報を格納するコンテナーです。 親ノード: ListCnameResult 子ノード: Domain、LastModified、Status、IsWildCard、Certificate |
Domain | String | example.com | カスタムドメイン名。 ワイルドカード CNAME エントリの場合、この値は 親ノード: Cname 子ノード:なし |
LastModified | String | 2021-09-15T02:35:07.000Z | カスタムドメイン名がマッピングされた時刻です。 親ノード: Cname 子ノード:なし |
Status | String | Enabled | ドメイン名の状態。有効な値:
親ノード: Cname 子ノード:なし |
IsWildCard | ブール値 | true | エントリがワイルドカード CNAME かどうかを示します。ワイルドカード CNAME エントリにのみこの要素が含まれ、その値は true です。完全一致 CNAME エントリにはこの要素は含まれません。これにより、レスポンスは以前のバージョンの OSS SDK との互換性が保たれます。 親ノード: Cname 子ノード:なし |
Certificate | コンテナー | N/A | 証明書情報を格納するコンテナーです。 親ノード: Cname 子ノード: Type、CertId、Status、CreationDate、Fingerprint、ValidStartDate、ValidEndDate |
Type | String | CAS | 証明書のソース。有効な値:
親ノード: Certificate 子ノード:なし |
CertId | String | 493****-cn-hangzhou | 証明書の ID です。 親ノード: Certificate 子ノード:なし |
Status | String | Enabled | 証明書のステータス。有効な値:
親ノード: Certificate 子ノード:なし |
CreationDate | String | Wed, 15 Sep 2021 02:35:06 GMT | 証明書が紐付けられた時刻です。 親ノード: Certificate 子ノード:なし |
Fingerprint | String | DE:01:CF:EC:7C:A7:98:CB:D8:6E:FB:1D:97:EB:A9:64:1D:4E:**:** | 証明書のフィンガープリントです。 親ノード: Certificate 子ノード:なし |
ValidStartDate | String | Wed, 12 Apr 2023 10:14:51 GMT | 証明書が有効になる時刻です。 親ノード: Certificate 子ノード:なし |
ValidEndDate | String | Mon, 4 May 2048 10:14:51 GMT | 証明書が失効する時刻です。 親ノード: Certificate 子ノード:なし |
例
リクエストの例
GET /?cname HTTP/1.1 Host: oss-example.oss-cn-hangzhou.aliyuncs.com Content-Type: application/xml Content-Length: 186 Date: Tues, 11 May 2022 11:39:12 GMT Authorization: OSS qn6q**************:77Dv****************レスポンスの例
標準バケットのレスポンス例
content-length: 1855 x-oss-console-auth: success server: AliyunOSS x-oss-server-time: 7 connection: keep-alive x-oss-request-id: 614169F1AE63BD37355CA12B date: Tues, 11 May 2022 11:39:12 GMT content-type: application/xml <?xml version="1.0" encoding="UTF-8"?> <ListCnameResult> <Bucket>targetbucket</Bucket> <Owner>testowner</Owner> <Cname> <Domain>example.com</Domain> <LastModified>2021-09-15T02:35:07.000Z</LastModified> <Status>Enabled</Status> <Certificate> <Type>CAS</Type> <CertId>493****-cn-hangzhou</CertId> <Status>Enabled</Status> <CreationDate>Wed, 15 Sep 2021 02:35:06 GMT</CreationDate> <Fingerprint>DE:01:CF:EC:7C:A7:98:CB:D8:6E:FB:1D:97:EB:A9:64:1D:4E:**:**</Fingerprint> <ValidStartDate>Wed, 12 Apr 2023 10:14:51 GMT</ValidStartDate> <ValidEndDate>Mon, 4 May 2048 10:14:51 GMT</ValidEndDate> </Certificate> </Cname> <Cname> <Domain>example.org</Domain> <LastModified>2021-09-15T02:34:58.000Z</LastModified> <Status>Enabled</Status> </Cname> </ListCnameResult>Agentic Bucket のレスポンス例 (完全一致 CNAME とワイルドカード CNAME の両方のエントリが含まれる場合があります)
content-length: 1024 x-oss-console-auth: success server: AliyunOSS x-oss-server-time: 7 connection: keep-alive x-oss-request-id: 614169F1AE63BD37355CA12C date: Tues, 11 May 2022 11:39:12 GMT content-type: application/xml <?xml version="1.0" encoding="UTF-8"?> <ListCnameResult> <Bucket>myab-$uid-$region-ab-apsr</Bucket> <Owner>1234567890123456</Owner> <Cname> <Domain>console.example.com</Domain> <LastModified>2025-04-17T02:35:07.000Z</LastModified> <Status>Enabled</Status> </Cname> <Cname> <Domain>example.com</Domain> <LastModified>2025-04-17T02:50:34.000Z</LastModified> <Status>Enabled</Status> <IsWildCard>true</IsWildCard> </Cname> </ListCnameResult>
OSS SDK
ListCname API をサポートする OSS SDK は次のとおりです:
ossutil
ListCname API に対応する ossutil コマンドの詳細については、「list-cname」をご参照ください。
エラーコード
エラーコード | HTTP ステータスコード | 説明 |
AccessDenied | 403 | あなたには ListCname 操作を呼び出す権限がありません。バケットの所有者と |
NoSuchCname | 404 | バケットにマッピングされている CNAME はありません。 |
MethodNotAllowed | 405 | 対象のバケットタイプでは CNAME 機能が有効になっていません。 |